get

Возвращает параметры Турбо-страниц.## Узнайте больше

Ограничения

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

Метод возвращает только опубликованные Турбо-страницы.

Запрос

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

{
  "method": "get",
  "params": { /* params */
    "SelectionCriteria": { /* IdsCriteria */
      "Ids": [(long), ... ],
      "BoundWithHrefs": [(string), ...]
    },
    "FieldNames": [( "Id" | "Name" | "Href" | "PreviewHref" | "TurboSiteHref" | "BoundWithHref" ), ... ], /* required */
    "Page": {  /* LimitOffset */
      "Limit": (long),
      "Offset": (long)
    }
  }
}

Параметр

Тип

Описание

Обязательный

Структура params (для JSON) / GetRequest (для SOAP)

SelectionCriteria

IdsCriteria

Критерии отбора Турбо-страниц.

Чтобы получить все опубликованные Турбо-страницы рекламодателя, не указывайте SelectionCriteria.

Нет

FieldNames

array of TurboPageFieldEnum

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

Да

Page

LimitOffset

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

Нет

Структура IdsCriteria

Ids

array of long

Отбирать Турбо-страницы с указанными идентификаторами. От 1 до 10 000 элементов в массиве.

Нет

BoundWithHrefs

array of string

Отбирать Турбо-страницы с указанными ссылками.

Нет

Ответ

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

{
  "result": { /* result */
    "TurboPages": [{ /* TurboPageGetItem */
      "Id": (long),
      "Name": (string),
      "Href": (string),
      "PreviewHref": (string),
      "TurboSiteHref": (string),
      "BoundWithHref": (string)
    }, ... ],
    "LimitedBy": (long)
  }
}

Параметр

Тип

Описание

Структура result (для JSON) / GetResponse (для SOAP)

TurboPages

array of TurboPageGetItem

Параметры Турбо-страницы.

LimitedBy

long

Порядковый номер последнего возвращенного объекта. Передается в случае, если количество объектов в ответе было ограничено лимитом. См. раздел Постраничная выборка.

Структура TurboPageGetItem

Id

long

Идентификатор Турбо-страницы.

Name

string

Название Турбо-страницы.

Href

string

Ссылка на опубликованную Турбо-страницу.

PreviewHref

string

Ссылка для предварительного просмотра Турбо-страницы.

TurboSiteHref

string

Ссылка вида имя.turbo.site. Если такая ссылка не привязана к Турбо-странице, значение будет пустым.

BoundWithHref

string

Ссылка, по которой была найдена Турбо-страница (соответствует ссылке из параметров запроса, без выравнивания регистра и нормализации).