REST Resource: advertisers.creatives

Ресурс: Креатив

Один креатив.

JSON-представление 
{
  "name": string,
  "advertiserId": string,
  "creativeId": string,
  "cmPlacementId": string,
  "displayName": string,
  "entityStatus": enum (EntityStatus),
  "updateTime": string,
  "createTime": string,
  "creativeType": enum (CreativeType),
  "hostingSource": enum (HostingSource),
  "dynamic": boolean,
  "dimensions": {
    object (Dimensions)
  },
  "additionalDimensions": [
    {
      object (Dimensions)
    }
  ],
  "mediaDuration": string,
  "creativeAttributes": [
    enum (CreativeAttribute)
  ],
  "reviewStatus": {
    object (ReviewStatusInfo)
  },
  "assets": [
    {
      object (AssetAssociation)
    }
  ],
  "exitEvents": [
    {
      object (ExitEvent)
    }
  ],
  "timerEvents": [
    {
      object (TimerEvent)
    }
  ],
  "counterEvents": [
    {
      object (CounterEvent)
    }
  ],
  "appendedTag": string,
  "integrationCode": string,
  "notes": string,
  "iasCampaignMonitoring": boolean,
  "companionCreativeIds": [
    string
  ],
  "skippable": boolean,
  "skipOffset": {
    object (AudioVideoOffset)
  },
  "progressOffset": {
    object (AudioVideoOffset)
  },
  "universalAdId": {
    object (UniversalAdId)
  },
  "thirdPartyUrls": [
    {
      object (ThirdPartyUrl)
    }
  ],
  "transcodes": [
    {
      object (Transcode)
    }
  ],
  "trackerUrls": [
    string
  ],
  "jsTrackerUrl": string,
  "cmTrackingAd": {
    object (CmTrackingAd)
  },
  "obaIcon": {
    object (ObaIcon)
  },
  "thirdPartyTag": string,
  "requireMraid": boolean,
  "requireHtml5": boolean,
  "requirePingForAttribution": boolean,
  "expandingDirection": enum (ExpandingDirection),
  "expandOnHover": boolean,
  "vastTagUrl": string,
  "vpaid": boolean,
  "html5Video": boolean,
  "lineItemIds": [
    string
  ],
  "mp3Audio": boolean,
  "oggAudio": boolean
}
Поля
name

string

Только вывод. Имя ресурса креатива.

advertiserId

string ( int64 format)

Только вывод. Уникальный идентификатор рекламодателя, которому принадлежит креатив.

creativeId

string ( int64 format)

Только вывод. Уникальный идентификатор креатива. Назначается системой.

cmPlacementId

string ( int64 format)

Только вывод. Уникальный идентификатор места размещения в Менеджере кампаний 360, связанного с креативом. Это поле применимо только к креативам, синхронизированным из Менеджера кампаний.

displayName

string

Обязательно. Отображаемое имя креатива.

Должен быть в кодировке UTF-8 с максимальным размером 240 байт.

entityStatus

enum ( EntityStatus )

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

Принятые значения:

  • ENTITY_STATUS_ACTIVE
  • ENTITY_STATUS_ARCHIVED
  • ENTITY_STATUS_PAUSED
updateTime

string ( Timestamp format)

Только вывод. Временная метка последнего обновления креатива пользователем или системой (например, обзор креатива). Назначается системой.

Использует RFC 3339, согласно которому сгенерированный вывод всегда будет нормализован по оси Z и содержать 0, 3, 6 или 9 знаков после запятой. Также допускаются смещения, отличные от «Z». Примеры: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30" .

createTime

string ( Timestamp format)

Только вывод. Временная метка создания креатива. Присваивается системой.

Использует RFC 3339, согласно которому сгенерированный вывод всегда будет нормализован по оси Z и содержать 0, 3, 6 или 9 знаков после запятой. Также допускаются смещения, отличные от «Z». Примеры: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30" .

creativeType

enum ( CreativeType )

Обязательно. Неизменяемо. Тип креатива.

hostingSource

enum ( HostingSource )

Обязательно. Указывает, где размещено объявление.

dynamic

boolean

Только вывод. Указывает, является ли креатив динамическим.

dimensions

object ( Dimensions )

Обязательно. Основные размеры креатива. Применимо ко всем типам креативов. Значение widthPixels и heightPixels по умолчанию равно 0 , если creativeType принимает одно из следующих значений:

  • CREATIVE_TYPE_VIDEO
  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_NATIVE_VIDEO
additionalDimensions[]

object ( Dimensions )

Необязательно. Дополнительные параметры. Применимо, если creativeType — один из следующих:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_EXPANDABLE
  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_LIGHTBOX
  • CREATIVE_TYPE_PUBLISHER_HOSTED

Если это поле указано, то widthPixels и heightPixels являются обязательными и должны быть больше или равны 0.

mediaDuration

string ( Duration format)

Только вывод. Длительность показа креатива. Применимо, если creativeType имеет одно из следующих значений:

  • CREATIVE_TYPE_VIDEO
  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_NATIVE_VIDEO
  • CREATIVE_TYPE_PUBLISHER_HOSTED

Длительность в секундах, содержащая до девяти знаков после запятой, заканчивается на « s ». Пример: "3.5s" .

creativeAttributes[]

enum ( CreativeAttribute )

Только вывод. Список атрибутов креатива, сгенерированный системой.

reviewStatus

object ( ReviewStatusInfo )

Только вывод. Текущий статус процесса творческого обзора.

assets[]

object ( AssetAssociation )

Обязательно. Ресурсы, связанные с этим креативом.

exitEvents[]

object ( ExitEvent )

Обязательно. События выхода для этого креатива. Выход (также известный как тег клика) — это любая область вашего креатива, на которую можно нажать или нажать, чтобы открыть целевую страницу рекламодателя. Каждый креатив должен включать хотя бы один выход. Вы можете добавить выход в свой креатив одним из следующих способов:

  • Используйте сенсорную область Google Web Designer.
  • Определите переменную JavaScript с именем «clickTag».
  • Используйте Enabler (Enabler.exit()) для отслеживания выходов в форматах Rich Media.
timerEvents[]

object ( TimerEvent )

Необязательно. Пользовательские события таймера для мультимедийного креатива. Таймеры отслеживают время, в течение которого пользователь просматривает и взаимодействует с определённой частью мультимедийного креатива. Креатив может иметь несколько событий таймера, каждое из которых отсчитывается независимо. Оставьте это поле пустым или ненастроенным для креативов, содержащих только изображения.

counterEvents[]

object ( CounterEvent )

Необязательно. События счётчика для креатива Rich Media. Счётчики отслеживают количество взаимодействий пользователя с любой частью креатива Rich Media определённым образом (наведение и отвод курсора, щелчки, нажатия, загрузка данных, ввод с клавиатуры и т. д.). Любое событие, которое может быть зарегистрировано в креативе, можно записать как счётчик. Оставьте это поле пустым или неактивным только для креативов, содержащих изображения.

appendedTag

string

Необязательно. К тегу креатива можно добавить сторонний HTML-тег отслеживания.

integrationCode

string

Необязательно. Идентификатор, используемый для связи этого креатива с внешней системой. Должен быть в кодировке UTF-8 и иметь длину не более 10 000 символов.

notes

string

Необязательно. Пользовательские заметки для этого креатива. Должны быть в кодировке UTF-8 и длиной не более 20 000 символов.

iasCampaignMonitoring

boolean

Необязательно. Указывает, включен ли мониторинг кампании Integral Ad Science (IAS). Чтобы включить его для креатива, убедитесь, что в параметре Advertiser.creative_config.ias_client_id указан ваш идентификатор клиента IAS.

companionCreativeIds[]

string ( int64 format)

Необязательно. Идентификаторы сопутствующих креативов для видеокреатива.

Вы можете назначить существующие медийные креативы (с изображениями или HTML5-ресурсами) для показа вокруг видеоплеера издателя. Сопутствующие креативы отображаются вокруг видеоплеера во время воспроизведения видео и остаются после его завершения.

Креативы, содержащие additional dimensions не могут быть сопутствующими креативами.

Это поле поддерживается только для следующего creativeType :

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_VIDEO
skippable

boolean

Необязательно. Может ли пользователь пропустить видеорекламу.

Это поле поддерживается только для следующего creativeType :

  • CREATIVE_TYPE_VIDEO
skipOffset

object ( AudioVideoOffset )

Необязательно. Время воспроизведения видео до появления кнопки «Пропустить».

Это поле обязательно для заполнения, если skippable установлено значение true.

Это поле поддерживается только для следующего creativeType :

  • CREATIVE_TYPE_VIDEO
progressOffset

object ( AudioVideoOffset )

Необязательно. Время воспроизведения видео до зачёта просмотра.

Это поле обязательно для заполнения, если skippable установлено значение true.

Это поле поддерживается только для следующего creativeType :

  • CREATIVE_TYPE_VIDEO
universalAdId

object ( UniversalAdId )

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

Универсальный идентификатор объявления является частью стандарта VAST 4.0. Его можно изменить после создания креатива.

Это поле поддерживается только для следующего creativeType :

  • CREATIVE_TYPE_VIDEO
thirdPartyUrls[]

object ( ThirdPartyUrl )

Необязательно. URL-адреса третьих лиц для отслеживания взаимодействия с видеорекламой.

Это поле поддерживается только для следующего creativeType :

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_VIDEO
  • CREATIVE_TYPE_NATIVE_VIDEO
transcodes[]

object ( Transcode )

Только вывод. Перекодирование аудио/видео.

Display & Video 360 перекодирует основной ресурс в ряд альтернативных версий, которые используют разные форматы файлов или имеют разные свойства (разрешение, скорость передачи аудио и видео), каждая из которых предназначена для определенных видеоплееров или пропускной способности.

Эти перекодировки предоставляют системе издателя больше возможностей выбора для каждого показа вашего видео и гарантируют показ соответствующего файла в зависимости от подключения и размера экрана зрителя.

Это поле поддерживается только в следующем creativeType :

  • CREATIVE_TYPE_VIDEO
  • CREATIVE_TYPE_NATIVE_VIDEO
  • CREATIVE_TYPE_AUDIO
trackerUrls[]

string

Необязательно. URL-адреса отслеживания для поставщиков аналитических услуг или сторонних поставщиков рекламных технологий.

URL-адреса должны начинаться с https: (за исключением инвентаря, не требующего SSL-поддержки). При использовании макросов в URL-адресе используйте только макросы, поддерживаемые Display & Video 360.

Только стандартные URL-адреса, без тегов IMG или SCRIPT.

Это поле доступно для записи только в следующем creativeType :

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
jsTrackerUrl

string

Необязательно. URL-адрес измерения JavaScript от поддерживаемых сторонних поставщиков услуг проверки (ComScore, DoubleVerify, IAS, Moat). Теги HTML-скриптов не поддерживаются.

Это поле доступно для записи только в следующем creativeType :

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
cmTrackingAd

object ( CmTrackingAd )

Необязательно. Отслеживающее объявление Менеджера кампаний 360, связанное с креативом.

Необязательно для следующего creativeType , если он создан рекламодателем, использующим как Campaign Manager 360, так и сторонний сервис показа рекламы:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE

Выводить только для остальных случаев.

obaIcon

object ( ObaIcon )

Необязательно. Указывает значок поведенческой рекламы для видеорекламы.

Это поле поддерживается только в следующем creativeType :

  • CREATIVE_TYPE_VIDEO
thirdPartyTag

string

Необязательно. Оригинальный сторонний тег, используемый для креатива.

Обязательно и действительно только для сторонних тегов.

Сторонние теги креативов — это креативы со следующими hostingSource :

  • HOSTING_SOURCE_THIRD_PARTY

в сочетании со следующим creativeType :

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_EXPANDABLE
requireMraid

boolean

Необязательно. Указывает, что для креатива требуется MRAID (система определений интерфейса мобильной мультимедийной рекламы).

Установите этот параметр, если для интерактивности креатива используются жесты мобильного устройства, например смахивание или нажатие.

Необязательно и действительно только для сторонних тегов.

Сторонние теги креативов — это креативы со следующими hostingSource :

  • HOSTING_SOURCE_THIRD_PARTY

в сочетании со следующим creativeType :

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_EXPANDABLE
requireHtml5

boolean

Необязательно. Указывает, что для корректной отрисовки креатива требуется HTML5.

Необязательно и действительно только для сторонних тегов. Сторонние теги — это креативы со следующими параметрами hostingSource :

  • HOSTING_SOURCE_THIRD_PARTY

в сочетании со следующим creativeType :

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_EXPANDABLE
requirePingForAttribution

boolean

Необязательно. Указывает, что креатив будет ожидать ответного пинга для атрибуции.

Действительно только при использовании отслеживающей рекламы Campaign Manager 360 с параметром стороннего сервера рекламы и макросом ${DC_DBM_TOKEN}.

Необязательно и действительно только для сторонних тегов или сторонних тегов VAST.

Сторонние теги креативов — это креативы со следующими hostingSource :

  • HOSTING_SOURCE_THIRD_PARTY

в сочетании со следующим creativeType :

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_EXPANDABLE

Сторонние креативы VAST-тегов — это креативы со следующими hostingSource :

  • HOSTING_SOURCE_THIRD_PARTY

в сочетании со следующим creativeType :

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_VIDEO
expandingDirection

enum ( ExpandingDirection )

Необязательно. Указывает направление расширения креатива.

Обязательно и действительно только для сторонних расширяемых объявлений.

Сторонние расширяемые креативы — это креативы со следующим источником хостинга:

  • HOSTING_SOURCE_THIRD_PARTY

в сочетании со следующим creativeType :

  • CREATIVE_TYPE_EXPANDABLE
expandOnHover

boolean

Необязательно. Указывает, что объявление будет автоматически раскрываться при наведении курсора.

Необязательно и действительно только для сторонних расширяемых креативов. Сторонние расширяемые креативы — это креативы со следующим источником хостинга:

  • HOSTING_SOURCE_THIRD_PARTY

в сочетании со следующим creativeType :

  • CREATIVE_TYPE_EXPANDABLE
vastTagUrl

string

Необязательно. URL-адрес тега VAST для стороннего креатива тега VAST.

Обязательно и действительно только для сторонних креативов VAST-тегов.

Сторонние креативы VAST-тегов — это креативы со следующими hostingSource :

  • HOSTING_SOURCE_THIRD_PARTY

в сочетании со следующим creativeType :

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_VIDEO
vpaid

boolean

Только вывод. Указывает, что для стороннего тега VAST требуется VPAID (интерфейс цифрового видеоплеера и рекламы).

Только вывод и действительно только для сторонних креативов VAST-тегов.

Сторонние креативы VAST-тегов — это креативы со следующими hostingSource :

  • HOSTING_SOURCE_THIRD_PARTY

в сочетании со следующим creativeType :

  • CREATIVE_TYPE_VIDEO
html5Video

boolean

Только вывод. Указывает, что для стороннего тега VAST требуется поддержка HTML5 Video.

Только вывод и действительно только для сторонних креативов VAST-тегов.

Сторонние креативы VAST-тегов — это креативы со следующими hostingSource :

  • HOSTING_SOURCE_THIRD_PARTY

в сочетании со следующим creativeType :

  • CREATIVE_TYPE_VIDEO
lineItemIds[]

string ( int64 format)

Только вывод. Идентификаторы позиций, с которыми связан этот креатив.

Чтобы связать креатив с позицией, используйте вместо этого LineItem.creative_ids .

mp3Audio

boolean

Только вывод. Указывает, что сторонний аудиокреатив поддерживает формат MP3.

Только вывод и действительно только для сторонних аудиообъявлений.

Сторонние аудиообъявления — это объявления со следующими hostingSource :

  • HOSTING_SOURCE_THIRD_PARTY

в сочетании со следующим creativeType :

  • CREATIVE_TYPE_AUDIO
oggAudio

boolean

Только вывод. Указывает, что сторонний аудиокреатив поддерживает формат OGG.

Только вывод и действительно только для сторонних аудиообъявлений.

Сторонние аудиообъявления — это объявления со следующими hostingSource :

  • HOSTING_SOURCE_THIRD_PARTY

в сочетании со следующим creativeType :

  • CREATIVE_TYPE_AUDIO

HostingSource

Возможные источники размещения креатива. Указывает, где креатив создается и размещается.

Перечисления
HOSTING_SOURCE_UNSPECIFIED В данной версии источник хостинга не указан или неизвестен.
HOSTING_SOURCE_CM

Креатив, синхронизированный из Campaign Manager 360.

Методы создания и обновления не поддерживаются для этого типа хостинга.

HOSTING_SOURCE_THIRD_PARTY

Креатив, размещенный на стороннем рекламном сервере (3PAS).

Методы создания и обновления поддерживаются для этого типа хостинга, если creativeType является одним из следующих:

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_EXPANDABLE
  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO
HOSTING_SOURCE_HOSTED

Креатив, созданный в DV360 и размещенный в Campaign Manager 360.

Методы создания и обновления поддерживаются для этого типа хостинга, если creativeType является одним из следующих:

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO
HOSTING_SOURCE_RICH_MEDIA

Мультимедийный креатив, созданный в Studio и размещенный в Campaign Manager 360.

Методы создания и обновления не поддерживаются для этого типа хостинга.

CreativeAttribute

Возможные атрибуты креатива.

Перечисления
CREATIVE_ATTRIBUTE_UNSPECIFIED В этой версии атрибут creative не указан или неизвестен.
CREATIVE_ATTRIBUTE_VAST Это креатив VAST.
CREATIVE_ATTRIBUTE_VPAID_LINEAR Креатив представляет собой линейный креатив VPAID.
CREATIVE_ATTRIBUTE_VPAID_NON_LINEAR Креатив представляет собой нелинейный креатив VPAID.

ОбзорСтатусИнформация

Проверьте статусы креатива.

JSON-представление 
{
  "approvalStatus": enum (ApprovalStatus),
  "creativeAndLandingPageReviewStatus": enum (ReviewStatus),
  "contentAndPolicyReviewStatus": enum (ReviewStatus),
  "exchangeReviewStatuses": [
    {
      object (ExchangeReviewStatus)
    }
  ]
}
Поля
approvalStatus

enum ( ApprovalStatus )

Представляет собой базовое одобрение, необходимое для начала показа креатива. Сводка по creativeAndLandingPageReviewStatus и contentAndPolicyReviewStatus .

creativeAndLandingPageReviewStatus

enum ( ReviewStatus )

Статус проверки креатива и целевой страницы.

contentAndPolicyReviewStatus

enum ( ReviewStatus )

Статус проверки содержания и политики для креатива.

exchangeReviewStatuses[]

object ( ExchangeReviewStatus )

Обмен статусами обзоров для креатива.

Статус утверждения

Возможные типы статуса одобрения. Это сумма creativeAndLandingPageReviewStatus и contentAndPolicyReviewStatus .

Перечисления
APPROVAL_STATUS_UNSPECIFIED Значение типа не указано или неизвестно в данной версии.
APPROVAL_STATUS_PENDING_NOT_SERVABLE Креатив все еще находится на рассмотрении и не может быть показан.
APPROVAL_STATUS_PENDING_SERVABLE Креатив прошел проверку креатива и целевой страницы и готов к показу, но ожидает дополнительной проверки контента и политики.
APPROVAL_STATUS_APPROVED_SERVABLE Проверка креатива и целевой страницы, а также проверка контента и политики одобрены. Креатив готов к показу.
APPROVAL_STATUS_REJECTED_NOT_SERVABLE В креативе есть проблема, которую необходимо устранить перед его показом.

Статус обзора

Возможные типы статуса обзора.

Перечисления
REVIEW_STATUS_UNSPECIFIED Значение типа не указано или неизвестно в данной версии.
REVIEW_STATUS_APPROVED Креатив одобрен.
REVIEW_STATUS_REJECTED Креатив отклонен.
REVIEW_STATUS_PENDING Креатив ожидает рассмотрения.

ExchangeReviewStatus

Обмен статусом обзора для креатива.

JSON-представление 
{
  "exchange": enum (Exchange),
  "status": enum (ReviewStatus)
}
Поля
exchange

enum ( Exchange )

Обзор креатива на бирже.

status

enum ( ReviewStatus )

Статус обзора обмена.

Ассоциация активов

Ассоциация активов для креатива.

JSON-представление 
{
  "asset": {
    object (Asset)
  },
  "role": enum (AssetRole)
}
Поля
asset

object ( Asset )

Необязательно. Связанный актив.

role

enum ( AssetRole )

Необязательно. Роль этого актива в креативе.

Объект

Единый актив.

JSON-представление 
{
  "mediaId": string,
  "content": string
}
Поля
mediaId

string ( int64 format)

Идентификатор медиа загруженного ресурса. Это уникальный идентификатор ресурса. Этот идентификатор можно передавать в другие вызовы API, например, creatives.create , чтобы связать ресурс с креативом.

Раздел Media ID обновлен 5 апреля 2023 г. Обновите идентификаторы медиа, кэшированные до 5 апреля 2023 г., получив новый идентификатор медиа из связанных креативных ресурсов или повторно загрузив актив.

content

string

Содержимое ресурса. Для загруженных ресурсов контент — это путь к сервису.

AssetRole

Роль этого актива для креатива.

Перечисления
ASSET_ROLE_UNSPECIFIED Роль актива в этой версии не указана или неизвестна.
ASSET_ROLE_MAIN Актив — это основной актив креатива.
ASSET_ROLE_BACKUP Ресурс является резервным ресурсом креатива.
ASSET_ROLE_POLITE_LOAD Актив представляет собой актив вежливой загрузки креатива.
ASSET_ROLE_HEADLINE

Заголовок нативного креатива.

content должно быть в кодировке UTF-8 и иметь длину не более 25 символов.

Эта роль поддерживается только в следующем creativeType :

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_LONG_HEADLINE

Длинный заголовок нативного креатива.

content должно быть в кодировке UTF-8 и иметь длину не более 50 символов.

Эта роль поддерживается только в следующем creativeType :

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_BODY

Основной текст нативного креатива.

content должно быть в кодировке UTF-8 и иметь длину не более 90 символов.

Эта роль поддерживается только в следующем creativeType :

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_LONG_BODY

Длинный текст нативного креатива.

content должно быть в кодировке UTF-8 и иметь длину не более 150 символов.

Эта роль поддерживается только в следующем creativeType :

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_CAPTION_URL

Короткая и понятная версия URL-адреса целевой страницы для отображения в креативе. Этот URL даёт пользователям представление о том, куда они попадут после нажатия на креатив.

content должно быть в кодировке UTF-8 и иметь длину не более 30 символов.

Например, если URL целевой страницы — «http://www.example.com/page», URL-адрес подписи может быть «example.com». Протокол (http://) указывать необязательно, но URL-адрес не должен содержать пробелы и специальные символы.

Эта роль поддерживается только в следующем creativeType :

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_CALL_TO_ACTION

Текст, который будет использоваться на кнопке призыва к действию в нативном креативе.

content должно быть в кодировке UTF-8 и иметь длину не более 15 символов.

Эта роль поддерживается только в следующем creativeType :

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_ADVERTISER_NAME

Текст, идентифицирующий рекламодателя или название бренда.

content должно быть в кодировке UTF-8 и иметь длину не более 25 символов.

Эта роль поддерживается только в следующем creativeType :

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_PRICE

Цена покупки вашего приложения в магазине Google Play или магазине приложений iOS (например, 5,99 долл. США).

Обратите внимание, что это значение не синхронизируется автоматически с фактическим значением, указанным в магазине. Оно всегда будет соответствовать значению, указанному при сохранении креатива.

content должно быть в кодировке UTF-8 и иметь длину не более 15 символов.

Активы этой роли доступны только для чтения.

ASSET_ROLE_ANDROID_APP_ID

Идентификатор приложения Android в магазине Google Play.

Этот идентификатор можно найти в URL-адресе приложения в Google Play после слова «id». Например, в https://play.google.com/store/apps/details?id=com.company.appname идентификатор — com.company.appname.

Активы этой роли доступны только для чтения.

ASSET_ROLE_IOS_APP_ID

Идентификатор приложения iOS в магазине приложений Apple.

Этот идентификатор можно найти в URL-адресе Apple App Store как последовательность цифр сразу после слова «id». Например, в https://apps.apple.com/us/app/gmail-email-by-google/id422689480 идентификатор — 422689480.

Активы этой роли доступны только для чтения.

ASSET_ROLE_RATING

Рейтинг приложения в магазине Google Play или магазине приложений iOS.

Обратите внимание, что это значение не синхронизируется автоматически с реальным рейтингом в магазине. Оно всегда будет соответствовать рейтингу, указанному при сохранении креатива.

Активы этой роли доступны только для чтения.

ASSET_ROLE_ICON

Икона креатива.

Эта роль поддерживается и требуется только в следующем creativeType :

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
ASSET_ROLE_COVER_IMAGE

Изображение обложки нативного видеокреатива.

Эта роль поддерживается и требуется только в следующем creativeType :

  • CREATIVE_TYPE_VIDEO
ASSET_ROLE_BACKGROUND_COLOR

Основной цвет для использования в креативе.

Эта роль поддерживается и требуется только в следующем creativeType :

  • CREATIVE_TYPE_ASSET_BASED_CREATIVE
ASSET_ROLE_ACCENT_COLOR

Акцентный цвет для использования в креативе.

Эта роль поддерживается и требуется только в следующем creativeType :

  • CREATIVE_TYPE_ASSET_BASED_CREATIVE
ASSET_ROLE_REQUIRE_IMAGE

Должен ли креатив использовать изображение.

Эта роль поддерживается и требуется только в следующем creativeType :

  • CREATIVE_TYPE_ASSET_BASED_CREATIVE
ASSET_ROLE_ENABLE_ASSET_ENHANCEMENTS

Можно ли применять улучшения активов к креативу.

Эта роль поддерживается и требуется только в следующем creativeType :

  • CREATIVE_TYPE_ASSET_BASED_CREATIVE

ExitEvent

Событие выхода из креатива.

JSON-представление 
{
  "type": enum (ExitEventType),
  "url": string,
  "name": string,
  "reportingName": string
}
Поля
type

enum ( ExitEventType )

Обязательно. Тип события выхода.

url

string

Обязательно. URL-адрес перехода по клику для события выхода. Требуется, если type :

  • EXIT_EVENT_TYPE_DEFAULT
  • EXIT_EVENT_TYPE_BACKUP
name

string

Необязательно. Имя тега клика события выхода.

Имя должно быть уникальным в пределах одного креатива.

Оставьте это поле пустым или ненастроенным только для креативов, содержащих изображения.

reportingName

string

Необязательно. Имя, используемое для идентификации этого события в отчётах. Оставьте это поле пустым или не заданным для креативов, содержащих только изображения.

ExitEventType

Тип события выхода.

Перечисления
EXIT_EVENT_TYPE_UNSPECIFIED Тип события выхода в этой версии не указан или неизвестен.
EXIT_EVENT_TYPE_DEFAULT Событие выхода является событием по умолчанию.
EXIT_EVENT_TYPE_BACKUP Событие выхода — это резервное событие выхода. В креативе может быть несколько резервных событий выхода.

TimerEvent

Событие таймера креатива.

JSON-представление 
{
  "name": string,
  "reportingName": string
}
Поля
name

string

Обязательно. Имя события таймера.

reportingName

string

Обязательно. Имя, используемое для идентификации этого события таймера в отчётах.

CounterEvent

Встречное событие креатива.

JSON-представление 
{
  "name": string,
  "reportingName": string
}
Поля
name

string

Обязательно. Имя события-счётчика.

reportingName

string

Обязательно. Имя, используемое для идентификации этого события счётчика в отчётах.

АудиоВидеоСмещение

Продолжительность воспроизведения аудио- или видеофайла.

JSON-представление 
{

  // Union field offset can be only one of the following:
  "percentage": string,
  "seconds": string
  // End of list of possible types for union field offset.
}
Поля
offset поля объединения. Значение offset может быть только одним из следующих:
percentage

string ( int64 format)

Необязательно. Смещение в процентах от длительности аудио- или видеофайла.

seconds

string ( int64 format)

Необязательно. Смещение в секундах от начала аудио- или видеофайла.

UniversalAdId

Креативный идентификатор, предоставляемый реестром и уникальный для всех платформ. Является частью стандарта VAST 4.0.

JSON-представление 
{
  "id": string,
  "registry": enum (UniversalAdRegistry)
}
Поля
id

string

Необязательно. Уникальный идентификатор креатива.

registry

enum ( UniversalAdRegistry )

Необязательно. Реестр предоставляет уникальные идентификаторы креативов.

UniversalAdRegistry

Реестр предоставляет уникальные идентификаторы креативов в универсальном идентификаторе рекламы.

Перечисления
UNIVERSAL_AD_REGISTRY_UNSPECIFIED Реестр Universal Ad в этой версии не указан или неизвестен.
UNIVERSAL_AD_REGISTRY_OTHER Используйте пользовательского провайдера для предоставления универсального идентификатора рекламы.
UNIVERSAL_AD_REGISTRY_AD_ID Используйте Ad-ID для предоставления универсального рекламного идентификатора.
UNIVERSAL_AD_REGISTRY_CLEARCAST Используйте clearcast.co.uk для предоставления универсального рекламного идентификатора.
UNIVERSAL_AD_REGISTRY_DV360 Используйте Display & Video 360 для предоставления универсального идентификатора рекламы.
UNIVERSAL_AD_REGISTRY_CM Используйте Campaign Manager 360 для предоставления универсального идентификатора объявления.

ThirdPartyUrl

Отслеживание URL-адресов третьих лиц для отслеживания взаимодействий с аудио- или видеорекламой.

JSON-представление 
{
  "type": enum (ThirdPartyUrlType),
  "url": string
}
Поля
type

enum ( ThirdPartyUrlType )

Необязательно. Тип взаимодействия должен отслеживаться по URL-адресу отслеживания.

url

string

Необязательно. URL-адрес отслеживания, используемый для отслеживания взаимодействия.

Укажите URL-адрес с необязательным путём или строкой запроса, начинающейся с https: Например, https://www.example.com/path

ThirdPartyUrlType

Тип взаимодействия должен отслеживаться с помощью стороннего URL-адреса отслеживания.

Перечисления
THIRD_PARTY_URL_TYPE_UNSPECIFIED Тип стороннего URL-адреса в этой версии не указан или неизвестен.
THIRD_PARTY_URL_TYPE_IMPRESSION Используется для подсчета показов креатива после завершения буферизации аудио или видео.
THIRD_PARTY_URL_TYPE_CLICK_TRACKING Используется для отслеживания нажатий пользователем на аудио или видео.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_START Используется для отслеживания количества запусков пользователем аудио или видео.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_FIRST_QUARTILE Используется для отслеживания количества воспроизведений аудио- или видеофайла до 25% его продолжительности.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_MIDPOINT Используется для отслеживания количества воспроизведений аудио- или видеофайла до 50% его длительности.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_THIRD_QUARTILE Используется для отслеживания количества воспроизведений аудио- или видеофайла до 75% его длительности.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_COMPLETE Используется для отслеживания количества воспроизведений аудио- или видеофайла до конца.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_MUTE Используется для отслеживания количества раз, когда пользователь отключает звук или видео.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_PAUSE Используется для отслеживания количества раз, когда пользователь останавливает воспроизведение аудио или видео.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_REWIND Используется для отслеживания количества повторных воспроизведений пользователем аудио или видео.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_FULLSCREEN Используется для отслеживания количества раз, когда пользователь разворачивает проигрыватель на весь экран.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_STOP Используется для отслеживания количества остановок пользователем воспроизведения аудио или видео.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_CUSTOM Используется для отслеживания количества нажатий пользователем определенных кнопок, например, нажатий на активную точку видео.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_SKIP Используется для отслеживания количества пропусков аудио- или видеофайлов.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_PROGRESS Используется для отслеживания количества воспроизведений аудио или видео до смещения, определяемого progressOffset .

Перекодировать

Представляет информацию о перекодированном аудио- или видеофайле.

JSON-представление 
{
  "name": string,
  "mimeType": string,
  "transcoded": boolean,
  "dimensions": {
    object (Dimensions)
  },
  "bitRateKbps": string,
  "frameRate": number,
  "audioBitRateKbps": string,
  "audioSampleRateHz": string,
  "fileSizeBytes": string
}
Поля
name

string

Необязательно. Имя перекодированного файла.

mimeType

string

Необязательно. MIME-тип перекодированного файла.

transcoded

boolean

Необязательно. Указывает, успешно ли выполнено перекодирование.

dimensions

object ( Dimensions )

Необязательно. Размеры перекодированного видео.

bitRateKbps

string ( int64 format)

Необязательно. Скорость передачи данных для перекодированного видео в килобитах в секунду.

frameRate

number

Необязательно. Частота кадров перекодированного видео (в кадрах в секунду).

audioBitRateKbps

string ( int64 format)

Необязательно. Битрейт аудиопотока транскодированного видео или битрейт транскодированного звука в килобитах в секунду.

audioSampleRateHz

string ( int64 format)

Необязательно. Частота дискретизации аудиопотока транскодированного видео или частота дискретизации транскодированного звука в герцах.

fileSizeBytes

string ( int64 format)

Необязательно. Размер перекодированного файла в байтах.

CmTrackingAd

Отслеживающее объявление Campaign Manager 360.

JSON-представление 
{
  "cmPlacementId": string,
  "cmCreativeId": string,
  "cmAdId": string
}
Поля
cmPlacementId

string ( int64 format)

Необязательно. Идентификатор места размещения отслеживаемого объявления Campaign Manager 360.

cmCreativeId

string ( int64 format)

Необязательно. Идентификатор креатива для отслеживания рекламы в Менеджере кампаний 360.

cmAdId

string ( int64 format)

Необязательно. Идентификатор отслеживаемого объявления Campaign Manager 360.

ОбаИкон

Значок OBA для креатива

JSON-представление 
{
  "resourceUrl": string,
  "resourceMimeType": string,
  "position": enum (ObaIconPosition),
  "dimensions": {
    object (Dimensions)
  },
  "program": string,
  "landingPageUrl": string,
  "clickTrackingUrl": string,
  "viewTrackingUrl": string
}
Поля
resourceUrl

string

Необязательно. URL-адрес ресурса значка поведенческой рекламы.

resourceMimeType

string

Необязательно. Тип MIME ресурса значка поведенческой рекламы.

position

enum ( ObaIconPosition )

Необязательно. Расположение значка поведенческой рекламы в креативе.

dimensions

object ( Dimensions )

Необязательно. Размеры значка поведенческой рекламы.

program

string

Необязательно. Программа значка поведенческой рекламы. Например: «AdChoices».

landingPageUrl

string

Обязательно. URL целевой страницы значка поведенческой рекламы.

Разрешены только URL-адреса следующих доменов:

  • https://info.evidon.com
  • https://l.betrad.com
clickTrackingUrl

string

Обязательно. URL-адрес отслеживания кликов по значку поведенческой рекламы.

Разрешены только URL-адреса следующих доменов:

  • https://info.evidon.com
  • https://l.betrad.com
viewTrackingUrl

string

Обязательно. URL-адрес отслеживания просмотра значка поведенческой рекламы.

Разрешены только URL-адреса следующих доменов:

  • https://info.evidon.com
  • https://l.betrad.com

ObaIconPosition

Положение значка поведенческой рекламы в креативе.

Перечисления
OBA_ICON_POSITION_UNSPECIFIED Положение значка OBA не указано.
OBA_ICON_POSITION_UPPER_RIGHT В правом верхнем углу креатива.
OBA_ICON_POSITION_UPPER_LEFT В левом верхнем углу креатива.
OBA_ICON_POSITION_LOWER_RIGHT В правом нижнем углу креатива.
OBA_ICON_POSITION_LOWER_LEFT В левом нижнем углу креатива.

НаправлениеРасширения

Направление расширения стороннего расширяемого креатива.

Перечисления
EXPANDING_DIRECTION_UNSPECIFIED Направление расширения не указано.
EXPANDING_DIRECTION_NONE Не расширяется ни в каком направлении.
EXPANDING_DIRECTION_UP Расширяется вверх.
EXPANDING_DIRECTION_DOWN Расширяется вниз.
EXPANDING_DIRECTION_LEFT Расширяется влево.
EXPANDING_DIRECTION_RIGHT Расширяется вправо.
EXPANDING_DIRECTION_UP_AND_LEFT Расширяется вверх и в левую сторону.
EXPANDING_DIRECTION_UP_AND_RIGHT Расширяется вверх и вправо.
EXPANDING_DIRECTION_DOWN_AND_LEFT Расширяется вниз и в левую сторону.
EXPANDING_DIRECTION_DOWN_AND_RIGHT Расширяется вниз и вправо.
EXPANDING_DIRECTION_UP_OR_DOWN Расширяется либо вверх, либо вниз.
EXPANDING_DIRECTION_LEFT_OR_RIGHT Расширяется в левую или правую сторону.
EXPANDING_DIRECTION_ANY_DIAGONAL Может расширяться в любом диагональном направлении.

Методы

create

 Создает новый креатив.

delete

 Удаляет креатив.

get

 Получается креатив.

list

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

patch

 Обновляет существующее объявление.