Method: advertisers.adGroups.list

Список групп объявлений.

HTTP-запрос

GET https://displayvideo.googleapis.com/v5/advertisers/{advertiserId}/adGroups

URL имеет синтаксис gRPC Transcoding.

Параметры пути

Параметры
advertiserId

string (int64 format)

Обязательно. Идентификатор рекламодателя, которому принадлежит группа объявлений.

Параметры запроса

Параметры
pageSize

integer

Необязательное поле. Запрошенный размер страницы. Значение должно быть в диапазоне от 1 до 200. Если не указано, по умолчанию будет использоваться 100. Если указано недопустимое значение, возвращается код ошибки INVALID_ARGUMENT.
pageToken

string

Необязательное поле. Токен, идентифицирующий страницу результатов, которую должен вернуть сервер. Обычно это значение nextPageToken, возвращенное предыдущим вызовом метода adGroups.list. Если значение не указано, будет возвращена первая страница результатов.
orderBy

string

Необязательное поле. Поле, по которому нужно отсортировать список. Допустимые значения:

  • displayName (по умолчанию)
  • entityStatus

По умолчанию используется порядок сортировки по возрастанию. Чтобы указать порядок по убыванию, добавьте к названию поля суффикс desc. Пример: displayName desc.
filter

string

Необязательное поле. Позволяет фильтровать по специальным полям группы объявлений.

Поддерживаемый синтаксис:

  • Выражения фильтров состоят из одного или нескольких ограничений.
  • Ограничения можно комбинировать с помощью операторов AND и OR. Последовательность ограничений неявно использует AND.
  • Ограничение имеет следующий формат: {field} {operator} {value}.
  • Во всех полях должен использоваться оператор EQUALS (=).

Поддерживаемые свойства:

  • adGroupId
  • displayName
  • entityStatus
  • lineItemId
  • adGroupFormat

Примеры:

  • Все группы объявлений в позиции: lineItemId="1234"
  • Все группы объявлений ENTITY_STATUS_ACTIVE или ENTITY_STATUS_PAUSED AD_GROUP_FORMAT_IN_STREAM, относящиеся к рекламодателю (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupFormat="AD_GROUP_FORMAT_IN_STREAM"

Длина этого поля не должна превышать 500 символов.

Подробную информацию вы найдете в руководстве по фильтрации запросов LIST.

Тело запроса

Тело запроса должно быть пустым.

Тело ответа

Ниже приведена структура данных в ответе, полученном на запрос.

JSON-представление 
{
  "adGroups": [
    {
      object (AdGroup)
    }
  ],
  "nextPageToken": string
}
Поля
adGroups[]

object (AdGroup)

Список групп объявлений.

Если список пуст, он не будет показан.
nextPageToken

string

Токен для загрузки следующей страницы результатов. Передайте это значение в поле pageToken в последующем вызове метода adGroups.list, чтобы получить следующую страницу результатов.

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/display-video

Дополнительную информацию вы найдете в OAuth 2.0 Overview.