Method: advertisers.campaigns.list

• HTTP-запрос
• Параметры пути
• Параметры запроса
• Тело запроса
• Тело ответа
  • JSON-представление
• Области авторизации
• Попробуйте!

Перечисляет кампании рекламодателя.

Порядок определяется параметром orderBy . Если filter entityStatus не указан, кампании с ENTITY_STATUS_ARCHIVED не будут включены в результаты.

HTTP-запрос

GET https://displayvideo.googleapis.com/v4/advertisers/{advertiserId}/campaigns

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

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

Параметры
advertiserId	string ( int64 format) Идентификатор рекламодателя, для которого требуется составить список кампаний.

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

Параметры
pageSize	integer Запрошенный размер страницы. Должно быть от 1 до 200 . Если не указано, по умолчанию будет 100 .
pageToken	string Токен, идентифицирующий страницу результатов, которую должен вернуть сервер. Обычно это значение nextPageToken возвращенное в результате предыдущего вызова метода campaigns.list . Если не указано, будет возвращена первая страница результатов.
orderBy	string Поле, по которому сортируется список. Приемлемые значения: displayName (по умолчанию) entityStatus updateTime По умолчанию порядок сортировки — по возрастанию. Чтобы указать порядок убывания поля, к имени поля следует добавить суффикс «desc». Пример: displayName desc .
filter	string Позволяет фильтровать по полям кампании. Поддерживаемый синтаксис: Выражения фильтра состоят из одного или нескольких ограничений. Ограничения могут объединяться логическими операторами AND или OR . Последовательность ограничений неявно использует AND . Ограничение имеет форму {field} {operator} {value} . Поле updateTime должно использовать операторы GREATER THAN OR EQUAL TO (>=) или LESS THAN OR EQUAL TO (<=) . Во всех остальных полях должен использоваться оператор EQUALS (=) . Поддерживаемые поля: campaignId displayName entityStatus updateTime (ввод в формате ISO 8601 или YYYY-MM-DDTHH:MM:SSZ ) Примеры: Все кампании ENTITY_STATUS_ACTIVE или ENTITY_STATUS_PAUSED от рекламодателя: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") Все кампании со временем обновления, меньшим или равным 2020-11-04T18:54:47Z (формат ISO 8601): updateTime<="2020-11-04T18:54:47Z" Все кампании со временем обновления, большим или равным 2020-11-04T18:54:47Z (формат ISO 8601): updateTime>="2020-11-04T18:54:47Z" Длина этого поля не должна превышать 500 символов. Для получения дополнительной информации обратитесь к нашему руководству по запросам фильтров LIST .

Тело запроса

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

Тело ответа

В случае успеха тело ответа содержит данные следующей структуры:

JSON-представление
{ "campaigns": [ { object (Campaign) } ], "nextPageToken": string }

Поля
campaigns[]	object ( Campaign ) Список кампаний. Этот список будет отсутствовать, если он пуст.
nextPageToken	string Токен для получения следующей страницы результатов. Передайте это значение в поле pageToken при последующем вызове метода campaigns.list , чтобы получить следующую страницу результатов.

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

Требуется одна из следующих областей OAuth:

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

Для получения дополнительной информации см.OAuth 2.0 Overview .