get

Возвращает наборы быстрых ссылок, отвечающие заданным критериям.

  1. Ограничения
  2. Запрос
  3. Ответ

Ограничения

Метод возвращает не более 10 000 объектов.

Запрос

Структура запроса в формате JSON:

{
  "method": "get",
  "params": {  /* params */
    "SelectionCriteria": {  /* IdsCriteria */
      "Ids": [(long), ... ] /* required */ 
    },
    "FieldNames": [( "Id" | "Sitelinks" ), ... ], /* required */
    "Page": {  /* LimitOffset */
      "Limit": (long),
      "Offset": (long)
    }
  } 
}
Параметр Тип Описание Обяза-тельный
Структура params (для JSON) / GetRequest (для SOAP)
SelectionCriteria IdsCriteria

Критерий отбора наборов. Если не указан, будут получены все наборы рекламодателя.

Нет
FieldNames array of SitelinksSetFieldEnum

Имена параметров, которые требуется получить.

Да
Page LimitOffset

Структура, задающая страницу при постраничной выборке данных.

Нет
Структура IdsCriteria
Ids array of long

Идентификаторы наборов, которые требуется получить.

Да

Ответ

Примечание. В ответе присутствуют только параметры, которые были указаны во входном параметре FieldNames.

Структура ответа в формате JSON:

{
  "result": { /* result */
    "SitelinksSets": [{  /* SitelinksSetGetItem */
      "Id": (long),
      "Sitelinks": [{  /* Sitelink */
        "Title": (string), /* required */
        "Href": (string), /* required */
        "Description": (string)  
     }, ... ] 
    }, ... ],
    "LimitedBy": (long)
  }
}
Параметр Тип Описание
Структура result (для JSON) / GetResponse (для SOAP)
SitelinksSets array of SitelinksSetGetItem Наборы быстрых ссылок.
LimitedBy long Порядковый номер последнего возвращенного объекта. Передается в случае, если количество объектов в ответе было ограничено лимитом. См. раздел Постраничная выборка.
Структура SitelinksSetGetItem
Id long Идентификатор набора быстрых ссылок.
Description string Описание быстрой ссылки для отображения объявления в расширенном формате.