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)

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

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

createTime

string ( Timestamp format)

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

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

creativeType

enum ( CreativeType )

Необходимый. Неизменный. Тип объявления.

hostingSource

enum ( HostingSource )

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

dynamic

boolean

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

dimensions

object ( Dimensions )

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

  • CREATIVE_TYPE_VIDEO
  • CREATIVE_TYPE_TEMPLATED_APP_INSTALL_INTERSTITIAL
  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_NATIVE_VIDEO
  • CREATIVE_TYPE_TEMPLATED_APP_INSTALL_VIDEO
additionalDimensions[]

object ( Dimensions )

Дополнительные размеры. Применимо, когда creativeType является одним из:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_EXPANDABLE
  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_TEMPLATED_APP_INSTALL
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_LIGHTBOX
  • CREATIVE_TYPE_NATIVE_APP_INSTALL
  • CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE
  • 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 )

Необходимый. Объекты, связанные с этим креативом. Ресурсы могут быть связаны с креативом в одной из следующих ролей:

  • ASSET_ROLE_UNSPECIFIED
  • ASSET_ROLE_MAIN
  • ASSET_ROLE_BACKUP
  • ASSET_ROLE_POLITE_LOAD
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-адресе, используйте только те макросы, которые поддерживаются Display & Video 360.

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

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

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_APP_INSTALL
  • CREATIVE_TYPE_NATIVE_APP_INSTALL_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_APP_INSTALL
  • CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
cmTrackingAd

object ( CmTrackingAd )

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

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

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_APP_INSTALL
  • CREATIVE_TYPE_NATIVE_APP_INSTALL_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

ХостингИсточник

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

Перечисления
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_APP_INSTALL
  • CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO
HOSTING_SOURCE_RICH_MEDIA

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

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

КреативныйАтрибут

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

Перечисления
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)
    }
  ],
  "publisherReviewStatuses": [
    {
      object (PublisherReviewStatus)
    }
  ]
}
Поля
approvalStatus

enum ( ApprovalStatus )

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

creativeAndLandingPageReviewStatus

enum ( ReviewStatus )

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

contentAndPolicyReviewStatus

enum ( ReviewStatus )

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

exchangeReviewStatuses[]

object ( ExchangeReviewStatus )

Обменивайтесь статусами проверки креатива.

publisherReviewStatuses[]

object ( PublisherReviewStatus )

Статусы проверки издателем креатива.

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

Возможные типы статуса утверждения. Это сводка значений 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-представление
{
  "publisherName": string,
  "status": enum (ReviewStatus)
}
Поля
publisherName

string

Издатель проверяет креатив.

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

content

string

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

АктивРоль

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

Перечисления
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_APP_INSTALL
  • CREATIVE_TYPE_NATIVE_APP_INSTALL_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_APP_INSTALL
  • CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_BODY

Основной текст нативного объявления.

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

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

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_APP_INSTALL
  • CREATIVE_TYPE_NATIVE_APP_INSTALL_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_APP_INSTALL
  • CREATIVE_TYPE_NATIVE_APP_INSTALL_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_APP_INSTALL
  • CREATIVE_TYPE_NATIVE_APP_INSTALL_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_APP_INSTALL
  • CREATIVE_TYPE_NATIVE_APP_INSTALL_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_APP_INSTALL
  • CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_PRICE

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

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

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

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

  • CREATIVE_TYPE_NATIVE_APP_INSTALL
  • CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE
ASSET_ROLE_ANDROID_APP_ID

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

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

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

  • CREATIVE_TYPE_NATIVE_APP_INSTALL
  • CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE
ASSET_ROLE_IOS_APP_ID

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

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

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

  • CREATIVE_TYPE_NATIVE_APP_INSTALL
  • CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE
ASSET_ROLE_RATING

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

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

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

  • CREATIVE_TYPE_NATIVE_APP_INSTALL
  • CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE
ASSET_ROLE_ICON

Значок креатива.

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

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_APP_INSTALL
  • CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE
ASSET_ROLE_COVER_IMAGE

Обложка нативного видеообъявления.

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

  • CREATIVE_TYPE_VIDEO

ВыходСобытие

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

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

ТаймерСобытие

Событие таймера объявления.

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 )

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

Универсальный реестр рекламы

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

Перечисления
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 Используйте Display & Video 360, чтобы предоставить универсальный рекламный идентификатор.
UNIVERSAL_AD_REGISTRY_CM Используйте Менеджер кампании 360, чтобы предоставить универсальный идентификатор объявления.

Третья сторонаURL

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

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

enum ( ThirdPartyUrlType )

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

url

string

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

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

Третья сторонаUrlType

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

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

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

string ( int64 format)

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

cmCreativeId

string ( int64 format)

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

cmAdId

string ( int64 format)

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

ОбаИконка

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

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

Программа иконки OBA. Например: «Выбор рекламы».

landingPageUrl

string

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

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

clickTrackingUrl

string

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

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

viewTrackingUrl

string

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

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

ОбаИконПозиция

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

Перечисления
OBA_ICON_POSITION_UNSPECIFIED Положение значка поведенческой рекламы не указано.
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

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