Struct google_youtubeanalytics1::GroupListCall

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

Returns a collection of groups that match the API request parameters. For example, you can retrieve all groups that the authenticated user owns, or you can retrieve one or more groups by their unique IDs.

A builder for the list method supported by a group resource. It is not used directly, but through a GroupMethods 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.groups().list()
             .page_token("sea")
             .on_behalf_of_content_owner("Lorem")
             .mine(false)
             .id("erat")
             .doit();

Methods

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

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

Perform the operation you have build so far.

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

The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken property identifies the next page that can be retrieved.

Sets the page token query property to the given value.

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

Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.

Sets the on behalf of content owner query property to the given value.

pub fn mine(self, new_value: bool) -> GroupListCall<'a, C, A>

Set this parameter's value to true to instruct the API to only return groups owned by the authenticated user.

Sets the mine query property to the given value.

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

The id parameter specifies a comma-separated list of the YouTube group ID(s) for the resource(s) that are being retrieved. In a group resource, the id property specifies the group's YouTube group ID.

Sets the id query property to the given value.

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

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