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: Disable.
  • 1: Enable.

width

Width in pixels. Specified for:

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

Acceptable values: an integer from 1 to 2147483647.

height

Height in pixels. Specified for:

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

Acceptable values: an integer from 1 to 2147483647.

Response format

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

Response parameters

code

Request processing status. If the value is 0, the request was completed successfully. 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: Disable.
  • 1: Enable.

Width in pixels. Specified for:

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

Acceptable values: an integer from 1 to 2147483647.

Height in pixels. Specified for:

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

Acceptable values: an integer from 1 to 2147483647.

Required parameter.

Previous
template
Next
updateDefaultBanner