modify

Edit placement parameters.

Request format

https://adfox.yandex.com/api/v1
  ? object=place
  & action=modify
  & objectID=<integer>
  & [name=<string>]
  & [categoryID=<integer>]
  & [positionID=<integer>]
  & [pct=<integer>]
  & [plp=<integer>]
  & [pli=<integer>]
  & [pop=<integer>]

objectID*

ID of the object the action applies to.

name

Object name.

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

categoryID

Category ID.

Read also:

positionID

Placement position ID.

Read also:

pct

Use this setting to allow serving particular ad campaign types on this placement.

Acceptable values:

  • 0: From the request URL (by default). The code type is defined by the parameter value passed in the banner request URL. If this parameter is omitted from the request, the placement is treated as having a standard code type by default.
  • 1: Standard. Banners from all ad campaigns are allowed to serve, except for session-on-page campaigns.
  • 2: Unrepeatable. You can install multiple ad tags for a specific placement on the page, which will then request and serve various banners, excluding session-on-page campaigns.
  • 3: Session on page. The page serves banners from session-on-page campaigns (which take priority over standard campaigns). If no session-on-page campaigns are available, the system selects a standard ad campaign.
  • 4: Unrepeatable campaigns. You can install multiple ad tags for this placement on the page, and each one requests a single banner from the same ad campaign, excluding session-on-page campaigns.

plp

Impression frequency limit at the placement level. Impression frequency period.

Acceptable values:

  • -1: From the request URL (by default). Frequency capping settings will be taken from the parameters of the banner request URL. If the values aren't passed in the request, the placement is considered to have no limits. The pli (Number of impressions per period) and pop (Other period) parameters must be empty or omitted from the request.
  • 0: No limits. Banner impressions on this placement aren't limited even if the request parameters specify otherwise. The pli (Number of impressions per period) and pop (Other period) parameters must be empty or omitted from the request.
  • 1: 1 hour. The limit is valid for 1 hour after the banner is first served to a unique user.
  • 2: 6 hours. The limit applies for 6 hours after the banner is first served to a unique user.
  • 3: 12 hours. The limit applies for 12 hours after the banner is first served to a unique user.
  • 4: 24 hours. The limit applies for 24 hours after the banner is first served to a unique user.
  • 5: Other. Specify a custom period for frequency capping in minutes. The pop (Other period) parameter is required.

pli

Impression frequency limit at the placement level. How many banner impressions are made on this placement for a unique user.

Allowed values: an integer greater than 1.

If plp=-1 or plp=0 (the Impression frequency period parameter is passed with the from request URL or no limits value), the pli parameter must be omitted from the request or passed with an empty value.

pop

Impression frequency limit at the placement level. Other period (minutes): You can set your own time period for the impression restriction in minutes.

Allowed values: an integer greater than 1.

Default value: 1.

Required if plp=5 (Impression frequency period = other).

If plp=-1 or plp=0 (the Impression frequency period parameter is passed with the From request URL or No limits value), the pop parameter must be omitted from the request or passed with an empty value.

Response format

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

Response parameters

code

Request processing status. A value of 0 means the request was completed successfully. For the key, see Error handling.

Sample request and response

Request:

https://adfox.yandex.com/api/v1?object=place&action=modify&objectID=543&name=site.ru/news/240

Response:

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

Other actions with the object

Read about other actions with the place object:

ID of the object the action applies to.

Object name.

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

Category ID.

Read also:

Placement position ID.

Read also:

Use this setting to allow serving particular ad campaign types on this placement.

Acceptable values:

  • 0: From the request URL (by default). The code type is defined by the parameter value passed in the banner request URL. If this parameter is omitted from the request, the placement is treated as having a standard code type by default.
  • 1: Standard. Banners from all ad campaigns are allowed to serve, except for session-on-page campaigns.
  • 2: Unrepeatable. You can install multiple ad tags for a specific placement on the page, which will then request and serve various banners, excluding session-on-page campaigns.
  • 3: Session on page. The page serves banners from session-on-page campaigns (which take priority over standard campaigns). If no session-on-page campaigns are available, the system selects a standard ad campaign.
  • 4: Unrepeatable campaigns. You can install multiple ad tags for this placement on the page, and each one requests a single banner from the same ad campaign, excluding session-on-page campaigns.

Impression frequency limit at the placement level. Impression frequency period.

Acceptable values:

  • -1: From the request URL (by default). Frequency capping settings will be taken from the parameters of the banner request URL. If the values aren't passed in the request, the placement is considered to have no limits. The pli (Number of impressions per period) and pop (Other period) parameters must be empty or omitted from the request.
  • 0: No limits. Banner impressions on this placement aren't limited even if the request parameters specify otherwise. The pli (Number of impressions per period) and pop (Other period) parameters must be empty or omitted from the request.
  • 1: 1 hour. The limit is valid for 1 hour after the banner is first served to a unique user.
  • 2: 6 hours. The limit applies for 6 hours after the banner is first served to a unique user.
  • 3: 12 hours. The limit applies for 12 hours after the banner is first served to a unique user.
  • 4: 24 hours. The limit applies for 24 hours after the banner is first served to a unique user.
  • 5: Other. Specify a custom period for frequency capping in minutes. The pop (Other period) parameter is required.

Impression frequency limit at the placement level. How many banner impressions are made on this placement for a unique user.

Allowed values: an integer greater than 1.

If plp=-1 or plp=0 (the Impression frequency period parameter is passed with the from request URL or no limits value), the pli parameter must be omitted from the request or passed with an empty value.

Impression frequency limit at the placement level. Other period (minutes): You can set your own time period for the impression restriction in minutes.

Allowed values: an integer greater than 1.

Default value: 1.

Required if plp=5 (Impression frequency period = other).

If plp=-1 or plp=0 (the Impression frequency period parameter is passed with the From request URL or No limits value), the pop parameter must be omitted from the request or passed with an empty value.

Required parameter.