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>]
|
|
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:
|
|
|
Impression frequency limit at the placement level. Impression frequency period. Acceptable values:
|
|
|
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 If |
|
|
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 Default value: Required if If |
Response format
<response>
<status>
<code>{integer}</code>
</status>
</response>
Response parameters
|
|
Request processing status. A value of |
Sample request and response
Request:
https://adfox.yandex.com/api/v1?object=place&action=modify&objectID=543&name=site.ru/news/240Response:
<response> <status> <code>0</code> </status> </response>
Other actions with the object
Read about other actions with the place object:
- Add a placement.
- Add the default banner.
- Delete a placement.
- Get a list of active banners on the placement.
- Get an ad tag from the placement level.
- Create a YAN ad unit and link it to a placement.
- Link an existing YAN ad unit to a placement.
- Manage the ad unit status on a placement.
- Remove an ad unit from its placement and archive it in YAN.
- Get a list of placements along with their details and data on YAN ad units.
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. Thepli(Number of impressions per period) andpop(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. Thepli(Number of impressions per period) andpop(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. Thepop(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.