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,
  "syntheticContentAttestationStatus": enum (SyntheticContentAttestationStatus)
}
Поля
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. Допустимы и другие типы нормализации. Примеры: "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. Допустимы и другие типы нормализации. Примеры: "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.exit()).
timerEvents[]

object (TimerEvent)

Необязательное поле. Специальные события таймера для мультимедийного креатива. Таймеры отслеживают время, в течение которого пользователь просматривает определенную часть мультимедийного креатива и взаимодействует с ней. У креатива может быть несколько независимых событий таймера. Если креатив содержит только объекты изображений, оставьте это поле пустым или не задавайте его.
counterEvents[]

object (CounterEvent)

Необязательное поле. События счетчика для мультимедийного креатива. Счетчики отслеживают, сколько раз пользователь определенным образом взаимодействовал с мультимедийным креативом (наводил и отводил указатель мыши, нажимал на объявление, загружал данные, выполнял ввод с клавиатуры и т. д.). Сюда относятся любые действия, которые может зарегистрировать креатив. Если креатив содержит только объекты изображений, оставьте это поле пустым или не задавайте его.
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)

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

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

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

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

  • CREATIVE_TYPE_VIDEO
  • CREATIVE_TYPE_NATIVE_VIDEO
  • CREATIVE_TYPE_AUDIO
trackerUrls[]

string

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

URL должны начинаться с https: (за исключением инвентаря, не требующего поддержки SSL). В таких URL можно использовать только макросы, которые поддерживаются Дисплеем и Видео 360.

Допускаются только стандартные URL (теги script и img не поддерживаются).

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

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
jsTrackerUrl

string

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

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

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
cmTrackingAd

object (CmTrackingAd)

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

Необязательно для следующих creativeType, если они созданы рекламодателем, который использует как Менеджер кампаний 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

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

Действителен только при использовании отслеживающего объявления Менеджера кампаний 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.

Только для вывода. Действительно только для сторонних креативов с тегами 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
syntheticContentAttestationStatus

enum (SyntheticContentAttestationStatus)

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

HostingSource

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

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

Креатив, синхронизированный с Менеджером кампаний 360.

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

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

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

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_EXPANDABLE
  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO
HOSTING_SOURCE_HOSTED

Креатив, созданный в DV360 и размещенный в Менеджере кампаний 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

Мультимедийный креатив, созданный в Креативной студии и размещенный в Менеджере кампаний 360.

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

CreativeAttribute

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

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

ReviewStatusInfo

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

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 В креативе обнаружена проблема, без устранения которой показ невозможен.

ReviewStatus

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

Перечисления
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)

Статус проверки на бирже.

AssetAssociation

Связь объекта с креативом.

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, чтобы связать объект с креативом.

Пространство идентификаторов мультимедийных объектов было обновлено 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 или App Store (например, 5,99 долл.США).

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

Значение content должно быть закодировано в формате UTF-8 и содержать не более 15 символов.

Объекты этой роли доступны только для чтения.
ASSET_ROLE_ANDROID_APP_ID

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

Этот идентификатор можно найти в URL приложения в Google Play после параметра id. Например, в URL 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 или App Store.

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

Объекты этой роли доступны только для чтения.
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

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

AudioVideoOffset

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

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "percentage": string,
  "seconds": string
  // End of mutually exclusive fields.
}
Поля
Значение смещения. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
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_REGISTRY_OTHER Используйте собственный поставщик, чтобы предоставить универсальный идентификатор объявления.
UNIVERSAL_AD_REGISTRY_AD_ID Используйте Ad-ID, чтобы указать универсальный идентификатор объявления.
UNIVERSAL_AD_REGISTRY_CLEARCAST Укажите универсальный идентификатор объявления, используя clearcast.co.uk.
UNIVERSAL_AD_REGISTRY_DV360 Укажите универсальный идентификатор объявления в Дисплее и Видео 360.
UNIVERSAL_AD_REGISTRY_CM Укажите универсальный идентификатор объявления в Менеджере кампаний 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 Позволяет отслеживать, сколько раз аудио- или видеообъявление было воспроизведено до середины.
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

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

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

string (int64 format)

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

string (int64 format)

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

string (int64 format)

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

ObaIcon

Значок поведенческой рекламы для креатива

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

Необязательное поле. Программа, регулирующая показ значка поведенческой рекламы. Пример: "Выбор рекламы".
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_ICON_POSITION_UPPER_RIGHT В правом верхнем углу креатива.
OBA_ICON_POSITION_UPPER_LEFT В левом верхнем углу креатива.
OBA_ICON_POSITION_LOWER_RIGHT В правом нижнем углу креатива.
OBA_ICON_POSITION_LOWER_LEFT В левом нижнем углу креатива.

ExpandingDirection

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

Перечисления
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

 Обновляет существующий креатив.