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)
SelectionCriteriaIdsCriteria

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

Нет
FieldNamesarray of SitelinksSetFieldEnum

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

Да
PageLimitOffset

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

Нет
Структура IdsCriteria
Idsarray 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)
SitelinksSetsarray of SitelinksSetGetItemНаборы быстрых ссылок.
LimitedBylongПорядковый номер последнего возвращенного объекта. Передается в случае, если количество объектов в ответе было ограничено лимитом. См. раздел Постраничная выборка.
Структура SitelinksSetGetItem
IdlongИдентификатор набора быстрых ссылок.
DescriptionstringОписание быстрой ссылки для отображения объявления в расширенном формате.