Struct google_youtube3::api::VideoListCall

source · [−]

pub struct VideoListCall<'a> { /* private fields */ }

Expand description

Retrieves a list of resources, possibly filtered.

A builder for the list method supported by a video resource. It is not used directly, but through a VideoMethods 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.videos().list(&vec!["voluptua.".into()])
             .video_category_id("eos")
             .region_code("duo")
             .page_token("elitr")
             .on_behalf_of_content_owner("consetetur")
             .my_rating("et")
             .max_width(-14)
             .max_results(100)
             .max_height(-48)
             .locale("takimata")
             .add_id("erat")
             .hl("diam")
             .chart("nonumy")
             .doit().await;

Implementations

source

impl<'a> VideoListCall<'a>

source

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

Perform the operation you have build so far.

source

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

The part parameter specifies a comma-separated list of one or more video 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 video resource, the snippet property contains the channelId, title, description, tags, and categoryId properties. 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.

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

source

pub fn video_category_id(self, new_value: &str) -> VideoListCall<'a>

Use chart that is specific to the specified video category

Sets the video category id query property to the given value.

source

pub fn region_code(self, new_value: &str) -> VideoListCall<'a>

Use a chart that is specific to the specified region

Sets the region code query property to the given value.

source

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

The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved. Note: This parameter is supported for use in conjunction with the myRating and chart parameters, but it is not supported for use in conjunction with the id parameter.

Sets the page token query property to the given value.

source

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

source

pub fn my_rating(self, new_value: &str) -> VideoListCall<'a>

Return videos liked/disliked by the authenticated user. Does not support RateType.RATED_TYPE_NONE.

Sets the my rating query property to the given value.

source

pub fn max_width(self, new_value: i32) -> VideoListCall<'a>

Return the player with maximum height specified in

Sets the max width query property to the given value.

source

pub fn max_results(self, new_value: u32) -> VideoListCall<'a>

The maxResults parameter specifies the maximum number of items that should be returned in the result set. Note: This parameter is supported for use in conjunction with the myRating and chart parameters, but it is not supported for use in conjunction with the id parameter.

Sets the max results query property to the given value.

source

pub fn max_height(self, new_value: i32) -> VideoListCall<'a>

Sets the max height query property to the given value.

source

pub fn locale(self, new_value: &str) -> VideoListCall<'a>

Sets the locale query property to the given value.

source

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

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 hl(self, new_value: &str) -> VideoListCall<'a>

Stands for “host language”. Specifies the localization language of the metadata to be filled into snippet.localized. The field is filled with the default metadata if there is no localization in the specified language. The parameter value must be a language code included in the list returned by the i18nLanguages.list method (e.g. en_US, es_MX).

Sets the hl query property to the given value.

source

pub fn chart(self, new_value: &str) -> VideoListCall<'a>

Return the videos that are in the specified chart.

Sets the chart query property to the given value.

source

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

source

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

$.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”).

source

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

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.