Method: networks.liveStreamEvents.adBreaks.list

  • This API retrieves a list of AdBreak objects.

  • By default, ad breaks are ordered reverse chronologically, but scheduled or decisioned ad breaks appear first.

  • The API uses a GET request with specific path and optional query parameters.

  • The request body must be empty, and a successful response returns a ListAdBreaksResponse.

  • Authorization requires the https://www.googleapis.com/auth/admanager OAuth scope.

API to retrieve a list of AdBreak objects.

By default, when no orderBy query parameter is specified, ad breaks are ordered reverse chronologically. However, ad breaks with a 'breakState' of 'SCHEDULED' or 'DECISIONED' are prioritized and appear first.

HTTP request

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

Path parameters

Parameters
parent

string

Required. The parent, which owns this collection of AdBreaks.

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

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of AdBreaks to return. The service might return fewer than this value. If unspecified, at most 10 ad breaks are returned. The maximum value is 100. Values above 100 are coerced to 100.
pageToken

string

Optional. A page token, received from a previous adBreaks.list call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to adBreaks.list must match the call that provided the page token.
filter

string

Optional. Expression to filter the response. See syntax details at https://developers.google.com/ad-manager/api/beta/filters
orderBy

string

Optional. Expression to specify sorting order. See syntax details at https://developers.google.com/ad-manager/api/beta/filters#order
skip

integer

Optional. Number of individual resources to skip while paginating.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of ListAdBreaksResponse.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.