Method: networks.liveStreamEventsByCustomAssetKey.adBreaks.get

  • The API allows retrieval of an AdBreak object using its resource name or custom asset key.

  • The state of the ad break can be determined by checking the breakState field of the returned resource.

  • The HTTP request method is GET and requires the resource name in the path parameters.

  • The request body for this API call must be empty.

  • A successful response body contains an instance of the AdBreak object.

  • The API requires the https://www.googleapis.com/auth/admanager OAuth scope for authorization.

API to retrieve an AdBreak object.

Query an ad break by its resource name or custom asset key. Check the resource's breakState field to determine its state.

HTTP request

GET https://admanager.googleapis.com/v1/{name}

Path parameters

Parameters
name

string

Required. The resource name of the AdBreak using the asset key or custom asset key.

Format: networks/{networkCode}/liveStreamEventsByAssetKey/{assetKey}/adBreaks/{adBreakId} networks/{networkCode}/liveStreamEventsByCustomAssetKey/{customAssetKey}/adBreaks/{adBreakId}

Request body

The request body must be empty.

Response body

If successful, the response body contains an 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.