REST Resource: advertisers.adGroupAds

Ресурс: AdGroupAd

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

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "displayVideoSourceAd": {
    object (DisplayVideoSourceAd)
  },
  "mastheadAd": {
    object (MastheadAd)
  },
  "inStreamAd": {
    object (InStreamAd)
  },
  "nonSkippableAd": {
    object (NonSkippableAd)
  },
  "bumperAd": {
    object (BumperAd)
  },
  "audioAd": {
    object (AudioAd)
  },
  "videoDiscoverAd": {
    object (VideoDiscoveryAd)
  },
  "videoPerformanceAd": {
    object (VideoPerformanceAd)
  },
  "demandGenVideoAd": {
    object (DemandGenVideoAd)
  },
  "demandGenImageAd": {
    object (DemandGenImageAd)
  },
  "demandGenCarouselAd": {
    object (DemandGenCarouselAd)
  },
  "demandGenProductAd": {
    object (DemandGenProductAd)
  }
  // End of mutually exclusive fields.
}
Поля
name

string

Только для вывода. Название ресурса объявления.

advertiserId

string (int64 format)

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

adGroupAdId

string (int64 format)

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

adGroupId

string (int64 format)

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

displayName

string

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

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

adPolicy

object (AdPolicy)

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

entityStatus

enum (EntityStatus)

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

adUrls[]

object (AdUrl)

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

dcmTrackingInfo

object (DcmTrackingInfo)

Необязательное поле. Информация об отслеживающем объявлении DCM.

Чтобы удалить информацию об отслеживающем объявлении DCM, оставьте это поле пустым.

containsSyntheticMedia

boolean

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

Должно быть задано только для объявлений, созданных проверенными рекламодателями, размещающими предвыборную рекламу. Доступно только для рекламы на YouTube.

parentCreativeId

string (int64 format)

Только для вывода. Идентификатор креатива Дисплея и Видео 360, который использовался для создания этого объявления.

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

Подробная информация об объявлении. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
displayVideoSourceAd

object (DisplayVideoSourceAd)

Только для вывода. Сведения об объявлении, полученном из креатива Дисплея и Видео 360.

mastheadAd

object (MastheadAd)

Только для вывода. Подробные сведения об объявлении, показанном в ленте YouTube.

inStreamAd

object (InStreamAd)

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

nonSkippableAd

object (NonSkippableAd)

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

bumperAd

object (BumperAd)

Только для вывода. Сведения о коротком видеообъявлении без возможности пропуска (не более 6 секунд), которое используется для расширения охвата.

audioAd

object (AudioAd)

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

videoDiscoverAd

object (VideoDiscoveryAd)

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

videoPerformanceAd

object (VideoPerformanceAd)

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

demandGenVideoAd

object (DemandGenVideoAd)

Необязательное поле. Сведения о видеообъявлении для создания спроса.

demandGenImageAd

object (DemandGenImageAd)

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

demandGenProductAd

object (DemandGenProductAd)

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

Конец взаимоисключающих полей.

DisplayVideoSourceAd

Объявление, полученное из креатива DV360.

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

string (int64 format)

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

MastheadAd

Подробные сведения об объявлении Masthead.

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

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

videoAspectRatio

enum (VideoAspectRatio)

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

autoplayVideoStartMillisecond

string (int64 format)

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

autoplayVideoDuration

string (Duration format)

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

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

callToActionButtonLabel

string

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

callToActionFinalUrl

string

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

callToActionTrackingUrl

string

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

showChannelArt

boolean

Фоновое изображение или баннер для показа в верхней части страницы YouTube.

companionYoutubeVideos[]

object (YoutubeVideoDetails)

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

YoutubeVideoDetails

Сведения о видео на YouTube.

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

string

Только для вывода. Идентификатор видео YouTube, по которому можно найти видео на веб-странице YouTube.

unavailableReason

enum (VideoUnavailableReason)

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

videoAssetId

string (int64 format)

Обязательно. Идентификатор видеообъекта YouTube. Это adAssetId ресурса AdAsset.

VideoUnavailableReason

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

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

VideoAspectRatio

Возможные соотношения сторон для видео 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,
    ...
  }
}
Поля
commonInStreamAttribute

object (CommonInStreamAttribute)

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

customParameters

map (key: string, value: string)

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

Объект содержит список из нескольких пар ("key": value). Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

CommonInStreamAttribute

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

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

string

Обязательно. Адрес веб-страницы, показываемый в объявлении.

finalUrl

string

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

trackingUrl

string

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

В версии 4 и более ранних это поле представляет URL отслеживания, указанный пользователем вручную. В версии 5 это можно найти в userSpecifiedTrackingUrl.

userSpecifiedTrackingUrl

string

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

actionButtonLabel

string

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

Необходимо задать, если задано значение actionHeadline.

actionHeadline

string

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

video

object (YoutubeVideoDetails)

Обязательно. Не меняется. Видеообъявление на YouTube.

companionBanner

object (ImageAsset)

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

ImageAsset

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

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

string

Только для вывода. MIME-тип объекта изображения.

fullSize

object (Dimensions)

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

fileSize

string (int64 format)

Только для вывода. Размер файла объекта изображения в байтах.

assetId

string (int64 format)

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

NonSkippableAd

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

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

object (CommonInStreamAttribute)

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

customParameters

map (key: string, value: string)

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

Объект содержит список из нескольких пар ("key": value). Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

BumperAd

Подробное описание объявления-заставки

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

object (CommonInStreamAttribute)

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

AudioAd

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

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

string

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

finalUrl

string

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

trackingUrl

string

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

В версии 4 и более ранних это поле представляет URL отслеживания, указанный пользователем вручную. В версии 5 это можно найти в userSpecifiedTrackingUrl.

userSpecifiedTrackingUrl

string

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

video

object (YoutubeVideoDetails)

Видеообъявление на YouTube.

VideoDiscoveryAd

Подробная информация о видеообъявлении 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)

Значок, используемый в объявлении.

Значок видео

Варианты значков для видеообъявлений Discovery.

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

VideoPerformanceAd

Подробные сведения о видеообъявлении, ориентированном на результат.

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

string

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

trackingUrl

string

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

В версии 4 и более ранних это поле представляет URL отслеживания, указанный пользователем вручную. В версии 5 это можно найти в userSpecifiedTrackingUrl.

userSpecifiedTrackingUrl

string

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

actionButtonLabels[]

string

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

Необходимо задать, если задано значение headlines.

headlines[]

string

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

longHeadlines[]

string

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

Это поле должно быть заполнено, если в поле lineItemType родительской позиции не указано значение LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE. В противном случае поле заполнять не нужно.

descriptions[]

string

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

Это поле должно быть заполнено, если в поле lineItemType родительской позиции не указано значение LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE. В противном случае поле заполнять не нужно.

displayUrlBreadcrumb1

string

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

displayUrlBreadcrumb2

string

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

Можно задать, только если также задано значение displayUrlBreadcrumb1.

domain

string

Только для вывода. Домен отображаемого URL.

videos[]

object (YoutubeVideoDetails)

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

customParameters

map (key: string, value: string)

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

Объект содержит список из нескольких пар ("key": value). Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

companionBanners[]

object (ImageAsset)

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

businessName

string

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

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

DemandGenVideoAd

Информация о видеообъявлении для создания спроса.

JSON-представление
{
  "finalUrl": string,
  "trackingUrl": string,
  "userSpecifiedTrackingUrl": string,
  "callToAction": enum (CallToAction),
  "headlines": [
    string
  ],
  "longHeadlines": [
    string
  ],
  "descriptions": [
    string
  ],
  "displayUrlBreadcrumb1": string,
  "displayUrlBreadcrumb2": string,
  "videos": [
    {
      object (YoutubeVideoDetails)
    }
  ],
  "customParameters": {
    string: string,
    ...
  },
  "companionBanner": {
    object (ImageAsset)
  },
  "logo": {
    object (ImageAsset)
  },
  "finalMobileUrl": string,
  "finalUrlSuffix": string,
  "businessName": string
}
Поля
finalUrl

string

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

trackingUrl

string

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

userSpecifiedTrackingUrl

string

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

callToAction

enum (CallToAction)

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

Допустимые значения:

  • AUTOMATED
  • LEARN_MORE
  • GET_QUOTE
  • APPLY_NOW
  • SIGN_UP
  • CONTACT_US
  • SUBSCRIBE
  • DOWNLOAD
  • BOOK_NOW
  • SHOP_NOW
  • BUY_NOW
  • DONATE_NOW
  • ORDER_NOW
  • PLAY_NOW
  • SEE_MORE
  • START_NOW
  • VISIT_SITE
  • WATCH_NOW
headlines[]

string

Обязательно. Список заголовков, показанных в объявлении.

longHeadlines[]

string

Обязательно. Список длинных заголовков, показанных в объявлении.

descriptions[]

string

Обязательно. Список описаний, которые показываются в объявлении.

displayUrlBreadcrumb1

string

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

displayUrlBreadcrumb2

string

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

videos[]

object (YoutubeVideoDetails)

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

customParameters

map (key: string, value: string)

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

Объект содержит список из нескольких пар ("key": value). Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

companionBanner

object (ImageAsset)

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

finalMobileUrl

string

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

finalUrlSuffix

string

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

businessName

string

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

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

CallToAction

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

Перечисления
CALL_TO_ACTION_UNSPECIFIED Не указано или неизвестно.
AUTOMATED роботами;
LEARN_MORE Подробнее…
GET_QUOTE Узнать цену.
APPLY_NOW в саммите местных экспертов
SIGN_UP Sign up (Зарегистрироваться).
CONTACT_US Свяжитесь с нами.
SUBSCRIBE Подписаться.
DOWNLOAD Загрузить.
BOOK_NOW Забронируйте сейчас.
SHOP_NOW Спешите купить!
BUY_NOW Купите сейчас!
DONATE_NOW Пожертвовать
ORDER_NOW Закажите сейчас.
PLAY_NOW Играйте сейчас.
SEE_MORE Узнайте больше.
START_NOW Запустить.
VISIT_SITE Перейти на сайт.
WATCH_NOW Смотреть

DemandGenImageAd

Подробные сведения о графическом объявлении для создания спроса.

JSON-представление
{
  "finalUrl": string,
  "trackingUrl": string,
  "userSpecifiedTrackingUrl": string,
  "callToAction": string,
  "headlines": [
    string
  ],
  "descriptions": [
    string
  ],
  "customParameters": {
    string: string,
    ...
  },
  "finalMobileUrl": string,
  "finalUrlSuffix": string,
  "businessName": string,
  "marketingImages": [
    {
      object (ImageAsset)
    }
  ],
  "squareMarketingImages": [
    {
      object (ImageAsset)
    }
  ],
  "portraitMarketingImages": [
    {
      object (ImageAsset)
    }
  ],
  "logoImages": [
    {
      object (ImageAsset)
    }
  ]
}
Поля
finalUrl

string

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

trackingUrl

string

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

userSpecifiedTrackingUrl

string

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

callToAction

string

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

headlines[]

string

Обязательно. Список заголовков, показанных в объявлении.

descriptions[]

string

Обязательно. Список описаний, которые показываются в объявлении.

customParameters

map (key: string, value: string)

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

Объект содержит список из нескольких пар ("key": value). Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

finalMobileUrl

string

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

finalUrlSuffix

string

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

businessName

string

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

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

marketingImages[]

object (ImageAsset)

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

squareMarketingImages[]

object (ImageAsset)

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

portraitMarketingImages[]

object (ImageAsset)

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

logoImages[]

object (ImageAsset)

Список логотипов, показанных в объявлении.

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

DemandGenCarouselAd

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

JSON-представление
{
  "finalUrl": string,
  "headline": string,
  "description": string,
  "cards": [
    {
      object (CarouselCard)
    }
  ],
  "finalUrlSuffix": string,
  "trackingUrl": string,
  "userSpecifiedTrackingUrl": string,
  "businessName": string,
  "customParameters": {
    string: string,
    ...
  },
  "logo": {
    object (ImageAsset)
  }
}
Поля
finalUrl

string

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

headline

string

Обязательно. Заголовок объявления

description

string

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

cards[]

object (CarouselCard)

Обязательно. Список карточек, показанных в объявлении.

finalUrlSuffix

string

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

trackingUrl

string

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

userSpecifiedTrackingUrl

string

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

businessName

string

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

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

customParameters

map (key: string, value: string)

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

Объект содержит список из нескольких пар ("key": value). Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

CarouselCard

Информация о карточке карусели для кампании для создания спроса.

JSON-представление
{
  "finalUrl": string,
  "finalMobileUrl": string,
  "headline": string,
  "callToAction": string,
  "marketingImage": {
    object (ImageAsset)
  },
  "squareMarketingImage": {
    object (ImageAsset)
  },
  "portraitMarketingImage": {
    object (ImageAsset)
  }
}
Поля
finalUrl

string

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

finalMobileUrl

string

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

headline

string

Обязательно. Заголовок карточки.

callToAction

string

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

Максимальное количество символов – 10.

marketingImage

object (ImageAsset)

Необязательное поле. Маркетинговое изображение, которое показывается на карточке.

squareMarketingImage

object (ImageAsset)

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

portraitMarketingImage

object (ImageAsset)

Необязательное поле. Вертикальное рекламное изображение, показанное на карточке.

DemandGenProductAd

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

JSON-представление
{
  "finalUrl": string,
  "headline": string,
  "description": string,
  "finalUrlSuffix": string,
  "callToAction": enum (CallToAction),
  "trackingUrl": string,
  "userSpecifiedTrackingUrl": string,
  "businessName": string,
  "customParameters": {
    string: string,
    ...
  },
  "logo": {
    object (ImageAsset)
  },
  "displayUrlBreadcrumb1": string,
  "displayUrlBreadcrumb2": string
}
Поля
finalUrl

string

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

headline

string

Обязательно. Заголовок объявления

description

string

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

finalUrlSuffix

string

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

callToAction

enum (CallToAction)

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

Допустимые значения:

  • AUTOMATED
  • APPLY_NOW
  • BOOK_NOW
  • CONTACT_US
  • DOWNLOAD
  • GET_QUOTE
  • LEARN_MORE
  • SHOP_NOW
  • SIGN_UP
  • SUBSCRIBE
trackingUrl

string

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

userSpecifiedTrackingUrl

string

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

businessName

string

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

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

customParameters

map (key: string, value: string)

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

Объект содержит список из нескольких пар ("key": value). Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

displayUrlBreadcrumb1

string

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

displayUrlBreadcrumb2

string

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

AdPolicy

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

JSON-представление
{
  "adPolicyApprovalStatus": enum (AdPolicyApprovalStatus),
  "adPolicyReviewStatus": enum (AdPolicyReviewStatus),
  "adPolicyTopicEntry": [
    {
      object (AdPolicyTopicEntry)
    }
  ]
}
Поля
adPolicyApprovalStatus

enum (AdPolicyApprovalStatus)

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

adPolicyReviewStatus

enum (AdPolicyReviewStatus)

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

adPolicyTopicEntry[]

object (AdPolicyTopicEntry)

Записи для каждой темы правил, которая относится к объявлению. Для каждой записи указывается тема, уровень ограничения и рекомендации по устранению нарушений.

AdPolicyApprovalStatus

Возможные статусы проверки объявления на соответствие правилам размещения рекламы.

Перечисления
AD_POLICY_APPROVAL_STATUS_UNKNOWN Неизвестно или не указано.
DISAPPROVED Показ невозможен.
APPROVED_LIMITED Показ будет ограничен.
APPROVED Объявления будут показываться без ограничений.
AREA_OF_INTEREST_ONLY Объявления не будут показываться в целевых странах, но могут показываться пользователям, которые ищут информацию о целевых странах.

AdPolicyReviewStatus

Возможные статусы проверки на соблюдение правил размещения рекламы.

Перечисления
AD_POLICY_REVIEW_STATUS_UNKNOWN Неизвестно или не указано.
REVIEW_IN_PROGRESS Сейчас на рассмотрении.
REVIEWED Основная проверка завершена. Другие проверки могут ещё продолжаться.
UNDER_APPEAL Объявление отправлено на повторную проверку или подана апелляция на решение о нарушении правил.
ELIGIBLE_MAY_SERVE Объявление допущено к показу и может показываться. В дальнейшем может потребоваться дополнительная проверка.

AdPolicyTopicEntry

Запись, описывающая, как объявление было идентифицировано как связанное с правилами размещения рекламы.

JSON-представление
{
  "policyTopic": string,
  "policyLabel": string,
  "policyTopicDescription": string,
  "policyTopicType": enum (AdPolicyTopicEntryType),
  "policyDecisionType": enum (AdPolicyDecisionType),
  "policyEnforcementMeans": enum (AdPolicyEnforcementMeans),
  "policyTopicEvidences": [
    {
      object (AdPolicyTopicEvidence)
    }
  ],
  "policyTopicConstraints": [
    {
      object (AdPolicyTopicConstraint)
    }
  ],
  "helpCenterLink": string,
  "appealInfo": {
    object (AdPolicyTopicAppealInfo)
  }
}
Поля
policyTopic

string

Тема правила.

Примеры: TRADEMARKS, ALCOHOL и т. д.

policyLabel

string

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

Примеры: "Товарные знаки в тексте", "Содержит алкоголь" и т. д.

policyTopicDescription

string

Краткое описание темы правил.

policyTopicType

enum (AdPolicyTopicEntryType)

Как показ рекламы будет затронут из-за связи с темой правил размещения рекламы.

policyDecisionType

enum (AdPolicyDecisionType)

Источник решения о нарушении правил.

policyEnforcementMeans

enum (AdPolicyEnforcementMeans)

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

policyTopicEvidences[]

object (AdPolicyTopicEvidence)

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

policyTopicConstraints[]

object (AdPolicyTopicConstraint)

Ограничения на показ, связанные с решением о нарушении правил.

appealInfo

object (AdPolicyTopicAppealInfo)

Информация о том, как подать апелляцию на решение о нарушении правил.

AdPolicyTopicEntryType

Возможные последствия нарушения правил размещения рекламы.

Перечисления
AD_POLICY_TOPIC_ENTRY_TYPE_UNKNOWN Неизвестно или не указано.
PROHIBITED Ресурс не будет показываться.
FULLY_LIMITED Ресурс не будет показываться во всех целевых странах.
LIMITED Ресурс не может показываться в некоторых странах.
DESCRIPTIVE Ресурс может показываться.
BROADENING Ресурс может показываться, в том числе за пределами стандартной зоны покрытия.
AREA_OF_INTEREST_ONLY Ресурс ограничен для всех целевых стран, но может показываться пользователям, которые ищут информацию о целевых странах.

AdPolicyDecisionType

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

Перечисления
AD_POLICY_DECISION_TYPE_UNKNOWN Неизвестно или не указано.
PURSUANT_TO_NOTICE Решение принято на основании юридического уведомления, распоряжения суда, жалобы владельца контента или другого документа.
GOOGLE_INVESTIGATION Решение принято по результатам расследования Google.

AdPolicyEnforcementMeans

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

Перечисления
AD_POLICY_ENFORCEMENT_MEANS_UNKNOWN Неизвестно или не указано.
AUTOMATED Процесс применения мер был полностью автоматизирован.
HUMAN_REVIEW Человек частично или полностью участвовал в процессе принятия решения.

AdPolicyTopicEvidence

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

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "textList": {
    object (TextList)
  },
  "websiteList": {
    object (WebsiteList)
  },
  "httpCode": integer,
  "languageCode": string,
  "destinationTextList": {
    object (DestinationTextList)
  },
  "destinationMismatch": {
    object (DestinationMismatch)
  },
  "destinationNotWorking": {
    object (DestinationNotWorking)
  },
  "trademark": {
    object (Trademark)
  },
  "legalRemoval": {
    object (LegalRemoval)
  },
  "counterfeit": {
    object (Counterfeit)
  },
  "regionalRequirements": {
    object (RegionalRequirements)
  }
  // End of mutually exclusive fields.
}
Поля
Доказательства нарушения правил. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
textList

object (TextList)

Список доказательств, найденных в тексте объявления.

websiteList

object (WebsiteList)

Список сайтов, связанных с объявлением.

httpCode

integer

Код HTTP, возвращенный при сканировании конечного URL.

languageCode

string

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

В этом поле используются языковые теги IETF, например "ru-RU".

destinationTextList

object (DestinationTextList)

Текст на целевой странице объявления, который нарушает правила.

destinationMismatch

object (DestinationMismatch)

Несоответствие между целевыми URL объявлений.

destinationNotWorking

object (DestinationNotWorking)

Информация об ошибках HTTP или DNS, связанных с целевой страницей объявления.

trademark

object (Trademark)

Товарные знаки, которые привели к нарушению правил.

legalRemoval

object (LegalRemoval)

Принудительное применение юридических норм, которое привело к нарушению правил.

counterfeit

object (Counterfeit)

Принудительные меры в отношении поддельных товаров, которые привели к нарушению правил.

regionalRequirements

object (RegionalRequirements)

Принудительные меры, принятые командой Trust& Safety, которые привели к нарушению правил.

Конец взаимоисключающих полей.

TextList

Список фрагментов текста, нарушающих правила.

JSON-представление
{
  "texts": [
    string
  ]
}
Поля
texts[]

string

Фрагменты текста из ресурса, которые привели к нарушению правил.

WebsiteList

Список сайтов, нарушивших правила.

JSON-представление
{
  "websites": [
    string
  ]
}
Поля
websites[]

string

Сайты, на которых обнаружено нарушение правил.

DestinationTextList

Список текстов целевых страниц, нарушающих правила.

JSON-представление
{
  "destinationTexts": [
    string
  ]
}
Поля
destinationTexts[]

string

Текст целевой страницы, который привел к нарушению правил.

DestinationMismatch

Подробные сведения о несоответствии между типами целевых URL.

JSON-представление
{
  "uriTypes": [
    enum (AdPolicyTopicEvidenceDestinationMismatchUrlType)
  ]
}
Поля
uriTypes[]

enum (AdPolicyTopicEvidenceDestinationMismatchUrlType)

Набор URL, которые не совпадают. Список может содержать один или несколько типов URI.

Пример 1. [DISPLAY_URL, FINAL_URL] означает, что отображаемый URL объявления не совпадает с конечным URL объявления.

Пример 2. [FINAL_URL] означает, что конечный URL объявления не совпадает с просканированным URL, что также считается несоответствием целевой страницы.

AdPolicyTopicEvidenceDestinationMismatchUrlType

Возможные типы URL.

Перечисления
AD_POLICY_TOPIC_EVIDENCE_DESTINATION_MISMATCH_URL_TYPE_UNKNOWN Не указано или неизвестно.
DISPLAY_URL Отображаемый URL.
FINAL_URL Конечный URL.
FINAL_MOBILE_URL Конечный мобильный URL.
TRACKING_URL URL отслеживания.
MOBILE_TRACKING_URL URL отслеживания для мобильных устройств.

DestinationNotWorking

Подробные сведения об ошибках HTTP или DNS, связанных с целевой страницей объявления.

JSON-представление
{
  "expandedUri": string,
  "device": enum (AdPolicyTopicEvidenceDestinationNotWorkingDeviceType),
  "lastCheckedTime": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "dnsErrorType": enum (AdPolicyTopicEvidenceDestinationNotWorkingDnsErrorType),
  "httpErrorCode": string
  // End of mutually exclusive fields.
}
Поля
expandedUri

string

Полный URL, который не работает.

device

enum (AdPolicyTopicEvidenceDestinationNotWorkingDeviceType)

Устройство, на котором при попытке открыть URL возникла ошибка.

lastCheckedTime

string (Timestamp format)

Время, когда ошибка была зафиксирована в последний раз при переходе по URL.

Используется формат 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".

Ошибка HTTP или DNS. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
dnsErrorType

enum (AdPolicyTopicEvidenceDestinationNotWorkingDnsErrorType)

Тип ошибки DNS.

httpErrorCode

string (int64 format)

Код ошибки HTTP.

Конец взаимоисключающих полей.

AdPolicyTopicEvidenceDestinationNotWorkingDnsErrorType

Возможные типы ошибок DNS.

Перечисления
AD_POLICY_TOPIC_EVIDENCE_DESTINATION_NOT_WORKING_DNS_ERROR_TYPE_UNKNOWN Не указано или неизвестно.
HOSTNAME_NOT_FOUND При получении целевой страницы имя хоста не найдено в DNS.
GOOGLE_CRAWLER_DNS_ISSUE Google не удалось просканировать целевую страницу при взаимодействии с DNS.

AdPolicyTopicEvidenceDestinationNotWorkingDeviceType

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

Перечисления
AD_POLICY_TOPIC_EVIDENCE_DESTINATION_NOT_WORKING_DEVICE_TYPE_UNKNOWN Не указано или неизвестно.
DESKTOP Компьютер.
ANDROID Устройство Android.
IOS iOS-устройство.

Товарный знак

Товарные знаки, которые привели к нарушению правил.

JSON-представление
{
  "owner": string,
  "term": string,
  "countryRestrictions": [
    {
      object (AdPolicyCriterionRestriction)
    }
  ]
}
Поля
owner

string

Владелец товарного знака.

term

string

Товарный знак.

countryRestrictions[]

object (AdPolicyCriterionRestriction)

Страны, в которых действует нарушенное правило.

AdPolicyCriterionRestriction

Представляет ограничение для отдельных стран.

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

string (int64 format)

Идентификатор критерия страны.

countryLabel

string

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

LegalRemoval

Принудительное исполнение правовых норм, связанных с законом США "Об авторском праве в цифровую эпоху" (DMCA) или местным законодательством.

JSON-представление
{
  "complaintType": enum (AdPolicyTopicEvidenceLegalRemovalComplaintType),
  "countryRestrictions": [
    {
      object (AdPolicyCriterionRestriction)
    }
  ],
  "restrictedUris": [
    string
  ],

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "dmca": {
    object (Dmca)
  },
  "localLegal": {
    object (LocalLegal)
  }
  // End of mutually exclusive fields.
}
Поля
complaintType

enum (AdPolicyTopicEvidenceLegalRemovalComplaintType)

Тип жалобы, которая привела к удалению из-за нарушения закона.

countryRestrictions[]

object (AdPolicyCriterionRestriction)

Страны, в которых контент удален из-за нарушения закона.

restrictedUris[]

string

URL, доступ к которым ограничен в связи с удалением из-за нарушения закона.

Сведения о типе удаления из-за нарушения закона. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
dmca

object (Dmca)

Подробная информация об удалении контента в соответствии с законом США "Об авторском праве в цифровую эпоху" (DMCA).

Конец взаимоисключающих полей.

Закон США "Об авторском праве в цифровую эпоху" (DMCA)

Сведения о жалобе на нарушение авторских прав, поданной в соответствии с законом DMCA.

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

string

Лицо, подавшее жалобу на противозаконный контент.

LocalLegal

Сведения о местных законах.

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

string

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

AdPolicyTopicEvidenceLegalRemovalComplaintType

Возможные типы жалоб для удаления из-за нарушения закона.

Перечисления
COPYRIGHT

Нарушение авторских прав.

Применяется только к закону США "Об авторском праве в цифровую эпоху" (DMCA).

COURT_ORDER

Распоряжение суда.

Применяется только к местным юридическим лицам.

Поддельные товары

Подробные сведения о мерах, принятых в связи с нарушением правил в отношении поддельных товаров.

JSON-представление
{
  "owners": [
    string
  ]
}
Поля
owners[]

string

Владельцы контента или товаров, подавшие жалобу.

RegionalRequirements

Команда Trust & Safety (T&S) принимает упреждающие меры по обеспечению соблюдения правил, направленных на выполнение региональных требований. Это считается расследованием, проводимым Google, а не уведомлением о нарушении правил, поскольку это упреждающее применение Условий использования.

JSON-представление
{
  "regionalRequirementsEntries": [
    {
      object (RegionalRequirementsEntry)
    }
  ]
}
Поля
regionalRequirementsEntries[]

object (RegionalRequirementsEntry)

Список региональных требований.

RegionalRequirementsEntry

Сведения о нарушении региональных законов на уровне правил.

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

string

Правила в отношении юридических вопросов, которые нарушены.

countryRestrictions[]

object (AdPolicyCriterionRestriction)

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

AdPolicyTopicConstraint

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

JSON-представление
{
  "requestCertificateFormLink": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "countryConstraint": {
    object (AdPolicyCountryConstraintList)
  },
  "resellerConstraint": {
    object (AdPolicyResellerConstraint)
  },
  "certificateMissingCountryList": {
    object (AdPolicyCountryConstraintList)
  },
  "certificateDomainMismatchCountryList": {
    object (AdPolicyCountryConstraintList)
  },
  "globalCertificateMissing": {
    object (AdPolicyGlobalCertificateMissingConstraint)
  },
  "globalCertificateDomainMismatch": {
    object (AdPolicyGlobalCertificateDomainMismatchConstraint)
  }
  // End of mutually exclusive fields.
}
Поля
Ограничение показа. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
countryConstraint

object (AdPolicyCountryConstraintList)

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

resellerConstraint

object (AdPolicyResellerConstraint)

Ограничение для реселлеров.

certificateMissingCountryList

object (AdPolicyCountryConstraintList)

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

certificateDomainMismatchCountryList

object (AdPolicyCountryConstraintList)

Страны, в которых домен ресурса не охвачен связанными с ним сертификатами.

globalCertificateMissing

object (AdPolicyGlobalCertificateMissingConstraint)

Для показа в любой стране требуется сертификат.

globalCertificateDomainMismatch

object (AdPolicyGlobalCertificateDomainMismatchConstraint)

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

Конец взаимоисключающих полей.

AdPolicyCountryConstraintList

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

JSON-представление
{
  "countries": [
    {
      object (AdPolicyCriterionRestriction)
    }
  ]
}
Поля
countries[]

object (AdPolicyCriterionRestriction)

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

AdPolicyResellerConstraint

У этого типа нет полей.

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

AdPolicyGlobalCertificateMissingConstraint

У этого типа нет полей.

Для показа в любой стране требуется сертификат.

AdPolicyGlobalCertificateDomainMismatchConstraint

У этого типа нет полей.

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

AdPolicyTopicAppealInfo

Информация о том, как подать апелляцию на решение о нарушении правил.

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

enum (AdPolicyAppealType)

Можно ли подать апелляцию на решение самостоятельно или через форму.

AdPolicyAppealType

Возможные типы апелляций.

Перечисления
AD_POLICY_APPEAL_TYPE_UNKNOWN Неизвестно или не указано.
SELF_SERVICE_APPEAL Решение можно оспорить, подав апелляцию.
APPEAL_FORM Решение можно оспорить, заполнив форму апелляции.

AdUrl

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

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

enum (AdUrlType)

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

url

string

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

AdUrlType

Возможные типы URL объявлений.

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

DcmTrackingInfo

Подробная информация об отслеживании DCM.

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

string (int64 format)

Обязательно. Идентификатор места размещения DCM.

trackingAdId

string (int64 format)

Обязательно. Идентификатор отслеживающего объявления DCM.

creativeId

string (int64 format)

Обязательно. Идентификатор креатива DCM.

Методы

create

Создает объявление в группе объявлений.

delete

Удаляет объявление из группы.

get

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

list

Возвращает список объявлений в группе.

patch

Обновляет объявление в группе.