AI-generated Key Takeaways
-
This document outlines the API for creating an Ad Break within a live stream.
-
The API uses a POST request with a specific URL format and can utilize gRPC Transcoding syntax.
-
Parameters for the request can be passed through the path and query, identifying the LiveStreamEvent and optionally providing an ad break ID.
-
The request body requires an instance of AdBreak, and a successful response returns a newly created AdBreak instance.
-
Authorization requires specific OAuth scopes for content ingestion or video ads.
API to create an Ad Break within the live stream.
HTTP request
POST https://admanagervideo.googleapis.com/v1/{customParent=networks/*/customAssets/*}/adBreaks
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
customParent |
This field identifies the LiveStreamEvent that this ad break should be associated to using the custom asset key. It must have the format of "networks/{network_code}/customAssets/{asset_code}" |
Query parameters
Parameters | |
---|---|
parent |
This field identifies the LiveStreamEvent that this ad break should be associated to using the live stream asset key. It must have the format of "networks/{network_code}/assets/{asset_code}" |
content |
This is an alternative way to identify the LiveStreamEvent, if it's associated with a piece of content within GAM. It must have the format of "networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}" |
adBreakId |
This is the adBreakId that users can provide through the request. |
Request body
The request body contains an instance of AdBreak
.
Response body
If successful, the response body contains a newly created instance of AdBreak
.
Authorization Scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/contentingestion
https://www.googleapis.com/auth/video-ads
For more information, see the OAuth 2.0 Overview.