banners.check
Check banners attributes before create or update.
If the response status is 206, it means that banner does not contain errors
and will be accepted, but we still have some suggestions for it.
If the response status is 406, you shall fix your arguments according to diagnostics
in order to successfully call banners.create or banners.update.
Method response might look like this:
banners.check(
"...", {
})
=>
{
"status": 406,
"statusMessage": "Invalid data in request",
"session": "...",
"diagnostics": [
{"id": "clickthruUrl_is_too_long"},
{"field": "clickthruUrl"}
]
}
Parameters
| struct |
user { |
|
| string |
session |
Session (as retrieved from client.loginByToken())
|
| int |
userId |
(optional) User ID
|
|
} |
|
|
| array |
banners ( |
|
| struct |
{ |
|
| int |
id |
(optional) Banner ID
|
| string |
name |
(optional) Banner name
|
| string |
clickthruUrl |
(optional) Target URL
|
| string |
status |
(optional) Status:
|
| binary |
file |
(optional) Image data (jpg, png, gif)
|
| array |
schedule ( |
(optional) (can be null) Delivery schedule of banner. Array of 7 days, week starts at monday.
|
) |
|
|
|
} |
|
|
|
) |
|
|
Response
| struct |
{ |
|
| string |
statusMessage |
Status code description
|
| string |
session |
Refreshed session
|
| array |
diagnostics ( |
(optional) Various diagnostics(warnings, errors, other information)
|
|
|
) |
|
|
|
} |
|
|
Response status codes:
List of all possible response status codes:
200: OK206: Partially OK301: User is serviced400: Bad arguments401: Invalid session403: Access Denied404: Not found406: Bad values of attributes413: Too many items requested.429: Too many requests. Has to wait.500: Server Error.409: Conflict
Diagnostics:
List of all possible diagnostics:
ad_attribute_no_changebad_urlbad_url_textbanner_access_deniedbanner_already_removedclickthruUrl_is_too_longfile_missingfile_size_too_largeinvalid_file_formatinvalid_image_formatinvalid_schedule_day_sizeinvalid_schedule_sizeinvalid_sizenot_allowed_for_campaign_typeschedule_value_too_largeschedule_value_too_lowuser_access_denied
