Struct google_dfareporting2d2::PlacementListCall

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

Retrieves a list of placements, possibly filtered.

A builder for the list method supported by a placement resource. It is not used directly, but through a PlacementMethods 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.placements().list("profileId")
             .sort_order("diam")
             .sort_field("takimata")
             .add_size_ids("Lorem")
             .add_site_ids("dolor")
             .search_string("amet.")
             .add_pricing_types("sed")
             .add_placement_strategy_ids("sea")
             .payment_source("consetetur")
             .page_token("sea")
             .min_start_date("voluptua.")
             .min_end_date("At")
             .max_start_date("sanctus")
             .max_results(-48)
             .max_end_date("sit")
             .add_ids("magna")
             .add_group_ids("amet.")
             .add_directory_site_ids("clita")
             .add_content_category_ids("Stet")
             .add_compatibilities("sed")
             .add_campaign_ids("eirmod")
             .archived(true)
             .add_advertiser_ids("gubergren")
             .doit();

Methods

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

fn doit(self) -> Result<(Response, PlacementsListResponse)>

Perform the operation you have build so far.

fn profile_id(self, new_value: &str) -> PlacementListCall<'a, C, A>

User profile ID associated with this request.

Sets the profile 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.

fn sort_order(self, new_value: &str) -> PlacementListCall<'a, C, A>

Order of sorted results, default is ASCENDING.

Sets the sort order query property to the given value.

fn sort_field(self, new_value: &str) -> PlacementListCall<'a, C, A>

Field by which to sort the list.

Sets the sort field query property to the given value.

fn add_size_ids(self, new_value: &str) -> PlacementListCall<'a, C, A>

Select only placements that are associated with these sizes.

Append the given value to the size ids query property. Each appended value will retain its original ordering and be '/'-separated in the URL's parameters.

fn add_site_ids(self, new_value: &str) -> PlacementListCall<'a, C, A>

Select only placements that are associated with these sites.

Append the given value to the site ids query property. Each appended value will retain its original ordering and be '/'-separated in the URL's parameters.

fn search_string(self, new_value: &str) -> PlacementListCall<'a, C, A>

Allows searching for placements by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placements with names like "placement June 2015", "placement May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placement" will match placements with name "my placement", "placement 2015", or simply "placement".

Sets the search string query property to the given value.

fn add_pricing_types(self, new_value: &str) -> PlacementListCall<'a, C, A>

Select only placements with these pricing types.

Append the given value to the pricing types query property. Each appended value will retain its original ordering and be '/'-separated in the URL's parameters.

fn add_placement_strategy_ids(
    self,
    new_value: &str
) -> PlacementListCall<'a, C, A>

Select only placements that are associated with these placement strategies.

Append the given value to the placement strategy ids query property. Each appended value will retain its original ordering and be '/'-separated in the URL's parameters.

fn payment_source(self, new_value: &str) -> PlacementListCall<'a, C, A>

Select only placements with this payment source.

Sets the payment source query property to the given value.

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

Value of the nextPageToken from the previous result page.

Sets the page token query property to the given value.

fn min_start_date(self, new_value: &str) -> PlacementListCall<'a, C, A>

Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd".

Sets the min start date query property to the given value.

fn min_end_date(self, new_value: &str) -> PlacementListCall<'a, C, A>

Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd".

Sets the min end date query property to the given value.

fn max_start_date(self, new_value: &str) -> PlacementListCall<'a, C, A>

Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd".

Sets the max start date query property to the given value.

fn max_results(self, new_value: i32) -> PlacementListCall<'a, C, A>

Maximum number of results to return.

Sets the max results query property to the given value.

fn max_end_date(self, new_value: &str) -> PlacementListCall<'a, C, A>

Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd".

Sets the max end date query property to the given value.

fn add_ids(self, new_value: &str) -> PlacementListCall<'a, C, A>

Select only placements with these IDs.

Append the given value to the ids query property. Each appended value will retain its original ordering and be '/'-separated in the URL's parameters.

fn add_group_ids(self, new_value: &str) -> PlacementListCall<'a, C, A>

Select only placements that belong to these placement groups.

Append the given value to the group ids query property. Each appended value will retain its original ordering and be '/'-separated in the URL's parameters.

fn add_directory_site_ids(self, new_value: &str) -> PlacementListCall<'a, C, A>

Select only placements that are associated with these directory sites.

Append the given value to the directory site ids query property. Each appended value will retain its original ordering and be '/'-separated in the URL's parameters.

fn add_content_category_ids(
    self,
    new_value: &str
) -> PlacementListCall<'a, C, A>

Select only placements that are associated with these content categories.

Append the given value to the content category ids query property. Each appended value will retain its original ordering and be '/'-separated in the URL's parameters.

fn add_compatibilities(self, new_value: &str) -> PlacementListCall<'a, C, A>

Select only placements that are associated with these compatibilities. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard.

Append the given value to the compatibilities query property. Each appended value will retain its original ordering and be '/'-separated in the URL's parameters.

fn add_campaign_ids(self, new_value: &str) -> PlacementListCall<'a, C, A>

Select only placements that belong to these campaigns.

Append the given value to the campaign ids query property. Each appended value will retain its original ordering and be '/'-separated in the URL's parameters.

fn archived(self, new_value: bool) -> PlacementListCall<'a, C, A>

Select only archived placements. Don't set this field to select both archived and non-archived placements.

Sets the archived query property to the given value.

fn add_advertiser_ids(self, new_value: &str) -> PlacementListCall<'a, C, A>

Select only placements that belong to these advertisers.

Append the given value to the advertiser ids query property. Each appended value will retain its original ordering and be '/'-separated in the URL's parameters.

fn delegate(self, new_value: &'a mut Delegate) -> PlacementListCall<'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.

fn param<T>(self, name: T, value: T) -> PlacementListCall<'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 paramters which have their own setter method. If done anyway, the request will fail.

Additional Parameters

• 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. Overrides userIp if both are provided.
• 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.
• prettyPrint (query-boolean) - Returns response with indentations and line breaks.
• userIp (query-string) - IP address of the site where the request originates. Use this if you want to enforce per-user limits.
• fields (query-string) - Selector specifying which fields to include in a partial response.
• alt (query-string) - Data format for the response.

fn add_scope<T, S>(self, scope: T) -> PlacementListCall<'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::Dfatrafficking.

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 PlacementListCall<'a, C, A>