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*

The ID of the object that the action is performed on.

name

Object name. It can contain Russian and Latin letters, numbers, and any symbols.

categoryID

Category ID.

See also:

positionID

Placement position ID.

See also:

pct

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

Acceptable values:

  • 0: From request URL — the tag type is determined by the parameter value that's obtained from the URL of the banner request. If the value isn't passed in the request, the placement is considered to have the regular tag type by default.
  • 1: Regular — banners from all campaigns are allowed for impressions, except for session on page campaigns.
  • 2: Unrepeatable banners — multiple ad tags are installed on the website page for this placement. According to their requests, several different banners are selected for serving, except for session on page campaigns.
  • 3: Session on page — banners from campaigns marked as session on page are allowed for impressions (they have priority over regular campaigns). If there are no session campaigns to serve, a regular campaign is selected.
  • 4: Unrepeatable campaigns — several ad tags are installed on the website page for this placement. According to their requests, one banner per campaign is selected, except for session on page campaigns.

plp

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

Acceptable values:

  • -1: From request URL — the impression limit settings from the banner request URL parameters are used. If no values are 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 absent 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 absent from the request.
  • 1: One hour — the limit is valid for one hour after the banner is first served to a unique user.
  • 2: Six hours — the limit is valid for six hours after the banner is first served to a unique user.
  • 3: 12 hours — the limit is valid for 12 hours after the banner is first served to a unique user.
  • 4: 24 hours — the limit is valid for 24 hours after the banner is first served to a unique user.
  • 5: Other — you can set your own time period for the impression limit 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.

Acceptable values: an integer > 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 limit in minutes.

Acceptable values: an integer > 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

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=place&action=modify&objectID=543&name=site.com/news/240

Response:

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

Other actions with the object

See also other actions with the place object:

The ID of the object that the action is performed on.

Object name. It can contain Russian and Latin letters, numbers, and any symbols.

Category ID.

See also:

Placement position ID.

See also:

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

Acceptable values:

  • 0: From request URL — the tag type is determined by the parameter value that's obtained from the URL of the banner request. If the value isn't passed in the request, the placement is considered to have the regular tag type by default.

  • 1: Regular — banners from all campaigns are allowed for impressions, except for session on page campaigns.

  • 2: Unrepeatable banners — multiple ad tags are installed on the website page for this placement. According to their requests, several different banners are selected for serving, except for session on page campaigns.

  • 3: Session on page — banners from campaigns marked as session on page are allowed for impressions (they have priority over regular campaigns). If there are no session campaigns to serve, a regular campaign is selected.

  • 4: Unrepeatable campaigns — several ad tags are installed on the website page for this placement. According to their requests, one banner per campaign is selected, except for session on page campaigns.

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

Acceptable values:

  • -1: From request URL — the impression limit settings from the banner request URL parameters are used. If no values are 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 absent 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 absent from the request.

  • 1: One hour — the limit is valid for one hour after the banner is first served to a unique user.

  • 2: Six hours — the limit is valid for six hours after the banner is first served to a unique user.

  • 3: 12 hours — the limit is valid for 12 hours after the banner is first served to a unique user.

  • 4: 24 hours — the limit is valid for 24 hours after the banner is first served to a unique user.

  • 5: Other — you can set your own time period for the impression limit 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.

Acceptable values: an integer > 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 limit in minutes.

Acceptable values: an integer > 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