Эта страница переведена с помощью Cloud Translation API.

Early ad break notification

Использование API раннего уведомления о рекламной паузе

Примечание. Этот API все еще находится в стадии бета-тестирования. Если вы хотите запросить доступ к программе EABN, обратитесь к своему менеджеру по работе с клиентами.

API раннего уведомления о рекламной паузе (EABN) позволяет уведомить Google Ad Manager о предстоящей рекламной паузе с помощью его метаданных до начала рекламной паузы. Вы можете отправить запрос на уведомление не позднее, чем за час до рекламной паузы. В этом руководстве объясняется, как включить и использовать API EABN, а также примеры запросов и ответов.

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

Вызовы API EABN должны включать следующую информацию:

Идентификатор соответствующего прямого эфира, для которого создается рекламная пауза. Этот идентификатор может быть одним из следующих:
«Ключ актива» прямой трансляции.
«Пользовательский ключ актива» прямой трансляции, который позволяет вам управлять собственным пространством ключей, указав собственную строку идентификатора.
«Идентификатор источника контента» и «Идентификатор контента» прямой трансляции.

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

Ожидаемая продолжительность следующей рекламной паузы. Продолжительность должна быть как можно ближе к фактической продолжительности рекламной паузы.

В дополнение к этим обязательным полям вы также можете отправить параметры пользовательского таргетинга, имя применяемого шаблона рекламного блока или данные SCTE35 Cue Out, если они доступны.

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

Чтобы использовать EABN API, вам необходимо создать учетную запись службы и добавить ее в свою сеть Google Ad Manager.

Создание учетной записи службы

Чтобы создать учетную запись службы для вызова API EABN, выполните следующие действия: - Если у вас есть учетная запись Google Cloud, используйте модуль IAM для создания учетной записи службы. Дополнительную информацию см. в разделе Создание учетных записей служб и управление ими . - Если у вас нет учетной записи Google Cloud, выполните следующие шаги, чтобы создать ее в консоли Google API :

Создайте новый проект или выберите существующий проект.
На странице «Учетные данные» нажмите «Управление учетными записями служб» .
На странице «Служебные учетные записи» нажмите «СОЗДАТЬ СЕРВИСНУЮ АККАУНТ» .
На странице «Создать учетную запись службы» введите данные учетной записи. Затем нажмите СОЗДАТЬ .

После создания учетной записи службы скопируйте ключ JSON учетной записи, который используется для аутентификации.

Добавление сервисного аккаунта в сеть Google Ad Manager

Чтобы добавить учетную запись службы в свою сеть, выполните действия, описанные в разделе Добавление пользователя учетной записи службы для доступа к API .

Включение API

После создания учетной записи службы предоставьте следующую информацию своему менеджеру учетной записи, чтобы включить API для вашей учетной записи:

Адрес электронной почты вашего аккаунта Google Cloud.
Ваш сервисный аккаунт
Сетевой код вашей сети Google Ad Manager.

После включения API вашим менеджером аккаунта выполните следующие действия, чтобы включить API:

В библиотеке API Google найдите «API видео Google Ad Manager».
Нажмите ВКЛЮЧИТЬ .

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

Использование API

Вы можете вызвать API EABN, используя запросы JSON/REST.

Авторизация

Чтобы совершать авторизованные вызовы к API EABN, вам необходимо сгенерировать учетные данные учетной записи службы OAuth2, используя ключ JSON из вашей учетной записи службы и область действия https://www.googleapis.com/auth/video-ads . Дополнительные сведения см. в разделе Использование OAuth 2.0 для межсерверных приложений .

Вы должны включить полученный токен авторизации в качестве заголовка Auth для каждого вызова API EABN.

Отправка раннего уведомления о рекламной паузе

Чтобы отправить раннее уведомление о рекламной паузе, отправьте запрос POST на один из трех действительных URL-адресов EABN, в зависимости от того, как вы предпочитаете указать прямую трансляцию. В следующих разделах объясняются различия между URL-адресами и приводятся примеры запросов и ответов.

URL-адреса

Существует три действительных URL-адреса для раннего уведомления о рекламной паузе. Вы можете использовать все три типа для создания рекламной паузы ( POST ) или получения списка назначенных рекламных пауз ( GET ).

Чтобы использовать ключ актива прямой трансляции, используйте:

POST admanagervideo.googleapis.com/v1/networks/{network_code}/assets/{asset_key}/adBreaks

GET admanagervideo.googleapis.com/v1/networks/{network_code}/assets/{asset_key}/adBreaks

Чтобы использовать пользовательский ключ ресурса прямой трансляции, используйте:

POST admanagervideo.googleapis.com/v1/networks/{network_code}/customAssets/{custom_asset_key}/adBreaks

GET admanagervideo.googleapis.com/v1/networks/{network_code}/customAssets/{custom_asset_key}/adBreaks

Чтобы использовать подход Content Source ID и Content ID, используйте:

POST admanagervideo.googleapis.com/v1/networks/{network_code}/sources/{content_source_id}/content/{content_id}/adBreaks

GET admanagervideo.googleapis.com/v1/networks/{network_code}/sources/{content_source_id}/content/{content_id}/adBreaks

По всем параметрам:

network_code представляет собой сетевой код вашей сети Google Ad Manager.
asset_key представляет собой ключ актива, отображаемый на странице сведений о вашей прямой трансляции.
custom_asset_key представляет собой пользовательский ключ актива вашей прямой трансляции.
content_source_id представляет идентификатор источника контента в Google Ad Manager.
content_id представляет собой идентификатор части контента в Google Ad Manager.

Примечание. Указанная пара content_source_id / content_id должна быть связана с прямой трансляцией в Google Ad Manager.

Тело запроса — используется только для создания рекламной паузы (POST).

Объект
`expectedDuration`	Необходимый	Продолжительность рекламной паузы в стандартном формате Google (xx.xxxs, где xx.xxx — количество секунд).
`customParams`	Необязательный	Пары «ключ-значение» будут включены в запросы объявлений на этот перерыв для таргетинга по пользовательским критериям в AM360, разделенные `=` и к нему присоединился `&` . Пример: `key=value&key2=value2,value3` Дополнительную информацию о таргетинге см. в разделе Добавление параметров таргетинга в ваш поток .
`podTemplateName`	Необязательный	Название шаблона рекламного пакета
`scte35CueOut`	Необязательный	Данные в кодировке Base-64 из сигнала scte35. Может включать в себя `splice_insert()` или `time_signal()` команда. Примеры: время_сигнал(): `/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==` splice_insert(): `/DAvAAAAAAAA///wFAVIAACPf+/+c2nALv4AUsz1AAAAAAAKAAhDVUVJAAABNWLbowo=`

Примеры запросов

Создайте рекламную паузу

POST admanagervideo.googleapis.com/v1/networks/.../sources/.../content/.../adBreaks
Content-Type: application/json
Authorization: Bearer …
{
    "expectedDuration": "30s",
    "scte35CueOut": "/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==",
    "customParams": "param1=value1&param2=value2",
    "podTemplateName": "podtemplate"
}

Тело ответа

Тело ответа содержит все параметры, отправленные в объекте adBreak , а также дополнительное поле name , которое содержит стандартный идентификатор созданной рекламной паузы в масштабе всего Google. Это поле возвращается в следующем формате:

networks/{network_code}/assets/{asset_key}/adBreaks/{ad_break_id}

Пример ответа

HTTP/1.1 200 OK
{
  "name": "networks/.../assets/.../adBreaks/1",
  "expectedDuration": "30s",
  "scte35CueOut": "/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==",
  "customParams": "param1=value1&param2=value2",
  "podTemplateName": "podtemplate"
}

Список назначенных рекламных пауз

GET admanagervideo.googleapis.com/v1/networks/.../sources/.../content/.../adBreaks
Content-Type: application/json
Authorization: Bearer …

Тело ответа

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

 // Ad break decisioning has started.
BREAK_STATE_DECISIONED

// Break has started to be delivered to end users.
BREAK_STATE_COMPLETE

Пример ответа

HTTP/1.1 200 OK
{
  "name": "networks/.../assets/.../adBreaks/1",
  "expectedDuration": "30s",
  "breakState": "BREAK_STATE_COMPLETE"
}