Method: advertisers.creatives.list

Перечисляет креативы рекламодателя.

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

HTTP-запрос

GET https://displayvideo.googleapis.com/v1beta2/advertisers/{advertiserId}/creatives

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

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

Параметры
advertiserId

string ( int64 format)

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

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

Параметры
pageSize

integer

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

pageToken

string

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

orderBy

string

Поле, по которому сортируется список. Приемлемые значения:

  • creativeId (по умолчанию)
  • createTime
  • mediaDuration
  • dimensions (сначала сортировка по ширине, затем по высоте)

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

filter

string

Позволяет фильтровать по свойствам креатива.

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

  • Выражения фильтра состоят из одного или нескольких ограничений.
  • Ограничение для одного и того же поля должно быть объединено с помощью OR .
  • Ограничения для разных полей должны быть объединены оператором AND .
  • Между ( и ) могут быть только ограничения, объединенные оператором OR для одного и того же поля.
  • Ограничение имеет форму {field} {operator} {value} .
  • Оператор должен быть EQUALS (=) для следующих полей:
    • entityStatus
    • creativeType .
    • dimensions
    • minDuration
    • maxDuration
    • approvalStatus
    • exchangeReviewStatus
    • dynamic
    • creativeId
  • Оператор должен быть HAS (:) для следующих полей:
    • lineItemIds
  • Оператор должен быть GREATER THAN OR EQUAL TO (>=) или LESS THAN OR EQUAL TO (<=) для следующих полей:
    • updateTime (ввод в формате ISO 8601 или ГГГГ-ММ-ДДТЧЧ:ММ:ССЗ)
  • entityStatus , minDuration , maxDuration , updateTime и dynamic может быть не более одного ограничения.
  • Для dimensions значение имеет форму "{width}x{height}" .
  • Для exchangeReviewStatus значение имеет форму {exchange}-{reviewStatus} .
  • Для minDuration и maxDuration значение имеет форму "{duration}s" . Поддерживаются только секунды с миллисекундной детализацией.
  • Для updateTime значение поля креативного ресурса отражает время последнего обновления креатива, включая обновления, сделанные системой (например, обновления проверки креатива).
  • Может существовать несколько ограничений lineItemIds для поиска по нескольким возможным идентификаторам позиций.
  • Может существовать несколько ограничений creativeId для поиска по нескольким возможным идентификаторам объявлений.

Примеры:

  • Все нативные креативы: creativeType="CREATIVE_TYPE_NATIVE"
  • Все активные объявления размером 300 x 400 или 50 x 100: entityStatus="ENTITY_STATUS_ACTIVE" AND (dimensions="300x400" OR dimensions="50x100")
  • Все динамические креативы, одобренные AdX или AppNexus, с минимальной продолжительностью 5 секунд и 200 мс. dynamic="true" AND minDuration="5.2s" AND (exchangeReviewStatus="EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED" OR exchangeReviewStatus="EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED")
  • Все видеообъявления, связанные с идентификатором позиции 1 или 2: creativeType="CREATIVE_TYPE_VIDEO" AND (lineItemIds:1 OR lineItemIds:2)
  • Найдите креативы по нескольким идентификаторам: creativeId=1 OR creativeId=2

  • Все объявления со временем обновления, большим или равным 2020-11-04T18:54:47Z (format of ISO 8601) : updateTime>="2020-11-04T18:54:47Z" Длина этого поля не должна превышать более 500 символов.

Тело запроса

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

Тело ответа

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

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

object ( Creative )

Список креативов.

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

nextPageToken

string

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

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

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

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

Дополнительную информацию см. в обзоре OAuth 2.0 .