zone
Place a campaign in a site section.
Request format
https://adfox.yandex.com/api/v1
? object=campaign
& action=placing
& actionObject=zone
& objectID=<integer>
& actionObjectID=<integer>
& actionStatus=<integer>
& [rotationMethodID=<integer>]
& [maxImpressions=<integer>]
& [maxImpressionsPerDay=<integer>]
& [maxImpressionsPerHour=<integer>]
& [maxClicks=<integer>]
& [maxClicksPerDay=<integer>]
& [maxClicksPerHour=<integer>]
& [dateStart=<YYYY-MM-DD HH:mm>]
& [dateEnd=<YYYY-MM-DD HH:mm>]
& [targetingProfileID=<integer>]
|
|
ID of the object the action applies to. |
|
|
Site section ID. Read also: |
|
|
Enable or disable placement. Acceptable values:
|
|
|
Acceptable values:
Default value: |
|
|
Maximum number of banner impressions. Acceptable values: Integers from |
|
|
Maximum number of impressions per day. Acceptable values: Integers from |
|
|
Maximum number of impressions per hour. Acceptable values: Integers from |
|
|
Maximum total number of click-throughs. Acceptable values: Integers from |
|
|
Maximum number of clicks per day. Acceptable values: Integers from |
|
|
Maximum number of clicks per hour. Acceptable values: Integers from |
|
|
Ad running start date. Date and time transmission format: Default value: today from 00:00. |
|
|
Delivery end date. Date and time transmission format: |
|
|
You can use a targeting profile to combine the settings of several targeting types. When creating a campaign or banner, you can specify a targeting profile. This way, you don't waste time setting up every targeting type separately. To learn how to list profile IDs, see the list-targetingProfile section. |
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=campaign&action=placing&actionObject=zone&objectID=474205&actionStatus=1&actionObjectID=3245Response:
<response> <status> <code>0</code> </status> </response>
Other actions with the object
Read more about other actions with the campaign object:
- Add a campaign.
- Get a list of campaigns.
- Delete a campaign.
- Edit a campaign.
- Get a list of ad campaign banners.
- Place a campaign on a site or a placement.
ID of the object the action applies to.
Site section ID.
Read also:
Enable or disable placement.
Acceptable values:
0: disabled.1: enabled.
Acceptable values:
−1: Not redefined (the value is inherited from the level above).0: By priority. Use the values of thelevelandpriorityparameters to determine the probability of your ad campaign being served.1: By percentage of traffic. Use the value of thetrafficPercentsparameter to estimate the probability of the ad campaign being served.
Default value: -1.
Ad running start date.
Date and time transmission format: YYYY-MM-DD HH:mm.
Default value: today from 00:00.
Delivery end date.
Date and time transmission format: YYYY-MM-DD HH:mm.
You can use a targeting profile to combine the settings of several targeting types. When creating a campaign or banner, you can specify a targeting profile. This way, you don't waste time setting up every targeting type separately.
To learn how to list profile IDs, see the list-targetingProfile section.
Maximum number of banner impressions.
Acceptable values: Integers from 1 to 2147483647.
Maximum number of impressions per day.
Acceptable values: Integers from 1 to 2147483647.
Maximum number of impressions per hour.
Acceptable values: Integers from 1 to 2147483647.
Maximum total number of click-throughs.
Acceptable values: Integers from 1 to 2147483647.
Maximum number of clicks per day.
Acceptable values: Integers from 1 to 2147483647.
Maximum number of clicks per hour.
Acceptable values: Integers from 1 to 2147483647.
Required parameter.