REST Resource: advertisers.adGroupAds

Ресурс: AdGroupAd

Одно объявление, связанное с группой объявлений.

JSON-представление 
{
  "name": string,
  "advertiserId": string,
  "adGroupAdId": string,
  "adGroupId": string,
  "displayName": string,
  "entityStatus": enum (EntityStatus),
  "adUrls": [
    {
      object (AdUrl)
    }
  ],

  // Union field ad_details can be only one of the following:
  "displayVideoSourceAd": {
    object (DisplayVideoSourceAd)
  },
  "mastheadAd": {
    object (MastheadAd)
  },
  "inStreamAd": {
    object (InStreamAd)
  },
  "nonSkippableAd": {
    object (NonSkippableAd)
  },
  "bumperAd": {
    object (BumperAd)
  },
  "audioAd": {
    object (AudioAd)
  },
  "videoDiscoverAd": {
    object (VideoDiscoveryAd)
  },
  "videoPerformanceAd": {
    object (VideoPerformanceAd)
  }
  // End of list of possible types for union field ad_details.
}
Поля
name

string

Имя ресурса объявления.

advertiser Id

string ( int64 format)

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

ad Group Ad Id

string ( int64 format)

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

ad Group Id

string ( int64 format)

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

display Name

string

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

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

entity Status

enum ( EntityStatus )

Статус объекта объявления.

ad Urls[]

object ( AdUrl )

Список URL-адресов, используемых в объявлении.

Поле объединения ad_details . Подробности объявления. ad_details может быть только одним из следующих:
display Video Source Ad

object ( DisplayVideoSourceAd )

Подробная информация об объявлении, полученном из креатива Display & Video 360.

masthead Ad

object ( MastheadAd )

Подробная информация об объявлении, показанном в главной ленте YouTube .

in Stream Ad

object ( InStreamAd )

Подробная информация об объявлении In-Stream, которое можно пропустить через 5 секунд и которое используется для повышения узнаваемости бренда или достижения маркетинговых целей.

non Skippable Ad

object ( NonSkippableAd )

Подробная информация о коротком видеорекламе In-Stream без возможности пропуска длительностью от 6 до 15 секунд, используемом для достижения маркетинговых целей.

bumper Ad

object ( BumperAd )

Подробная информация о коротком видеообъявлении без возможности пропуска длительностью не более 6 секунд, используемом для охвата.

audio Ad

object ( AudioAd )

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

video Discover Ad

object ( VideoDiscoveryAd )

Подробности объявления, продвигающего видео , которое показывается в местах открытия.

video Performance Ad

object ( VideoPerformanceAd )

Подробная информация об объявлении, используемом в кампании Video Action для привлечения внимания к компании, услуге или продукту.

Медийное видеоИсточникобъявления

Источником объявления является креатив DV360.

JSON-представление 
{
  "creativeId": string
}
Поля
creative Id

string ( int64 format)

Идентификатор исходного объявления.

Главное объявление

Подробная информация о шапке объявления.

JSON-представление 
{
  "video": {
    object (YoutubeVideoDetails)
  },
  "headline": string,
  "description": string,
  "videoAspectRatio": enum (VideoAspectRatio),
  "autoplayVideoStartMillisecond": string,
  "autoplayVideoDuration": string,
  "callToActionButtonLabel": string,
  "callToActionFinalUrl": string,
  "callToActionTrackingUrl": string,
  "showChannelArt": boolean,
  "companionYoutubeVideos": [
    {
      object (YoutubeVideoDetails)
    }
  ]
}
Поля
video

object ( YoutubeVideoDetails )

Видео YouTube, используемое в объявлении.

headline

string

Заголовок объявления.

description

string

Описание объявления.

video Aspect Ratio

enum ( VideoAspectRatio )

Соотношение сторон автоматически воспроизводимого видео YouTube в шапке.

autoplay Video Start Millisecond

string ( int64 format)

Время в миллисекундах, по истечении которого видео начнет воспроизводиться.

autoplay Video Duration

string ( Duration format)

Продолжительность автоматического воспроизведения видео.

Продолжительность в секундах, содержащая до девяти дробных цифр и оканчивающаяся на « s ». Пример: "3.5s" .

call To Action Button Label

string

Текст на кнопке призыва к действию.

call To Action Final Url

string

Целевой URL-адрес кнопки призыва к действию.

call To Action Tracking Url

string

URL отслеживания для кнопки призыва к действию.

show Channel Art

boolean

Показывать ли фон или баннер вверху страницы YouTube.

companion Youtube Videos[]

object ( YoutubeVideoDetails )

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

YoutubeВидеоПодробнее

Подробности видео на YouTube.

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

string

Идентификатор видео YouTube, который можно найти на веб-странице YouTube.

unavailable Reason

enum ( VideoUnavailableReason )

Причина, по которой видеоданные недоступны.

ВидеоНедоступноПричина

Возможные причины, по которым видео может быть недоступно.

Перечисления
VIDEO_UNAVAILABLE_REASON_UNSPECIFIED Неизвестно или не указано.
VIDEO_UNAVAILABLE_REASON_PRIVATE Видео является частным.
VIDEO_UNAVAILABLE_REASON_DELETED Видео удалено.

ВидеоСоотношение сторон

Возможные соотношения сторон видео на YouTube.

Перечисления
VIDEO_ASPECT_RATIO_UNSPECIFIED Не указано или неизвестно.
VIDEO_ASPECT_RATIO_WIDESCREEN Видео растянуто, а верх и низ обрезаны.
VIDEO_ASPECT_RATIO_FIXED_16_9 В видео используется фиксированное соотношение сторон 16:9.

InStreamAd

Подробности об объявлении In-Stream.

JSON-представление 
{
  "commonInStreamAttribute": {
    object (CommonInStreamAttribute)
  },
  "customParameters": {
    string: string,
    ...
  }
}
Поля
common In Stream Attribute

object ( CommonInStreamAttribute )

Общие атрибуты объявления.

custom Parameters

map (key: string, value: string)

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

Объект, содержащий список пар "key": value . Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

Коммонинстриматтрибуте

Общие атрибуты для объявлений In-Stream, объявлений без возможности пропуска и объявлений-заставок.

JSON-представление 
{
  "displayUrl": string,
  "finalUrl": string,
  "trackingUrl": string,
  "actionButtonLabel": string,
  "actionHeadline": string,
  "video": {
    object (YoutubeVideoDetails)
  },
  "companionBanner": {
    object (ImageAsset)
  }
}
Поля
display Url

string

Адрес веб-страницы, которая отображается вместе с объявлением.

final Url

string

URL-адрес веб-страницы, на которую люди попадают после нажатия на объявление.

tracking Url

string

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

action Button Label

string

Текст на кнопке призыва к действию.

action Headline

string

Заголовок баннера с призывом к действию.

video

object ( YoutubeVideoDetails )

Рекламное видео на YouTube.

companion Banner

object ( ImageAsset )

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

ImageAsset

Метаданные изображения.

JSON-представление 
{
  "mimeType": string,
  "fullSize": {
    object (Dimensions)
  },
  "fileSize": string
}
Поля
mime Type

string

MIME-тип изображения.

full Size

object ( Dimensions )

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

file Size

string ( int64 format)

Размер файла изображения в байтах.

Объявление без возможности пропуска

Подробная информация об объявлении без возможности пропуска.

JSON-представление 
{
  "commonInStreamAttribute": {
    object (CommonInStreamAttribute)
  },
  "customParameters": {
    string: string,
    ...
  }
}
Поля
common In Stream Attribute

object ( CommonInStreamAttribute )

Общие атрибуты объявления.

custom Parameters

map (key: string, value: string)

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

Объект, содержащий список пар "key": value . Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

Объявление-заставка

Подробности для рекламы-заставки.

JSON-представление 
{
  "commonInStreamAttribute": {
    object (CommonInStreamAttribute)
  }
}
Поля
common In Stream Attribute

object ( CommonInStreamAttribute )

Общие атрибуты объявления.

Аудиообъявление

Подробности для аудиообъявления.

JSON-представление 
{
  "displayUrl": string,
  "finalUrl": string,
  "trackingUrl": string,
  "video": {
    object (YoutubeVideoDetails)
  }
}
Поля
display Url

string

Адрес веб-страницы, которая отображается вместе с объявлением.

final Url

string

URL-адрес веб-страницы, на которую люди попадают после нажатия на объявление.

tracking Url

string

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

video

object ( YoutubeVideoDetails )

Рекламное видео на YouTube.

ВидеоDiscoveryAd

Подробная информация об объявлении Video Discovery.

JSON-представление 
{
  "headline": string,
  "description1": string,
  "description2": string,
  "video": {
    object (YoutubeVideoDetails)
  },
  "thumbnail": enum (Thumbnail)
}
Поля
headline

string

Заголовок объявления.

description1

string

Первая текстовая строка объявления.

description2

string

Вторая текстовая строка объявления.

video

object ( YoutubeVideoDetails )

Видео YouTube, рекламируемое в рекламе.

thumbnail

enum ( Thumbnail )

Миниатюрное изображение, используемое в объявлении.

Миниатюра

Возможные варианты миниатюр в объявлениях Video Discovery.

Перечисления
THUMBNAIL_UNSPECIFIED Неизвестно или не указано.
THUMBNAIL_DEFAULT Миниатюра по умолчанию может быть создана автоматически или загружена пользователем.
THUMBNAIL_1 Миниатюра 1, созданная на основе видео.
THUMBNAIL_2 Миниатюра 2, созданная на основе видео.
THUMBNAIL_3 Миниатюра 3, созданная на основе видео.

Видеообъявление Performance

Подробная информация о видеорекламе с высокой эффективностью.

JSON-представление 
{
  "finalUrl": string,
  "trackingUrl": string,
  "actionButtonLabels": [
    string
  ],
  "headlines": [
    string
  ],
  "longHeadlines": [
    string
  ],
  "descriptions": [
    string
  ],
  "displayUrlBreadcrumb1": string,
  "displayUrlBreadcrumb2": string,
  "domain": string,
  "videos": [
    {
      object (YoutubeVideoDetails)
    }
  ],
  "customParameters": {
    string: string,
    ...
  },
  "companionBanners": [
    {
      object (ImageAsset)
    }
  ]
}
Поля
final Url

string

URL-адрес веб-страницы, на которую люди попадают после нажатия на объявление.

tracking Url

string

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

action Button Labels[]

string

Список текстовых ресурсов, отображаемых на кнопке призыва к действию.

headlines[]

string

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

long Headlines[]

string

Список одиночных заголовков, отображаемых на баннере с призывом к действию.

descriptions[]

string

Список описаний, отображаемый на баннере с призывом к действию.

display Url Breadcrumb1

string

Первая часть после домена в отображаемом URL.

display Url Breadcrumb2

string

Вторая часть после домена в отображаемом URL.

domain

string

Домен отображаемого URL.

videos[]

object ( YoutubeVideoDetails )

Список видеоресурсов YouTube, используемых в этом объявлении.

custom Parameters

map (key: string, value: string)

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

Объект, содержащий список пар "key": value . Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

companion Banners[]

object ( ImageAsset )

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

URL-адрес объявления

Дополнительные URL-адреса, связанные с объявлением, включая маяки.

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

enum ( AdUrlType )

Тип URL объявления.

url

string

Строковое значение URL-адреса.

Тип URL-адреса объявления

Возможные типы URL-адресов объявлений.

Перечисления
AD_URL_TYPE_UNSPECIFIED Неизвестно или не указано.
AD_URL_TYPE_BEACON_IMPRESSION Пиксель отслеживания 1x1, который отправляет сигнал при показе объявления.
AD_URL_TYPE_BEACON_EXPANDABLE_DCM_IMPRESSION Расширяемый индикатор показов DCM. Во время обслуживания оно расширяется до нескольких маяков.
AD_URL_TYPE_BEACON_CLICK URL-адрес отслеживания для проверки связи при срабатывании события клика.
AD_URL_TYPE_BEACON_SKIP URL-адрес отслеживания для проверки связи при срабатывании события пропуска.

Методы

get

 Получает объявление группы объявлений.

list

 Перечисляет объявления группы объявлений.