placement

Configure banner placement.

Request format

https://adfox.yandex.com/api/v1
  ? object=banner
  & action=modify
  & actionObject=placement
  & objectID=<integer>
  & type=<string>
  & [_siteID=<string>]
  & [_sectionID=<string>]
  & [_placeID=<string>]

objectID*

ID of the object that the action is performed on.

type*

Acceptable value: websites.

_siteID

Replace the ID in the parameter name with the site ID. For example: _site676.

Acceptable values:

  • on: Enable placement.
  • off: Disable placement.

_sectionID

Replace the ID in the parameter name with the site section ID. For example: _section676.

Acceptable values:

  • on: Enable placement.
  • off: Disable placement.

_placeID

Replace the ID in the parameter name with the placement ID. For example: _place676.

Acceptable values:

  • on: Enable placement.
  • off: Disable placement.

* 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=banner&action=modify&actionObject=placement&objectID=345234&type=websites&_site123456=on

Response:

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

Other actions with the object

See more actions with the banner object:

Replace the ID in the parameter name with the placement ID. For example: _place676.

Acceptable values:

  • on: Enable placement.

  • off: Disable placement.

Required

ID of the object that the action is performed on.

Acceptable value: websites.

Replace the ID in the parameter name with the site ID. For example: _site676.

Acceptable values:

  • on: Enable placement.

  • off: Disable placement.

Replace the ID in the parameter name with the site section ID. For example: _section676.

Acceptable values:

  • on: Enable placement.

  • off: Disable placement.

Previous