Lists guaranteed orders that are accessible to the current user. The order is defined by the order_by parameter. If a filter by entity_status is not specified, guaranteed orders with entity status ENTITY_STATUS_ARCHIVED
will not be included in the results.
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> guaranteed-orders list ...
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 has access to the guaranteed order.
-
-p filter=string
- Allows filtering by guaranteed order fields. * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by
AND
orOR
logical operators. A sequence of restrictions implicitly usesAND
. * A restriction has the form of{field} {operator} {value}
. * All fields must use theEQUALS (=)
operator. Supported fields: *guaranteed_order_id
*exchange
*display_name
*status.entityStatus
Examples: * All active guaranteed orders:status.entityStatus="ENTITY_STATUS_ACTIVE"
* Guaranteed orders belonging to Google Ad Manager or Rubicon exchanges:exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"
The length of this field should be no more than 500 characters. Reference our filterLIST
requests guide for more information.
- Allows filtering by guaranteed order fields. * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by
-
-p order-by=string
- Field by which to sort the list. Acceptable values are: *
displayName
(default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example,displayName desc
.
- Field by which to sort the list. Acceptable values are: *
-
-p page-size=integer
- Requested page size. Must be between
1
and200
. If unspecified will default to100
.
- 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
ListGuaranteedOrders
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
-
-p partner-id=string
- The ID of the partner that has access to the guaranteed order.
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").