AI-generated Key Takeaways
-
The API creates an Ad Break within a live stream using an HTTP POST request.
-
You can specify the parent LiveStreamEvent using path parameters, query parameters, or by referencing associated content within GAM.
-
The request body requires an instance of AdBreak, and the response body returns a newly created AdBreak instance upon success.
-
The API requires one of two specific OAuth scopes for authorization.
API to create an Ad Break within the live stream.
HTTP request
POST https://admanagervideo.googleapis.com/v1/{parent=networks/*/assets/*}/adBreaks
The URL uses gRPC Transcoding syntax.
Path 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}" |
Query 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}" |
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.