website
Place a campaign on a site.
Request format
https://adfox.yandex.com/api/v1
? object=campaign
& action=placing
& actionObject=website
& 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 that the action is performed on. |
|
|
Website ID. See also: |
|
|
Enable or disable placement. Acceptable values:
|
|
|
Acceptable values:
Default value: |
|
|
Maximum number of banner impressions. Acceptable values: |
|
|
Maximum number of impressions per day. Acceptable values: |
|
|
Maximum number of impressions per hour.
Acceptable values: |
|
|
Maximum total number of clicks. Acceptable values: |
|
|
Maximum number of clicks per day. Acceptable values: |
|
|
Maximum number of clicks per hour. Acceptable values: |
|
|
Delivery start date. Default value: Date and time format: |
|
|
Delivery end date. Date and time 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. See also: |
* Required
Response format
<response>
<status>
<code>{integer}</code>
</status>
</response>
Response parameters
|
|
Request processing status. For the key, see Error handling. |
Sample request and response
Request:
https://adfox.yandex.com/api/v1?object=campaign&action=placing&actionObject=website&objectID=474205&actionStatus=1&actionObjectID=3245Response:
<response> <status> <code>0</code> </status> </response>
Other actions with the object
See more actions with the campaign object:
- Add a campaign.
- Get a list of campaigns.
- Delete a campaign.
- Edit a campaign.
- Get a list of a campaign banners.
- Place a campaign in a site section or on a placement.
ID of the object that the action is performed on.
Website ID.
See also:
Enable or disable placement.
Acceptable values:
-
0: Disable. -
1: Enable.
Acceptable values:
-
−1: Not redefined (the value is inherited from the level above). -
0: by priority. Use the level and priotiry parameter values to estimate the probability of serving the campaign. -
1: By % of traffic. Use the traffic percentage parameter value to estimate the probability of serving the campaign.
Default value: -1.
Maximum number of banner impressions.
Acceptable values: an integer from 1 to 2,147,483,647.
Maximum number of impressions per day.
Acceptable values: an integer from 1 to 2,147,483,647.
Maximum number of impressions per hour.
Acceptable values: an integer from 1 to 2,147,483,647.
Maximum total number of clicks.
Acceptable values: an integer from 1 to 2,147,483,647.
Maximum number of clicks per day.
Acceptable values: an integer from 1 to 2,147,483,647.
Maximum number of clicks per hour.
Acceptable values: an integer from 1 to 2,147,483,647.
Delivery start date.
Default value: today from 00:00.
Date and time format: YYYY-MM-DD HH:mm.
Delivery end date.
Date and time 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.
See also:
Required