Lists sites in a channel.
Scopes
You will need authorization for the https://www.googleapis.com/auth/display-video scope to make a valid call.
If unset, the scope for this method defaults to https://www.googleapis.com/auth/display-video.
You can set the scope for this method like this: displayvideo1 --scope <scope> partners channels-sites-list ...
Required Scalar Arguments
- <partner-id> (string)
- The ID of the partner that owns the parent channel.
- <channel-id> (string)
- Required. The ID of the parent channel to which the requested sites belong.
Optional Output Flags
The method's return value a JSON encoded structure, which will be written to standard output by default.
- -o out
- out specifies the destination to which to write the server's result to.
It will be a JSON-encoded structure.
The destination may be
-
to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.
- out specifies the destination to which to write the server's result to.
It will be a JSON-encoded structure.
The destination may be
Optional Method Properties
You may set the following properties to further configure the call. Please note that -p
is followed by one
or more key-value-pairs, and is called like this -p k1=v1 k2=v2
even though the listing below repeats the
-p
for completeness.
-
-p advertiser-id=string
- The ID of the advertiser that owns the parent channel.
-
-p filter=string
- Allows filtering by site fields. Supported syntax: * Filter expressions for site retrieval can only contain at most one restriction. * A restriction has the form of
{field} {operator} {value}
. * All fields must use theHAS (:)
operator. Supported fields: *urlOrAppId
Examples: * All sites for which the URL or app ID contains "google":urlOrAppId : "google"
The length of this field should be no more than 500 characters. Reference our filterLIST
requests guide for more information.
- Allows filtering by site fields. Supported syntax: * Filter expressions for site retrieval can only contain at most one restriction. * A restriction has the form of
-
-p order-by=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
.
- Field by which to sort the list. Acceptable values are: *
-
-p page-size=integer
- Requested page size. Must be between
1
and10000
. If unspecified will default to100
. Returns error codeINVALID_ARGUMENT
if an invalid value is specified.
- Requested page size. Must be between
-
-p page-token=string
- A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to
ListSites
method. If not specified, the first page of results will be returned.
- A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to
Optional General Properties
The following properties can configure any call, and are not specific to this method.
-
-p $-xgafv=string
- V1 error format.
-
-p access-token=string
- OAuth access token.
-
-p alt=string
- Data format for response.
-
-p callback=string
- JSONP
-
-p fields=string
- Selector specifying which fields to include in a partial response.
-
-p key=string
- API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
-
-p oauth-token=string
- OAuth 2.0 token for the current user.
-
-p pretty-print=boolean
- Returns response with indentations and line breaks.
-
-p quota-user=string
- Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
-
-p upload-type=string
- Legacy upload protocol for media (e.g. "media", "multipart").
-
-p upload-protocol=string
- Upload protocol for media (e.g. "raw", "multipart").