Package google.ads.drx.video.v1

Индекс

Служба уведомлений AdBreak

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

СоздатьAdBreak

rpc CreateAdBreak( CreateAdBreakRequest ) returns ( AdBreak )

API для создания рекламной паузы в прямой трансляции.

Области авторизации

Требуется одна из следующих областей OAuth:

  • https://www.googleapis.com/auth/contentingestion
  • https://www.googleapis.com/auth/video-ads

Дополнительную информацию см. в обзоре OAuth 2.0 .

СписокAdBreaks

rpc ListAdBreaks( ListAdBreaksRequest ) returns ( ListAdBreaksResponse )

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

Области авторизации

Требуется одна из следующих областей OAuth:

  • https://www.googleapis.com/auth/contentingestion
  • https://www.googleapis.com/auth/video-ads

Дополнительную информацию см. в обзоре OAuth 2.0 .

Служба VideoContentIngestionService

Служба API для приема контента, которая позволяет создавать или обновлять видеоконтент и связанные с ним метаданные в Google Ad Manager.

ОбновитьВидеоКонтент

rpc UpdateVideoContent( UpdateVideoContentRequest ) returns ( VideoContent )

API для создания нового контента или обновления его метаданных, если контент уже существует в Менеджере рекламы. Возвращает содержимое в случае успеха или google.rpc.Code в случае неудачи.

Пример запроса выглядит так:

{
   "status": "ACTIVE",
   "title": "Best video ever",
   "updateTime": "2019-01-24T01:30:15.01Z",
   "duration": "230s",
   "cuePoints": ["55.532s", "192s"],
   "publishTime": "2019-01-24T01:30:15.01Z",
   "thumbnailUrl": "http://www.domain.com/tn.jpg",
   "metadata": {
       "keyValues": {
           "category": "sports",
           "tag": ["soccer", "messi"],
       }
   }
}
Области авторизации

Требуется одна из следующих областей OAuth:

  • https://www.googleapis.com/auth/contentingestion
  • https://www.googleapis.com/auth/video-ads

Дополнительную информацию см. в обзоре OAuth 2.0 .

Рекламная пауза

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

Поля
name

string

Только вывод. Имя ресурса рекламной паузы. Это поле будет иметь формат «сети/ /ресурсы/ /рекламные перерывы/ ".

network_code – это код сети в Google Ad Manager, которому принадлежит этот контент.

assets_key — это ключ события прямой трансляции в Google Ad Manage, под которым была создана рекламная пауза.

ad_break_id — ключ рекламной паузы. ТОЛЬКО ВЫВОД.

expected_duration

Duration

Необходимый. Ожидаемая продолжительность перерыва.

custom_params

string

Пары «ключ-значение» будут включены в запросы объявлений на этот перерыв для таргетинга по пользовательским критериям в Менеджере рекламы. Пример: 'ключ1=значение&ключ2=значение2,значение22'

scte_35_cue_out

string

Данные в кодировке Base 64 из сигнала scte35. Может включать команду splice_insert() или time_signal(). Примеры: - с time_signal(): «/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==» - с splice_insert(): «/DAvAAAAAAAA///wFAVIAACPf+/+c2nALv4AUsz1AAAAAAAAhDVUVJAAABNWL Боуо="

pod_template_name

string

Название шаблона модуля Google Ad Manager.

break_state

BreakState

Текущее состояние рекламной паузы.

состояние разрыва

Состояние рекламной паузы.

Перечисления
BREAK_STATE_UNSPECIFIED Состояние рекламной паузы неизвестно.
BREAK_STATE_DECISIONED Решение о рекламной паузе началось, но еще не доставлено пользователям.
BREAK_STATE_COMPLETE Рекламная пауза была доставлена ​​пользователям.

ClosedCaptionFormat

Форматы, в которых могут быть файлы субтитров.

Перечисления
CLOSED_CAPTION_FORMAT_UNSPECIFIED Формат субтитров не указан.
TTML приложение/ttaf+xml
WEB_VTT текст/ВТТ

ClosedCaptionUrlInfo

Метаданные для одного файла субтитров.

Поля
language_code

string

Языковой код IETF BCP-47, представляющий язык, на котором находится файл субтитров.

closed_caption_format

ClosedCaptionFormat

Формат файла субтитров.

url

string

URL-адрес файла субтитров.

Создать запрос AdBreak

Запрос для AdBreakNotificationService.CreateAdBreak .

Поля
parent

string

В этом поле указывается событие LiveStreamEvent, с которым должна быть связана эта рекламная пауза с использованием ключа ресурса прямой трансляции. Он должен иметь формат «networks/{network_code}/assets/{asset_code}».

custom_parent

string

В этом поле указывается событие LiveStreamEvent, с которым должна быть связана эта рекламная пауза с помощью пользовательского ключа актива. Он должен иметь формат «networks/{network_code}/customAssets/{asset_code}».

content

string

Это альтернативный способ идентификации LiveStreamEvent, если он связан с частью контента в GAM. Он должен иметь формат «networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}».

ad_break

AdBreak

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

ad_break_id

string

Это ad_break_id, который пользователи могут предоставить через запрос.

Динамиадинсертионинформо

Информация, касающаяся динамической вставки объявлений.

Поля
video_ingest_url_info

VideoIngestUrlInfo

Ссылка на главный файл m3u8, который используется для настройки и создания списка воспроизведения.

media_update_time

Timestamp

Время последнего изменения видеофайла, указанного в video_ingest_url_info.

closed_caption_url_info[]

ClosedCaptionUrlInfo

URL-адрес файла скрытых титров/субтитров.

fw_caid

string

Идентификатор пользовательского ресурса Freewheel, используемый для таргетинга рекламы.

GracenoteМетаданные

Метаданные Gracenote для содержимого.

Поля
gracenote_id

string

Необходимый. Относится к идентификатору Gracenote для содержимого. Должен иметь один из следующих допустимых префиксов: 1. «EP» — эпизод сериала 2. «MV» — фильм 3. «SP» — спортивное событие.

gracenote_series_id

string

Необязательный. Это поле относится к идентификатору серии Gracenote. Должен иметь префикс «SH».

ListAdBreaksЗапрос

Запрос для AdBreakNotificationService.ListAdBreaks .

Поля
parent

string

Необязательный. В этом поле указывается событие LiveStreamEvent, с которым должна быть связана эта рекламная пауза с использованием ключа ресурса прямой трансляции. Он должен иметь формат «networks/{network_code}/assets/{asset_code}».

custom_parent

string

Необязательный. В этом поле указывается событие LiveStreamEvent, с которым должна быть связана эта рекламная пауза с помощью пользовательского ключа актива. Он должен иметь формат «networks/{network_code}/customAssets/{asset_code}».

content

string

Необязательный. Это альтернативный способ идентификации LiveStreamEvent, если он связан с частью контента в GAM. Он должен иметь формат «networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}».

page_size

int32

Необязательный. Максимальное количество рекламных пауз для возврата. Служба может возвращать меньшее значение, чем это значение. Если не указано, будет возвращено не более 10 рекламных пауз. Максимальное значение — 100; значения выше 100 будут приведены к 100.

page_token

string

Необязательный. Токен страницы, полученный в результате предыдущего вызова ListAdBreaks . Предоставьте это, чтобы получить следующую страницу.

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

ListAdBreaksResponse

Ответ для AdBreakNotificationService.ListAdBreaks .

Поля
ad_breaks[]

AdBreak

Только вывод. Список рекламных пауз, соответствующих запрошенному LiveStreamEvent.

next_page_token

string

Токен, который можно отправить как page_token для получения следующей страницы. Если это поле опущено, последующие страницы отсутствуют.

Метаданные

Пользовательские метаданные контента.

Поля
key_values

map<string, Value >

Идентифицирует пользовательские метаданные контента как пару ключ-значение. В качестве значений принимаются только строки или список строк.

Синдицированные видеоконтентыИмена

Список названий всего синдицированного контента.

Поля
syndicated_video_content[]

string

Повторяющееся поле названия синдицированного контента. Они должны иметь формат «networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}» и должны принадлежать той же сети, что и контент, содержащий это поле.

ОбновитьВидеоКонтентЗапрос

Запрос для [VideoContentIngestionService.UpdateVideoContentRequest][].

Поля
video_content

VideoContent

Необходимый. Метаданные контента.

Видеоконтент

Метаданные контента.

Поля
name

string

Только вывод. Имя ресурса видеоконтента. Это поле имеет формат: 'networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}'.

network_code – это код сети в Google Ad Manager, которому принадлежит этот контент.

content_source_id — идентификатор источника контента в Google Ad Manager, которому должен принадлежать этот контент.

cms_content_id — это идентификатор контента CMS в Google Ad Manager, формируемый как часть запроса объявления для определения того, какие объявления Менеджер рекламы может показывать в отношении соответствующего видео. Это значение может быть числовым или буквенно-цифровым.

status

VideoContentStatus

Статус контента. Если это значение опущено, значение по умолчанию будет активным.

title

string

Необходимый. Название контента.

update_time

Timestamp

Необходимый. Время последнего изменения содержимого.

publish_time

Timestamp

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

duration

Duration

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

cue_points[]

Duration

Определяет ключевые точки. Ключевые точки — это места во времени, где в видео можно вставить рекламу. Точки разметки поддерживаются вплоть до миллисекундного уровня. Это обязательное поле, если в видео есть рекламные паузы в середине ролика.

thumbnail_url

string

URL-адрес миниатюры контента.

metadata

Metadata

Идентифицирует пользовательские метаданные контента.

gracenote_metadata

GracenoteMetadata

Метаданные контента, связанные с Gracenote.

syndication_metadata

VideoContentSyndicationInfo

Метаданные контента, связанные с синдикацией.

dynamic_ad_insertion_metadata

DynamicAdInsertionInfo

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

Статус видеоконтента

Параметры статуса: показывать или не показывать целевую рекламу для контента.

Перечисления
ACTIVE Будут показаны объявления, ориентированные на контент.
BLOCKED Никакая реклама не будет показываться на этом контенте, если у него статус ЗАБЛОКИРОВАНО.
DELETED Содержимое будет заархивировано в Менеджере рекламы. Если Менеджер рекламы получает запрос на объявление для контента, помеченного как УДАЛЕНО, то собственные объявления или объявления, ориентированные на единицы инвентаря или другие критерии таргетинга, все равно могут показываться по нему. Чтобы заблокировать рекламу, установите статус ЗАБЛОКИРОВАНО.

ВидеоконтентСиндикацияИнформация

Метаданные для определения отношений между каноническим и синдицированным контентом.

Поля
syndication полей Союза. VideoContentSyndiationMetadata может содержать только одно из следующих значений. syndication может быть только одной из следующих:
canonical_video_content

string

Название канонического контента. Оно должно иметь формат «networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}» и должно принадлежать той же сети, что и контент, содержащий это поле.

syndicated_video_content_names

SyndicatedVideoContentNames

Коллекция синдицированного контента

Видеоформат

Форматы, в которых может быть закодирован видеоконтент.

Перечисления
VIDEO_FORMAT_UNSPECIFIED Формат видео не указан.
HLS приложение/x-mpegURL
DASH приложение/тире+xml

Видеоинжестурлинформо

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

Поля
video_format

VideoFormat

Формат видео.

video_preconditioned

VideoPreconditioned

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

url

string

Ссылка на файл m3u8.

ВидеоПредварительное условие

Условное состояние видеоконтента.

Перечисления
NO Еще не кондиционирован.
YES Видео было обработано/разделено.