place

Add a placement.

Request format

https://adfox.yandex.com/api/v1
  ? object=account
  & action=add
  & actionObject=place
  & name=<string>
  & siteID=<integer>
  & zoneID=<integer>
  & bannerTypeID=<integer>
  & positionID=<integer>
  & [categoryID=<integer>]
  & [pct=<integer>]
  & [plp=<integer>]
  & [pli=<integer>]
  & [pop=<integer>]

name*

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

siteID*

ID of the site where the placement is created.

See also:

zoneID*

ID of the section where the placement is created.

See also:

bannerTypeID*

ID of the banner type used to create the placement.

See also:

positionID*

Placement position ID.

See also:

categoryID

Category ID.

See also:

pct

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

Acceptable values:

  • 0: From request URL (default value). The code type is determined by the parameter value 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 code type by default.
  • 1: Regular. Banners from all campaigns are allowed for serving, except for campaigns of the session on page type.
  • 2: Unrepeatable banners. Multiple ad tags are installed on the site page for this placement. According to their requests, several different banners are selected for serving, except for campaigns of the session on page type.
  • 3: Session on page. Banners from campaigns marked as session on page are allowed for serving (they have priority over regular campaigns). If there are no session campaigns to serve, a regular campaign is selected.
  • 4: Unrepeatable campaigns. Multiple ad tags are installed on the site page for this placement. According to their requests, one banner per campaign is selected, except for campaigns of the session on page type.

plp

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

Acceptable values:

  • -1: From request URL (default value). The impression limit settings from the banner request URL parameters are used. 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: 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. The number of impressions per period that determines how many banner impressions are served 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.

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

Response format

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

Response parameters

code

Request processing status. If the value is 0, the request was completed successfully. For the key, see Error handling.

ID

Object ID.

Sample request and response

Request:

https://adfox.yandex.com/api/v1?object=account&action=add&actionObject=place&name=site.com&siteID=39939&zoneID=84438&bannerTypeID=22&positionID=2

Response:

<response>
<status>
  <code>0</code>
  <ID>84438</ID>
</status>
</response>

Other actions with the object

See more actions with the place object:

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.

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

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

ID of the site where the placement is created.

See also:

ID of the section where the placement is created.

See also:

ID of the banner type used to create the placement.

See also:

Placement position ID.

See also:

Category ID.

See also:

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

Acceptable values:

  • 0: From request URL (default value). The code type is determined by the parameter value 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 code type by default.

  • 1: Regular. Banners from all campaigns are allowed for serving, except for campaigns of the session on page type.

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

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

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

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

Acceptable values:

  • -1: From request URL (default value). The impression limit settings from the banner request URL parameters are used. 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: 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. The number of impressions per period that determines how many banner impressions are served 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.

Previous