Method: advertisers.creatives.list

Возвращает список креативов рекламодателя.

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

HTTP-запрос

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

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

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

Параметры
advertiserId

string (int64 format)

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

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

Параметры
pageSize

integer

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

string

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

string

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

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

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

string

Позволяет фильтровать данные по полям креативов.

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

  • Выражения фильтров состоят из одного или нескольких ограничений.
  • Ограничения можно комбинировать с помощью логических операторов AND или OR. В последовательности ограничений неявно используется AND.
  • Ограничение имеет следующий формат: {field} {operator} {value}.
  • В поле lineItemIds должен использоваться оператор HAS (:).
  • В поле updateTime необходимо использовать операторы GREATER THAN OR EQUAL TO (>=) или LESS THAN OR EQUAL TO (<=).
  • Для всех остальных полей необходимо использовать оператор EQUALS (=).
  • Для полей entityStatus, minDuration, maxDuration, updateTime и dynamic можно задать не более одного ограничения.

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

  • approvalStatus
  • creativeId
  • creativeType
  • dimensions (в формате {width}x{height})
  • dynamic
  • entityStatus
  • exchangeReviewStatus (в формате {exchange}-{reviewStatus})
  • lineItemIds
  • maxDuration (введите в формате {duration}s. Поддерживаются только секунды.
  • minDuration (введите в формате {duration}s. Поддерживаются только секунды.
  • updateTime (в формате ISO 8601 или YYYY-MM-DDTHH:MM:SSZ)

Примечания:

  • В updateTime значение поля ресурса креатива отражает время последнего обновления креатива, включая обновления, выполненные системой (например, обновления проверки креатива).

Примеры:

  • Все нативные креативы: 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 (формат ISO 8601): updateTime>="2020-11-04T18:54:47Z"

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

Подробную информацию вы найдете в руководстве по фильтрации запросов LIST.

Тело запроса

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

Тело ответа

Ниже приведена структура данных в ответе, полученном на запрос.

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

object (Creative)

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

Если список пуст, он не будет показан.
nextPageToken

string

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

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

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

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

Дополнительную информацию вы найдете в OAuth 2.0 Overview.