get
Возвращает расширения, отвечающие заданным критериям.
В настоящее время доступен один тип расширения — уточнение.
Ограничения
Метод возвращает не более 10 000 объектов.
Запрос
Структура запроса в формате JSON:
{
"method": "get",
"params": { /* params */
"SelectionCriteria": { /* AdExtensionsSelectionCriteria */
"Ids": [(long), ... ],
"Types": [( "CALLOUT" ), ... ],
"States": [( "ON" | "DELETED" ), ... ],
"Statuses": [( "ACCEPTED" | "DRAFT" | "MODERATION" | "REJECTED" ), ... ],
"ModifiedSince": (string)
}, /* required */
"FieldNames": [( "Id" | "Type" | "Status" | "StatusClarification" | "Associated" ), ... ], /* required */
"CalloutFieldNames": [( "CalloutText" )],
"Page": { /* LimitOffset */
"Limit": (long),
"Offset": (long)
}
}
}
Параметр | Тип | Описание | Обяза-тельный |
Структура params (для JSON) / GetRequest (для SOAP) | |||
---|---|---|---|
SelectionCriteria | AdExtensionsSelectionCriteria | Критерий отбора расширений. Чтобы получить все расширения рекламодателя, необходимо указать пустой SelectionCriteria. | Да |
FieldNames | array of AdExtensionFieldEnum | Имена параметров, общие для всех типов расширений, которые требуется получить. | Да |
CalloutFieldNames | array of CalloutFieldEnum | Имена параметров расширения с типом «Уточнение», которые требуется получить. | Нет |
Page | LimitOffset | Структура, задающая страницу при постраничной выборке данных. | Нет |
Структура AdExtensionsSelectionCriteria | |||
Ids | array of long | Отбирать расширения с указанными идентификаторами. Не более 10 000 элементов в массиве. | Нет |
Types | array of AdExtensionTypeEnum | Отбирать расширения с указанными типами. В настоящее время доступен один тип расширения — «Уточнение» (CALLOUT). | Нет |
States | array of AdExtensionStateSelectionEnum | Отбирать расширения с указанными состояниями. См. Соcтояние расширения. Примечание. Метод get возвращает расширение в состоянии DELETED, только если в параметре States указано значение DELETED или в параметре Ids указан идентификатор этого расширения. Если параметры Ids и States оба не заданы, метод не возвращает расширений в состоянии DELETED. | Нет |
Statuses | array of ExtensionStatusSelectionEnum | Отбирать расширения с указанными статусами. См. Статус расширения. | Нет |
ModifiedSince | string | Отбирать расширения, в которых были изменения начиная с указанной даты. Задается в формате | Нет |
Параметр | Тип | Описание | Обяза-тельный |
Структура params (для JSON) / GetRequest (для SOAP) | |||
---|---|---|---|
SelectionCriteria | AdExtensionsSelectionCriteria | Критерий отбора расширений. Чтобы получить все расширения рекламодателя, необходимо указать пустой SelectionCriteria. | Да |
FieldNames | array of AdExtensionFieldEnum | Имена параметров, общие для всех типов расширений, которые требуется получить. | Да |
CalloutFieldNames | array of CalloutFieldEnum | Имена параметров расширения с типом «Уточнение», которые требуется получить. | Нет |
Page | LimitOffset | Структура, задающая страницу при постраничной выборке данных. | Нет |
Структура AdExtensionsSelectionCriteria | |||
Ids | array of long | Отбирать расширения с указанными идентификаторами. Не более 10 000 элементов в массиве. | Нет |
Types | array of AdExtensionTypeEnum | Отбирать расширения с указанными типами. В настоящее время доступен один тип расширения — «Уточнение» (CALLOUT). | Нет |
States | array of AdExtensionStateSelectionEnum | Отбирать расширения с указанными состояниями. См. Соcтояние расширения. Примечание. Метод get возвращает расширение в состоянии DELETED, только если в параметре States указано значение DELETED или в параметре Ids указан идентификатор этого расширения. Если параметры Ids и States оба не заданы, метод не возвращает расширений в состоянии DELETED. | Нет |
Statuses | array of ExtensionStatusSelectionEnum | Отбирать расширения с указанными статусами. См. Статус расширения. | Нет |
ModifiedSince | string | Отбирать расширения, в которых были изменения начиная с указанной даты. Задается в формате | Нет |
Ответ
Структура ответа в формате JSON:
{
"result": { /* result */
"AdExtensions": [{ /* AdExtensionGetItem */
"Id": (long),
"Associated": ( "YES" | "NO" ),
"Type": ( "CALLOUT" | "UNKNOWN" ),
"Callout": { /* Callout */
"CalloutText": (string) /* required */
},
"State": [( "ON" | "DELETED" | "UNKNOWN" ), ... ],
"Status": ( "ACCEPTED" | "DRAFT" | "MODERATION" | "REJECTED" | "UNKNOWN" ),
"StatusClarification": (string)
}, ... ],
"LimitedBy": (long)
}
}
Параметр | Тип | Описание |
Структура result (для JSON) / GetResponse (для SOAP) | ||
---|---|---|
AdExtensions | array of AdExtensionGetItem | Расширения к объявлениям. |
LimitedBy | long | Порядковый номер последнего возвращенного объекта. Передается в случае, если количество объектов в ответе было ограничено лимитом. См. раздел Постраничная выборка. |
Структура AdExtensionGetItem | ||
Id | long | Идентификатор расширения. |
Associated | YesNoEnum | Привязано ли расширение хотя бы к одному объявлению клиента. |
Type | AdExtensionTypeEnum | Тип расширения. |
Callout | Callout | Параметры расширения с типом «Уточнение». |
State | StateEnum | Состояние расширения. См. Соcтояние расширения. |
Status | StatusEnum | Статус расширения. См. Статус расширения. |
StatusClarification | string | Текстовое пояснение к статусу и/или причины отклонения на модерации. |
Структура Callout | ||
CalloutText | string | Текст уточнения. |
Параметр | Тип | Описание |
Структура result (для JSON) / GetResponse (для SOAP) | ||
---|---|---|
AdExtensions | array of AdExtensionGetItem | Расширения к объявлениям. |
LimitedBy | long | Порядковый номер последнего возвращенного объекта. Передается в случае, если количество объектов в ответе было ограничено лимитом. См. раздел Постраничная выборка. |
Структура AdExtensionGetItem | ||
Id | long | Идентификатор расширения. |
Associated | YesNoEnum | Привязано ли расширение хотя бы к одному объявлению клиента. |
Type | AdExtensionTypeEnum | Тип расширения. |
Callout | Callout | Параметры расширения с типом «Уточнение». |
State | StateEnum | Состояние расширения. См. Соcтояние расширения. |
Status | StatusEnum | Статус расширения. См. Статус расширения. |
StatusClarification | string | Текстовое пояснение к статусу и/или причины отклонения на модерации. |
Структура Callout | ||
CalloutText | string | Текст уточнения. |