Method: advertisers.adGroupAds.list

Отображает списки объявлений из групп.

HTTP-запрос

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

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

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

Параметры
advertiserId

string ( int64 format)

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

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

Параметры
pageSize

integer

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

pageToken

string

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

orderBy

string

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

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

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

filter

string

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

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

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

Поддерживаемые поля:

  • adGroupId
  • displayName
  • entityStatus
  • adGroupAdId

Примеры:

  • Все объявления в рамках группы объявлений: adGroupId="1234"
  • Все объявления в группе объявлений, находящиеся в рамках группы объявлений с entityStatus равным ENTITY_STATUS_ACTIVE или ENTITY_STATUS_PAUSED : (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupId="12345"

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

Для получения более подробной информации обратитесь к нашему руководству по фильтрации запросов в LIST .

Текст запроса

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

Ответный текст

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

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

object ( AdGroupAd )

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

Этот список будет отсутствовать, если он пуст.

nextPageToken

string

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

Области полномочий

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

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

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