Method: advertisers.adGroups.list

Перечисляет группы объявлений.

HTTP-запрос

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

URL-адрес использует синтаксис транскодирования gRPC .

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

Параметры
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 .