Early ad break notification v1
Оптимизируйте свои подборки
Сохраняйте и классифицируйте контент в соответствии со своими настройками.
- Идентификатор соответствующего прямого эфира, для которого создается рекламная пауза. Этот идентификатор может быть одним из следующих:
- «Ключ актива» прямой трансляции.
- «Пользовательский ключ актива» прямой трансляции, который позволяет вам управлять собственным пространством ключей, указав собственную строку идентификатора.
- «Идентификатор источника контента» и «Идентификатор контента» прямой трансляции.
Примечание. Чтобы использовать этот тип идентификатора, у вас должна быть включена эта функция. Для получения дополнительной информации свяжитесь с вашим менеджером по работе с клиентами.
- Ожидаемая продолжительность следующей рекламной паузы. Продолжительность должна быть как можно ближе к фактической продолжительности рекламной паузы.
В дополнение к этим обязательным полям вы также можете отправить параметры пользовательского таргетинга, имя применяемого шаблона рекламного блока или данные SCTE35 Cue Out, если они доступны.
Предварительные условия
Чтобы использовать EABN API, вам необходимо создать учетную запись службы и добавить ее в свою сеть Google Ad Manager.
Создание учетной записи службы
Чтобы создать учетную запись службы для вызова API EABN, выполните следующие действия: - Если у вас есть учетная запись Google Cloud, используйте модуль IAM для создания учетной записи службы. Дополнительную информацию см. в разделе Создание учетных записей служб и управление ими . – Если у вас нет учетной записи Google Cloud, выполните следующие шаги, чтобы создать ее в консоли Google API :
- Создайте новый проект или выберите существующий проект.
- На странице «Учетные данные» нажмите «Управление учетными записями служб» .
- На странице «Служебные учетные записи» нажмите «СОЗДАТЬ СЕРВИСНУЮ АККАУНТ» .
- На странице «Создать учетную запись службы» введите данные учетной записи. Затем нажмите СОЗДАТЬ .
После создания учетной записи службы скопируйте ключ JSON учетной записи, который используется для аутентификации.
Включение 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() команда.
Примеры: |
Примеры запросов
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¶m2=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¶m2=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"
}
Если не указано иное, контент на этой странице предоставляется по лицензии Creative Commons "С указанием авторства 4.0", а примеры кода – по лицензии Apache 2.0. Подробнее об этом написано в правилах сайта. Java – это зарегистрированный товарный знак корпорации Oracle и ее аффилированных лиц.
Последнее обновление: 2025-08-21 UTC.
[null,null,["Последнее обновление: 2025-08-21 UTC."],[[["\u003cp\u003eThe Early Ad Break Notification (EABN) API enables you to inform Google Ad Manager about upcoming ad breaks in live streams, including metadata, up to an hour in advance.\u003c/p\u003e\n"],["\u003cp\u003eTo use the EABN API, you must create a service account, add it to your Google Ad Manager network, and have the API enabled by your account manager.\u003c/p\u003e\n"],["\u003cp\u003eThe API requires the live stream identifier (asset key, custom asset key, or content source ID with content ID) and the expected ad break duration.\u003c/p\u003e\n"],["\u003cp\u003eYou can optionally include custom targeting parameters, an ad pod template name, and SCTE35 Cue Out data with your EABN requests.\u003c/p\u003e\n"],["\u003cp\u003eEABN requests are immutable, and subsequent requests for the same event are rejected until the break appears in the event's manifest.\u003c/p\u003e\n"]]],[],null,["# Early ad break notification v1\n\nUsing the Early Ad Break Notification API\n-----------------------------------------\n\n- The identifier of the corresponding live stream to which the ad break is being created. This identifier can be one of the following:\n- The \"Asset Key\" of the live stream.\n- The \"Custom Asset Key\" of the live stream, which allows you to manage your own key space by specifying your own identifier string.\n- The \"Content Source ID\" and the \"Content ID\" of the live stream.\n\nNote: You must be enabled to use this identifier type. For more information, contact your account manager.\n\n- The expected duration of the next ad break. The duration needs to be as close to the actual ad break length as possible.\n\nIn addition to these required fields, you can also send custom targeting parameters, the name of an ad pod template to apply, or SCTE35 Cue Out data, if available.\n\n### Prerequisites\n\nIn order to use the EABN API, you must create a service account and add the account to your Google Ad Manager network.\n\n#### Creating a service account\n\nTo create a service account for calling the EABN API, complete the following steps: - If you have a Google Cloud account, use the IAM module to create a service account. For more information, see [Creating and managing service accounts](//cloud.google.com/iam/docs/creating-managing-service-accounts). - If you do not have a Google Cloud account, complete the following steps to create one from the [Google API Console](//console.developers.google.com/apis/credentials/):\n\n1. Create a new project or select an existing project.\n2. In the **Credentials** page, click **Manage service accounts**.\n3. In the **Service accounts** page, click **CREATE SERVICE ACCOUNT**.\n4. In the **Create Service account** page, enter the account details. Then, click **CREATE**.\n\nOnce you have created a service account, copy the account's JSON key, which is used for authentication.\n\n#### Adding your service account to your Google Ad Manager network\n\nTo add your service account to your network, complete the steps in [Add a service account user for API access](//support.google.com/admanager/answer/6078734).\n\n### Enabling the API\n\nOnce you have created the service account, provide the following information to your account manager to enable the API for your account:\n\n- Your Google Cloud Account email address\n- Your service account\n- The Network Code of your Google Ad Manager Network.\n\nAfter the API has been enabled by your account manager, complete the following steps to enable the API:\n\n1. In the [Google API library](//console.developers.google.com/apis/library), search for \"Google Ad Manager Video API\".\n2. Click **ENABLE**.\n\nNote: If the API does not appear in the search results, contact your account manager to confirm that your account has been enabled for the DAI API.\n\n### Using the API\n\nYou can call the EABN API using JSON/REST requests.\n\n#### Authorization\n\nTo make authorized calls to the EABN API, you need to generate OAuth2 service account credentials using the JSON key from your service account and the scope `https://www.googleapis.com/auth/video-ads`. For more information, see [Using OAuth 2.0 for Server to Server Applications](https://developers.google.com/identity/protocols/oauth2/service-account).\n\nYou must include the resulting authorization token as an Auth header for each call to the EABN API.\n\n#### Sending an early ad break notification\n\nTo send an early ad break notification, send a POST request to one of the three valid EABN URLs, depending on how you prefer to specify the live stream. The following sections explain the differences between the URLs and provide request and response examples.\n\n##### URLs\n\nThere are three valid URLs for early ad break notification. You can use all three types to create an ad break (`POST`) or get the list of assigned ad breaks (`GET`).\n\nTo use the asset key of a live stream, use: \n\n POST admanagervideo.googleapis.com/v1/networks/{network_code}/assets/{asset_key}/adBreaks\n\n GET admanagervideo.googleapis.com/v1/networks/{network_code}/assets/{asset_key}/adBreaks\n\nTo use the custom asset key of a live stream, use: \n\n POST admanagervideo.googleapis.com/v1/networks/{network_code}/customAssets/{custom_asset_key}/adBreaks\n\n GET admanagervideo.googleapis.com/v1/networks/{network_code}/customAssets/{custom_asset_key}/adBreaks\n\nTo use the Content Source ID and Content ID approach, use: \n\n POST admanagervideo.googleapis.com/v1/networks/{network_code}/sources/{content_source_id}/content/{content_id}/adBreaks\n\n GET admanagervideo.googleapis.com/v1/networks/{network_code}/sources/{content_source_id}/content/{content_id}/adBreaks\n\nFor all the parameters:\n\n- `network_code` represents the network code of your Google Ad Manager network.\n- `asset_key` represents the asset key shown in your live stream details page.\n- `custom_asset_key` represents the custom asset key of your live stream.\n- `content_source_id` represents the id of a content source in Google Ad Manager.\n- `content_id` represents the id of a piece of content in Google Ad Manager.\n\nNote: The specified `content_source_id`/`content_id` pair must be associated with a live stream in Google Ad Manager.\n\n##### Request body - only used to create an Ad Break (POST)\n\n\u003cbr /\u003e\n\n| Object |||\n| \u003cbr /\u003e `expectedDuration` \u003cbr /\u003e | Required | The duration of this ad break, using Google's standard duration format (xx.xxxs where xx.xxx is the number of seconds) |\n| \u003cbr /\u003e `customParams` \u003cbr /\u003e | Optional | Key-value pairs to be included on ad requests for this break for custom criteria targeting in AM360, separated by \u003cbr /\u003e `=` and joined by `&` . Example: `key=value&key2=value2,value3` \u003cbr /\u003e For more information on targeting, see [Supply targeting parameters to your stream](//support.google.com/admanager/answer/7320899). |\n| \u003cbr /\u003e `podTemplateName` \u003cbr /\u003e | Optional | The ad pod template name |\n| \u003cbr /\u003e `scte35CueOut` \u003cbr /\u003e | Optional | Base-64-encoded data from the scte35 cue out. Can include the \u003cbr /\u003e `splice_insert()` or `time_signal()` command. Examples: - time_signal(): \u003cbr /\u003e `/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==` \u003cbr /\u003e - splice_insert(): \u003cbr /\u003e `/DAvAAAAAAAA///wFAVIAACPf+/+c2nALv4AUsz1AAAAAAAKAAhDVUVJAAABNWLbowo=` \u003cbr /\u003e |\n|----------------------------------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n\n\u003cbr /\u003e\n\n### Example requests\n\n##### Create an Ad Break\n\n POST admanagervideo.googleapis.com/v1/networks/.../sources/.../content/.../adBreaks\n Content-Type: application/json\n Authorization: Bearer ...\n {\n \"expectedDuration\": \"30s\",\n \"scte35CueOut\": \"/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==\",\n \"customParams\": \"param1=value1¶m2=value2\",\n \"podTemplateName\": \"podtemplate\"\n }\n\n###### Response body\n\nThe response body contains all of the parameters sent in the `adBreak` object, as well as an additional `name` field, which contains the Google-wide standard ID of the created ad break. This field is returned in the following format: \n\n networks/{network_code}/assets/{asset_key}/adBreaks/{ad_break_id}\n\n###### Example response\n\n HTTP/1.1 200 OK\n {\n \"name\": \"networks/.../assets/.../adBreaks/1\",\n \"expectedDuration\": \"30s\",\n \"scte35CueOut\": \"/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==\",\n \"customParams\": \"param1=value1¶m2=value2\",\n \"podTemplateName\": \"podtemplate\"\n }\n\n##### List assigned Ad Breaks\n\n GET admanagervideo.googleapis.com/v1/networks/.../sources/.../content/.../adBreaks\n Content-Type: application/json\n Authorization: Bearer ...\n\n###### Response body\n\nThe response body contains the ad breaks with an additional `breakState` field for each ad break assigned to the stream. `breakState` field supports the following values: \n\n // Ad break decisioning has started.\n BREAK_STATE_DECISIONED\n\n // Break has started to be delivered to end users.\n BREAK_STATE_COMPLETE\n\n###### Example response\n\n HTTP/1.1 200 OK\n {\n \"name\": \"networks/.../assets/.../adBreaks/1\",\n \"expectedDuration\": \"30s\",\n \"breakState\": \"BREAK_STATE_COMPLETE\"\n }"]]
