Method: advertisers.adGroupAds.list

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

HTTP-запрос

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

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

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

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

Примеры:

  • Все объявления в группе объявлений: adGroupId="1234"
  • Все объявления в группе объявлений со статусом entityStatus ENTITY_STATUS_ACTIVE или ENTITY_STATUS_PAUSED: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupId="12345"
  • Все объявления группы объявлений, относящиеся к родительскому креативу: parentCreativeId="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.