Method: sellers.adUnits.impressionSchedules.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists impression schedules.
- For example GET /v1/sellers/111/adUnits/222
- Returns a list of impression schedules and a token to retrieve the next page if successful.
- Returns error code
PERMISSION_DENIED if the user does not have access to the seller or seller id does not exist.
- Returns error code
INVALID_ARGUMENT if sellers provide an invalid page size or page token.
HTTP request
GET https://dv360outofhomeseller.googleapis.com/v1/{parent=sellers/*/adUnits/*}/impressionSchedules
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. The parent, which owns this collection of impression schedules. Format: sellers/{seller}/adUnits/{adUnit}
|
Query parameters
| Parameters |
pageSize |
integer
The maximum number of items to return. The service may return fewer than this value. Max allowed number of impression schedules is 1000; values above 1000 will be changed to 1000. If unspecified, at most 1000 impression schedules will be returned.
|
pageToken |
string
The nextPageToken value returned from a previous List request, if any.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
Response message for InventoryService.ListImpressionSchedules.
| JSON representation |
{
"impressionSchedules": [
{
object (ImpressionSchedule)
}
],
"nextPageToken": string
} |
| Fields |
impressionSchedules[] |
object (ImpressionSchedule)
The list of impression schedules.
|
nextPageToken |
string
A token to retrieve the next page of results. Pass this value in the [pageToken][ListImpressionScheduleRequest.page_token] field in the subsequent call to impressionSchedules.list method to retrieve the next page of results.
|
Authorization Scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/doubleclickbidmanager
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 2024-09-18 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-18 UTC."],[[["\u003cp\u003eLists impression schedules for a given ad unit within a specified seller.\u003c/p\u003e\n"],["\u003cp\u003eAllows pagination through results using \u003ccode\u003epageSize\u003c/code\u003e and \u003ccode\u003epageToken\u003c/code\u003e for large datasets.\u003c/p\u003e\n"],["\u003cp\u003eRequires \u003ccode\u003edoubleclickbidmanager\u003c/code\u003e authorization scope for access.\u003c/p\u003e\n"],["\u003cp\u003eReturns potential errors like \u003ccode\u003ePERMISSION_DENIED\u003c/code\u003e or \u003ccode\u003eINVALID_ARGUMENT\u003c/code\u003e based on user access and input.\u003c/p\u003e\n"],["\u003cp\u003eProvides a JSON response containing an array of \u003ccode\u003eimpressionSchedules\u003c/code\u003e and a \u003ccode\u003enextPageToken\u003c/code\u003e if applicable.\u003c/p\u003e\n"]]],[],null,["- [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 - [JSON representation](#body.ListImpressionSchedulesResponse.SCHEMA_REPRESENTATION)\n- [Authorization Scopes](#body.aspect)\n- [Examples](#examples)\n\nLists impression schedules.\n\n- For example GET /v1/sellers/111/adUnits/222\n- Returns a list of impression schedules and a token to retrieve the next page if successful.\n- Returns error code `PERMISSION_DENIED` if the user does not have access to the seller or seller id does not exist.\n- Returns error code `INVALID_ARGUMENT` if sellers provide an invalid page size or page token.\n\nHTTP request\n\n`GET https://dv360outofhomeseller.googleapis.com/v1/{parent=sellers/*/adUnits/*}/impressionSchedules`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\nPath parameters\n\n| Parameters ||\n|----------|------------------------------------------------------------------------------------------------------------------------------|\n| `parent` | `string` Required. The parent, which owns this collection of impression schedules. Format: sellers/{seller}/adUnits/{adUnit} |\n\nQuery parameters\n\n| Parameters ||\n|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` The maximum number of items to return. The service may return fewer than this value. Max allowed number of impression schedules is 1000; values above 1000 will be changed to 1000. If unspecified, at most 1000 impression schedules will be returned. |\n| `pageToken` | `string` The nextPageToken value returned from a previous List request, if any. |\n\nRequest body\n\nThe request body must be empty.\n\nResponse body\n\nIf successful, the response body contains data with the following structure:\nResponse message for InventoryService.ListImpressionSchedules.\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"impressionSchedules\": [ { object (/display-video/out-of-home-seller/reference/rest/v1/sellers.adUnits.impressionSchedules#ImpressionSchedule) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `impressionSchedules[]` | `object (`[ImpressionSchedule](/display-video/out-of-home-seller/reference/rest/v1/sellers.adUnits.impressionSchedules#ImpressionSchedule)`)` The list of impression schedules. |\n| `nextPageToken` | `string` A token to retrieve the next page of results. Pass this value in the \\[pageToken\\]\\[ListImpressionScheduleRequest.page_token\\] field in the subsequent call to `impressionSchedules.list` method to retrieve the next page of results. |\n\nAuthorization Scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/doubleclickbidmanager`\n\nFor more information, see the [OAuth 2.0 Overview](https://developers.google.com/identity/protocols/OAuth2)."]]
