get
Возвращает наборы быстрых ссылок, отвечающие заданным критериям.## Узнайте больше
Ограничения
Метод возвращает не более page-size
объектов.
Запрос
Структура запроса в формате JSON:
{
"method": "get",
"params": { /* params */
"SelectionCriteria": { /* IdsCriteria */
"Ids": [(long), ... ] /* required */
},
"FieldNames": [( "Id" | "Sitelinks" ), ... ],
"SitelinkFieldNames": [( "Title" | "Href" | "Description" | "TurboPageId" ), ... ],
"Page": { /* LimitOffset */
"Limit": (long),
"Offset": (long)
}
}
}
Параметр |
Тип |
Описание |
Обязательный |
Структура params (для JSON) / GetRequest (для SOAP) |
|||
|
IdsCriteria |
Критерий отбора наборов. Если не указан, будут получены все наборы рекламодателя. |
Нет |
|
array of SitelinksSetFieldEnum |
Имена параметров верхнего уровня, которые требуется получить. Если указано значение Если требуется получить другой набор полей, перечислите их имена в параметре |
Нет |
|
array of SitelinkFieldEnum |
Имена полей быстрой ссылки, которые требуется получить. |
Нет |
|
Структура, задающая страницу при постраничной выборке данных. |
Нет |
|
Структура IdsCriteria |
|||
|
array of long |
Идентификаторы наборов, которые требуется получить. |
Да |
Ответ
Структура ответа в формате JSON:
{
"result": { /* result */
"SitelinksSets": [{ /* SitelinksSetGetItem */
"Id": (long),
"Sitelinks": [{ /* Sitelink */
"Title": (string),
"Href": (string), /* nillable */
"Description": (string), /* nillable */
"TurboPageId": (long) /* nillable */
}, ... ]
}, ... ],
"LimitedBy": (long)
}
}
Параметр |
Тип |
Описание |
Структура result (для JSON) / GetResponse (для SOAP) |
||
|
array of SitelinksSetGetItem |
Наборы быстрых ссылок. |
|
long |
Порядковый номер последнего возвращенного объекта. Передается в случае, если количество объектов в ответе было ограничено лимитом. См. раздел Постраничная выборка. |
Структура SitelinksSetGetItem |
||
|
long |
Идентификатор набора быстрых ссылок. |
|
Sitelink |
Массив, содержащий от 1 до 8 объектов Sitelink. |
Структура Sitelink |
||
|
string |
Текст быстрой ссылки. |
|
string, nillable |
Адрес быстрой ссылки. |
|
string, nillable |
Описание быстрой ссылки для отображения объявления в расширенном формате. |
|
long, nillable |
Идентификатор Турбо-страницы. |