Method: networks.liveStreamEvents.adBreaks.create

  • This API is used to create an AdBreak object for a live stream event, informing DAI of an upcoming ad break with an optional expected start time.

  • Each live stream event can only have one incomplete ad break at a time, and the next can be scheduled after the previous is complete or deleted.

  • This method cannot be used if prefetching ad breaks are enabled for the LiveStreamEvent or if the event is not active.

  • The state of an ad break becomes complete when it shows in the live stream manifest and starts decisioning (Full service DAI) or when it is requested using the ad break ID or break sequence (Pod Serving).

  • The API uses a POST request to the specified URL, requires a parent path parameter to identify the live stream event, and includes an AdBreak instance in the request body.

API to create an AdBreak object.

Informs DAI of an upcoming ad break for a live stream event, with an optional expected start time. DAI will begin decisioning ads for the break shortly before the expected start time, if provided. Each live stream event can only have one incomplete ad break at any given time. The next ad break can be scheduled after the previous ad break has started serving, indicated by its state being COMPLETE, or it has been deleted.

This method cannot be used if the LiveStreamEvent has prefetching ad breaks enabled or the event is not active. If a LiveStreamEvent is deactivated after creating an ad break and before the ad break is complete, the ad break is discarded.

An ad break's state is complete when the following occurs: - Full service DAI: after a matching ad break shows in the LiveStreamEvent manifest only when the ad break has started decisioning. - Pod Serving: after the ad break is requested using the ad break ID or break sequence.

HTTP request

POST https://admanager.googleapis.com/v1/{parent}/adBreaks

Path parameters

Parameters
parent

string

Required. The parent resource where this AdBreak will be created identified by an asset key or custom asset key.

Formats: networks/{networkCode}/liveStreamEventsByAssetKey/{assetKey} networks/{networkCode}/liveStreamEventsByCustomAssetKey/{customAssetKey}

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 the following OAuth scope:

  • https://www.googleapis.com/auth/admanager

For more information, see the OAuth 2.0 Overview.