modify

Edit a banner type.

Request format

https://adfox.yandex.com/api/v1
  ? object=bannerType
  & action=modify
  & objectID=<integer>
  & [name=<string>]
  & [isOn=<integer>]
  & [width=<string>]
  & [height=<string>]

objectID*

ID of the object that the action is performed on.

name

Object name. An entry can contain Russian and Latin letters, numbers, and any special characters.

isOn

Enable/disable the object.

Acceptable values:

  • 0: Disabled. Not available for creating banners.
  • 1: Enabled.

width

Width in pixels. Specified for:

  • The Standard banner type.
  • The Nondimensional banner type for system templates.

Integer values from 1 to 2,147,483,647.

height

Height in pixels. Specified for:

  • The Standard banner type.
  • The Nondimensional banner type for system templates.

Integer values from 1 to 2,147,483,647.

* Required

Response format

<response>
<status>
  <code>{integer}</code>
</status>
</response>

Response parameters

code

Request processing status. For the key, see Error handling.

Sample request and response

Request:

https://adfox.yandex.com/api/v1?object=bannerType&action=modify&objectID=543&name=240х400

Response:

<response>
<status>
  <code>0</code>
</status>
</response>

Other actions with the object

See more actions with the bannerType object:

ID of the object that the action is performed on.

Object name. An entry can contain Russian and Latin letters, numbers, and any special characters.

Enable/disable the object.

Acceptable values:

  • 0: Disabled. Not available for creating banners.

  • 1: Enabled.

Width in pixels. Specified for:

  • The Standard banner type.

  • The Nondimensional banner type for system templates.

Integer values from 1 to 2,147,483,647.

Height in pixels. Specified for:

  • The Standard banner type.

  • The Nondimensional banner type for system templates.

Integer values from 1 to 2,147,483,647.

Required

Previous
template
Next
updateDefaultBanner