Struct google_dfareporting2d8::PlacementGroupListCall

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

Retrieves a list of placement groups, possibly filtered. This method supports paging.

A builder for the list method supported by a placementGroup resource. It is not used directly, but through a PlacementGroupMethods 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.placement_groups().list("profileId")
             .sort_order("sed")
             .sort_field("vero")
             .add_site_ids("nonumy")
             .search_string("magna")
             .add_pricing_types("ea")
             .add_placement_strategy_ids("sea")
             .placement_group_type("ipsum")
             .page_token("labore")
             .min_start_date("Lorem")
             .min_end_date("aliquyam")
             .max_start_date("sanctus")
             .max_results(-34)
             .max_end_date("consetetur")
             .add_ids("et")
             .add_directory_site_ids("justo")
             .add_content_category_ids("kasd")
             .add_campaign_ids("kasd")
             .archived(true)
             .add_advertiser_ids("eos")
             .doit();

Methods

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

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

Perform the operation you have build so far.

pub fn profile_id(self, new_value: &str) -> PlacementGroupListCall<'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.

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

Order of sorted results.

Sets the sort order query property to the given value.

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

Field by which to sort the list.

Sets the sort field query property to the given value.

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

Select only placement groups 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.

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

Allows searching for placement groups by name or ID. Wildcards () are allowed. For example, "placement2015" will return placement groups with names like "placement group June 2015", "placement group 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 "placementgroup" will match placement groups with name "my placementgroup", "placementgroup 2015", or simply "placementgroup".

Sets the search string query property to the given value.

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

Select only placement groups 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.

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

Select only placement groups 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.

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

Select only placement groups belonging with this group type. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting.

Sets the placement group type query property to the given value.

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

Value of the nextPageToken from the previous result page.

Sets the page token query property to the given value.

pub fn min_start_date(self, new_value: &str) -> PlacementGroupListCall<'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.

pub fn min_end_date(self, new_value: &str) -> PlacementGroupListCall<'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.

pub fn max_start_date(self, new_value: &str) -> PlacementGroupListCall<'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.

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

Maximum number of results to return.

Sets the max results query property to the given value.

pub fn max_end_date(self, new_value: &str) -> PlacementGroupListCall<'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.

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

Select only placement groups 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.

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

Select only placement groups 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.

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

Select only placement groups 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.

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

Select only placement groups 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.

pub fn archived(self, new_value: bool) -> PlacementGroupListCall<'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.

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

Select only placement groups 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.

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

• quotaUser (query-string) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
• 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) - Deprecated. Please use quotaUser instead.
• fields (query-string) - Selector specifying which fields to include in a partial response.
• alt (query-string) - Data format for the response.

pub fn add_scope<T, S>(self, scope: T) -> PlacementGroupListCall<'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 PlacementGroupListCall<'a, C, A>