Struct google_displayvideo1::AdvertiserCreativeListCall

pub struct AdvertiserCreativeListCall<'a, C, A> where
    C: 'a,
    A: 'a,  { /* fields omitted */ }

Lists creatives in an advertiser.

The order is defined by the order_by parameter. If a filter by entity_status is not specified, creatives with ENTITY_STATUS_ARCHIVED will not be included in the results.

A builder for the creatives.list method supported by a advertiser resource. It is not used directly, but through a AdvertiserMethods instance.

Example

Instantiate a resource method builder

 
// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.advertisers().creatives_list("advertiserId")
             .page_token("labore")
             .page_size(-61)
             .order_by("et")
             .filter("sadipscing")
             .doit();

Implementations

impl<'a, C, A> AdvertiserCreativeListCall<'a, C, A> where
    C: BorrowMut<Client>,
    A: GetToken, 

pub fn doit(self) -> Result<(Response, ListCreativesResponse)>

Perform the operation you have build so far.

pub fn advertiser_id(
    self,
    new_value: &str
) -> AdvertiserCreativeListCall<'a, C, A>

Required. The ID of the advertiser to list creatives for.

Sets the advertiser id path property to the given value.

Even though the property as already been set when instantiating this call, we provide this method for API completeness.

pub fn page_token(self, new_value: &str) -> AdvertiserCreativeListCall<'a, C, A>

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 ListCreatives method. If not specified, the first page of results will be returned.

Sets the page token query property to the given value.

pub fn page_size(self, new_value: i32) -> AdvertiserCreativeListCall<'a, C, A>

Requested page size. Must be between 1 and 100. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

Sets the page size query property to the given value.

pub fn order_by(self, new_value: &str) -> AdvertiserCreativeListCall<'a, C, A>

Field by which to sort the list. Acceptable values are:

• creativeId (default)
• createTime
• mediaDuration
• dimensions (sorts by width first, then by height)

The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: createTime desc.

Sets the order by query property to the given value.

pub fn filter(self, new_value: &str) -> AdvertiserCreativeListCall<'a, C, A>

Allows filtering by creative properties.

Supported syntax:

• Filter expressions are made up of one or more restrictions.
• Restriction for the same field must be combined by OR.
• Restriction for different fields must be combined by AND.
• Between ( and ) there can only be restrictions combined by OR for the same field.
• A restriction has the form of {field} {operator} {value}.
• The operator must be EQUALS (=) for the following fields:
  • entityStatus
  • creativeType.
  • dimensions
  • minDuration
  • maxDuration
  • approvalStatus
  • exchangeReviewStatus
  • dynamic
  • creativeId
• The operator must be HAS (:) for the following fields:
  • lineItemIds
• For entityStatus, minDuration, maxDuration, and dynamic there may be at most one restriction.
• For dimensions, the value is in the form of "{width}x{height}".
• For exchangeReviewStatus, the value is in the form of {exchange}-{reviewStatus}.
• For minDuration and maxDuration, the value is in the form of "{duration}s". Only seconds are supported with millisecond granularity.
• There may be multiple lineItemIds restrictions in order to search against multiple possible line item IDs.
• There may be multiple creativeId restrictions in order to search against multiple possible creative IDs.

Examples:

• All native creatives: creativeType="CREATIVE_TYPE_NATIVE"
• All active creatives with 300x400 or 50x100 dimensions: entityStatus="ENTITY_STATUS_ACTIVE" AND (dimensions="300x400" OR dimensions="50x100")
• All dynamic creatives that are approved by AdX or AppNexus, with a minimum duration of 5 seconds and 200ms. dynamic="true" AND minDuration="5.2s" AND (exchangeReviewStatus="EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED" OR exchangeReviewStatus="EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED")
• All video creatives that are associated with line item ID 1 or 2: creativeType="CREATIVE_TYPE_VIDEO" AND (lineItemIds:1 OR lineItemIds:2)
• Find creatives by multiple creative IDs: creativeId=1 OR creativeId=2

The length of this field should be no more than 500 characters.

Sets the filter query property to the given value.

pub fn delegate(
    self,
    new_value: &'a mut dyn Delegate
) -> AdvertiserCreativeListCall<'a, C, A>

The delegate implementation is consulted whenever there is an intermediate result, or if something goes wrong while executing the actual API request.

It should be used to handle progress information, and to implement a certain level of resilience.

Sets the delegate property to the given value.

pub fn param<T>(self, name: T, value: T) -> AdvertiserCreativeListCall<'a, C, A> where
    T: AsRef<str>, 

Set any additional parameter of the query string used in the request. It should be used to set parameters which are not yet available through their own setters.

Please note that this method must not be used to set any of the known parameters which have their own setter method. If done anyway, the request will fail.

Additional Parameters

• upload_protocol (query-string) - Upload protocol for media (e.g. "raw", "multipart").
• prettyPrint (query-boolean) - Returns response with indentations and line breaks.
• access_token (query-string) - OAuth access token.
• fields (query-string) - Selector specifying which fields to include in a partial response.
• quotaUser (query-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.
• callback (query-string) - JSONP
• oauth_token (query-string) - OAuth 2.0 token for the current user.
• key (query-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.
• uploadType (query-string) - Legacy upload protocol for media (e.g. "media", "multipart").
• alt (query-string) - Data format for response.
• $.xgafv (query-string) - V1 error format.

pub fn add_scope<T, S>(self, scope: T) -> AdvertiserCreativeListCall<'a, C, A> where
    T: Into<Option<S>>,
    S: AsRef<str>, 

Identifies the authorization scope for the method you are building.

Use this method to actively specify which scope should be used, instead the default Scope variant Scope::DisplayVideo.

The scope will be added to a set of scopes. This is important as one can maintain access tokens for more than one scope. If None is specified, then all scopes will be removed and no default scope will be used either. In that case, you have to specify your API-key using the key parameter (see the param() function for details).

Usually there is more than one suitable scope to authorize an operation, some of which may encompass more rights than others. For example, for listing resources, a read-only scope will be sufficient, a read-write scope will do as well.

Trait Implementations

impl<'a, C, A> CallBuilder for AdvertiserCreativeListCall<'a, C, A>