Struct YoutubeV3VideoBatchGetStatCall

Source

pub struct YoutubeV3VideoBatchGetStatCall<'a, C>where
    C: 'a,
{ /* private fields */ }

Expand description

Retrieves a batch of VideoStat resources, possibly filtered.

A builder for the v3.videos.batchGetStats method supported by a youtube resource. It is not used directly, but through a YoutubeMethods 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.youtube().v3_videos_batch_get_stats()
             .add_part("kasd")
             .on_behalf_of_content_owner("Lorem")
             .add_id("sit")
             .doit().await;

Implementations§

Source §

impl<'a, C> YoutubeV3VideoBatchGetStatCall<'a, C>
where C: Connector,

Source

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

Perform the operation you have build so far.

Source

pub fn add_part(self, new_value: &str) -> YoutubeV3VideoBatchGetStatCall<'a, C>

Required. The **part** parameter specifies a comma-separated list of one or more videoStat resource properties that the API response will include. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a videoStat resource, the statistics property contains view_count and like_count. As such, if you set **part=snippet**, the API response will contain all of those properties.

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

Source

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

Optional. 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.

Source

pub fn add_id(self, new_value: &str) -> YoutubeV3VideoBatchGetStatCall<'a, C>

Required. Return videos with the given ids.

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

Source

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

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.

Source

pub fn param<T>( self, name: T, value: T, ) -> YoutubeV3VideoBatchGetStatCall<'a, C>
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

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