Method: partners.channels.sites.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists sites in a channel.
HTTP request
GET https://displayvideo.googleapis.com/v1beta2/partners/{partnerId}/channels/{channelId}/sites
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
channelId |
string (int64 format)
Required. The ID of the parent channel to which the requested sites belong.
|
partnerId |
string (int64 format)
The ID of the partner that owns the parent channel.
|
Query parameters
| Parameters |
pageSize |
integer
Requested page size. Must be between 1 and 10000. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.
|
pageToken |
string
A token identifying a page of results the server should return. Typically, this is the value of nextPageToken returned from the previous call to sites.list method. If not specified, the first page of results will be returned.
|
orderBy |
string
Field by which to sort the list. Acceptable values are:
The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: urlOrAppId desc.
|
filter |
string
Allows filtering by site fields. Supported syntax:
- Filter expressions for site currently can only contain at most one
- restriction.
- A restriction has the form of
{field} {operator} {value}.
- The operator must be
CONTAINS (:).
- Supported fields:
Examples:
- All sites for which the URL or app ID contains "google":
urlOrAppId : "google"
|
advertiserId |
string (int64 format)
The ID of the advertiser that owns the parent channel.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of ListSitesResponse.
Authorization Scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/display-video
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 sites within a given channel using the \u003ccode\u003eGET\u003c/code\u003e method and specifying the \u003ccode\u003epartnerId\u003c/code\u003e and \u003ccode\u003echannelId\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eAllows for filtering, sorting, and pagination of results via query parameters such as \u003ccode\u003efilter\u003c/code\u003e, \u003ccode\u003eorderBy\u003c/code\u003e, and \u003ccode\u003epageSize\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/display-video\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eThe request body should be empty and a successful response returns a \u003ccode\u003eListSitesResponse\u003c/code\u003e object.\u003c/p\u003e\n"]]],[],null,["# Method: partners.channels.sites.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\nLists sites in a channel.\n\n### HTTP request\n\n`GET https://displayvideo.googleapis.com/v1beta2/partners/{partnerId}/channels/{channelId}/sites`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `channelId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Required. The ID of the parent channel to which the requested sites belong. |\n| `partnerId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` The ID of the partner that owns the parent channel. |\n\n### Query parameters\n\n| Parameters ||\n|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` Requested page size. Must be between `1` and `10000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. |\n| `pageToken` | `string` A token identifying a page of results the server should return. Typically, this is the value of [nextPageToken](/display-video/api/v1beta2/reference/rest/v1beta2/ListSitesResponse#FIELDS.next_page_token) returned from the previous call to `sites.list` method. If not specified, the first page of results will be returned. |\n| `orderBy` | `string` Field by which to sort the list. Acceptable values are: - `urlOrAppId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be added to the field name. Example: `urlOrAppId desc`. |\n| `filter` | `string` Allows filtering by site fields. Supported syntax: - Filter expressions for site currently can only contain at most one - restriction. - A restriction has the form of `{field} {operator} {value}`. - The operator must be `CONTAINS (:)`. - Supported fields: - `urlOrAppId` Examples: - All sites for which the URL or app ID contains \"google\": `urlOrAppId : \"google\"` |\n| `advertiserId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` The ID of the advertiser that owns the parent channel. |\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 [ListSitesResponse](/display-video/api/v1beta2/reference/rest/v1beta2/ListSitesResponse).\n\n### Authorization Scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/display-video`\n\nFor more information, see the [OAuth 2.0 Overview](https://developers.google.com/identity/protocols/OAuth2)."]]
