updateDefaultBanner
Add the default banner at the placement level. The default banner is the banner code that's served if no banner from commercial campaigns can be served now.
You can set default banners at the placement and/or banner type level.
If the backup ad isn't set for the placement, the backup ad set for the banner type is served. If a backup ad isn't set for the banner type, either, the server returns a placeholder that doesn't affect placement display on the website.
Request format
https://adfox.yandex.com/api/v1
? object=place
& action=updateDefaultBanner
& objectID=<integer>
& mode=<integer>
& [defaultImageURL=<string>]
& [defaultHitURL=<string>]
& [defaultWidth=<integer>]
& [defaultHeight=<integer>]
& [defaultCode=<string>]
& [defaultCodeType=<integer>]
|
|
The ID of the object that the action is performed on. |
|
|
The mode for using the default banner. Acceptable values:
Default value: |
|
|
Only for Default banner image URL. If |
|
|
Only for Specify the URL to go to from the default banner. |
|
|
Only for Image width in pixels. |
|
|
Only for Image height in pixels. |
|
|
Only for Backup ad. |
|
|
Only for Ad tag type. Acceptable values:
Default value: |
* 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=place&action=updateDefaultBanner&objectID=234&mode=0Response:
<response> <status> <code>0</code> </status> </response>
Other actions with the object
See also other actions with the place object:
- Add a placement.
- Delete a placement.
- Get a list of placements.
- Get a list of active banners on the placement.
- Edit placement parameters.
- Get an ad tag from the placement level.
The ID of the object that the action is performed on.
The mode for using the default banner.
Acceptable values:
-
0: File (only for Standard and Nondimensional banner types). -
1: Code.
Default value: 0.
Only for mode=0 and the Standard and Nondimensional banner types.
Default banner image URL.
If defaultImageURL is specified, the Transition URL parameter (defaultHitURL) is required.
Only for mode=0 and the Standard and Nondimensional banner types.
Specify the URL to go to from the default banner.
Only for mode=0 and the Nondimensional banner type.
Image width in pixels.
Only for mode=0 and the Nondimensional banner type.
Image height in pixels.
Only for mode=1 and the Nondimensional banner type.
Backup ad.
Only for mode=1.
Ad tag type.
Acceptable values:
-
0: HTML. -
1: JavaScript.
Default value: 0.
Required