get

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

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

Ограничения

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

Запрос

Структура запроса в формате 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)
SelectionCriteria IdsCriteria

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

Нет
FieldNames array of SitelinksSetFieldEnum

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

Если указано значение Sitelinks, то в массиве Sitelinks будут возвращены следующие поля быстрых ссылок: Title, Href, Description.

Если требуется получить другой набор полей, перечислите их имена в параметре SitelinkFieldNames, а значение Sitelinks в параметре FieldNames не указывайте.

Нет
SitelinkFieldNames array of SitelinkFieldEnum Имена полей быстрой ссылки, которые требуется получить. Нет
Page LimitOffset

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

Нет
Структура IdsCriteria
Ids 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)
SitelinksSets array of SitelinksSetGetItem Наборы быстрых ссылок.
LimitedBy long Порядковый номер последнего возвращенного объекта. Передается в случае, если количество объектов в ответе было ограничено лимитом. См. раздел Постраничная выборка.
Структура SitelinksSetGetItem
Id long Идентификатор набора быстрых ссылок.