Get
Возвращает данные по привязкам изображений к объявлениям.
Ограничения
Ответ метода может содержать не более 10 000 привязок.
Общее количество привязок, отвечающих заданным критериям, указывается в результирующем параметре TotalObjectsCount. Если общее количество превышает 10 000, то для получения всех привязок необходимо организовать постраничную выборку с помощью параметров Limit и Offset.
Входные данные
Ниже показана структура входных данных в формате JSON.
{
"method": "AdImageAssociation",
"param": {
/* AdImageAssociationRequest */
"Action": (string),
"SelectionCriteria": {
/* AdImageAssociationSelectionCriteria */
"Logins": [
(string)
...
],
"AdImageHashes": [
(string)
...
],
"StatusAdImageModerate": [
(string)
...
],
"AdIDS": [
(long)
...
],
"CampaignIDS": [
(int)
...
],
"Limit": (int),
"Offset": (int)
}
}
}
Ниже приведено описание параметров.
Параметр | Описание | Требуется |
Объект AdImageAssociationRequest | ||
---|---|---|
Action | Выполняемая операция: Get. | Да |
SelectionCriteria | Объект AdImageAssociationSelectionCriteria, содержащий критерии отбора привязок. | Для агентств |
Объект AdImageAssociationSelectionCriteria | ||
Logins | Для агентств — массив, содержащий логины клиентов (не более 10), для которых нужно выполнить операцию. Для рекламодателей параметр игнорируется. | Для агентств |
AdImageHashes | Массив, содержащий хэши изображений (не более 10 000). | Нет |
StatusAdImageModerate | Массив строк, содержащий статусы модерации изображений:
Отбираются изображения со всеми статусами, перечисленными в массиве. | Нет |
AdIDS | Массив идентификаторов объявлений (не более 10 000), к которым привязаны изображения. | Нет |
CampaignIDS | Массив идентификаторов кампаний (не более 1000), к которым привязаны изображения. | Нет |
Limit | Количество привязок в ответе. Максимальное допустимое значение —10 000. Если не указано, используется ограничение 10 000. Вместе с параметром Offset позволяет организовать постраничную выборку из базы данных. | Нет |
Offset | Количество привязок, которое должно быть пропущено при выборке. Если не указано, подразумевается 0. Вместе с параметром Limit позволяет организовать постраничную выборку из базы данных. | Нет |
Примечание | ||
|
Параметр | Описание | Требуется |
Объект AdImageAssociationRequest | ||
---|---|---|
Action | Выполняемая операция: Get. | Да |
SelectionCriteria | Объект AdImageAssociationSelectionCriteria, содержащий критерии отбора привязок. | Для агентств |
Объект AdImageAssociationSelectionCriteria | ||
Logins | Для агентств — массив, содержащий логины клиентов (не более 10), для которых нужно выполнить операцию. Для рекламодателей параметр игнорируется. | Для агентств |
AdImageHashes | Массив, содержащий хэши изображений (не более 10 000). | Нет |
StatusAdImageModerate | Массив строк, содержащий статусы модерации изображений:
Отбираются изображения со всеми статусами, перечисленными в массиве. | Нет |
AdIDS | Массив идентификаторов объявлений (не более 10 000), к которым привязаны изображения. | Нет |
CampaignIDS | Массив идентификаторов кампаний (не более 1000), к которым привязаны изображения. | Нет |
Limit | Количество привязок в ответе. Максимальное допустимое значение —10 000. Если не указано, используется ограничение 10 000. Вместе с параметром Offset позволяет организовать постраничную выборку из базы данных. | Нет |
Offset | Количество привязок, которое должно быть пропущено при выборке. Если не указано, подразумевается 0. Вместе с параметром Limit позволяет организовать постраничную выборку из базы данных. | Нет |
Примечание | ||
|
Результирующие данные
Ниже показана структура результирующих данных в формате JSON.
{
"data": {
/* AdImageAssociationResponse */
"AdImageAssociations": [
{ /* AdImageAssociation */
"AdID": (long),
"AdImageHash": (string),
"Login": (string),
"CampaignID": (int),
"StatusAdImageModerate": (string),
"ModerateRejectionReasons": [
{ /* RejectReason */
"Type": (string),
"Text": (string)
}
...
]
}
...
],
"TotalObjectsCount": (int)
}
}
Ниже приведено описание параметров.
Параметр | Описание |
Объект AdImageAssociationResponse | |
---|---|
AdImageAssociations | Массив объектов AdImageAssociation, содержащих информацию о привязках. |
TotalObjectsCount | Общее количество привязок, соответствующих заданным критериям (без учета параметра Limit). |
Объект AdImageAssociation | |
AdID | Идентификатор объявления, к которому привязано изображение. |
AdImageHash | Хэш изображения. |
Login | Логин владельца изображения. |
CampaignID | Идентификатор кампании. |
StatusAdImageModerate | Статус модерации изображения:
|
ModerateRejectionReasons | Массив объектов RejectReason. Эти объекты описывают причины, по которым отклонено изображение для объявления. |
Объект RejectReason | |
Type | Тип объекта, отклоненного на модерации: AdImage. |
Text | Причина отклонения на модерации. |
Параметр | Описание |
Объект AdImageAssociationResponse | |
---|---|
AdImageAssociations | Массив объектов AdImageAssociation, содержащих информацию о привязках. |
TotalObjectsCount | Общее количество привязок, соответствующих заданным критериям (без учета параметра Limit). |
Объект AdImageAssociation | |
AdID | Идентификатор объявления, к которому привязано изображение. |
AdImageHash | Хэш изображения. |
Login | Логин владельца изображения. |
CampaignID | Идентификатор кампании. |
StatusAdImageModerate | Статус модерации изображения:
|
ModerateRejectionReasons | Массив объектов RejectReason. Эти объекты описывают причины, по которым отклонено изображение для объявления. |
Объект RejectReason | |
Type | Тип объекта, отклоненного на модерации: AdImage. |
Text | Причина отклонения на модерации. |
Примеры входных данных
Python
{
'Action': 'Get',
'SelectionCriteria': {
'StatusAdImageModerate': ['Yes'],
'CampaignIDS': [1327944, 1327974],
'Limit': 20,
'Offset': 60
}
}
PHP
array(
'Action' => 'Get',
'SelectionCriteria' => array(
'StatusAdImageModerate' => array('Yes'),
'CampaignIDS' => array(1327944, 1327974),
'Limit' => 20,
'Offset' => 60
)
)
Perl
{
'Action' => 'Get',
'SelectionCriteria' => {
'StatusAdImageModerate' => ['Yes'],
'CampaignIDS' => [1327944, 1327974],
'Limit' => 20,
'Offset' => 60
}
}