Method: networks.liveStreamEvents.adBreaks.list
Stay organized with collections
Save and categorize content based on your preferences.
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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-20 UTC.
[null,null,["Last updated 2025-08-20 UTC."],[],[],null,["# Method: networks.liveStreamEvents.adBreaks.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nAPI to retrieve a list of `AdBreak` objects.\n\nBy 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.\n\n### HTTP request\n\n`GET https://admanager.googleapis.com/v1/{parent}/adBreaks`\n\n### Path parameters\n\n| Parameters ||\n|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `parent` | `string` Required. The parent, which owns this collection of AdBreaks. Formats: `networks/{networkCode}/liveStreamEventsByAssetKey/{assetKey}` `networks/{networkCode}/liveStreamEventsByCustomAssetKey/{customAssetKey}` |\n\n### Query parameters\n\n| Parameters ||\n|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `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`. |\n| `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. |\n| `filter` | `string` Optional. Expression to filter the response. See syntax details at \u003chttps://developers.google.com/ad-manager/api/beta/filters\u003e |\n| `orderBy` | `string` Optional. Expression to specify sorting order. See syntax details at \u003chttps://developers.google.com/ad-manager/api/beta/filters#order\u003e |\n| `skip` | `integer` Optional. Number of individual resources to skip while paginating. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [ListAdBreaksResponse](/ad-manager/api/beta/reference/rest/v1/ListAdBreaksResponse).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/admanager`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2)."]]
