Struct google_youtube3::VideoListCall [] [src]

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

Returns a list of videos that match the API request parameters.

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("part")
             .video_category_id("amet.")
             .region_code("voluptua.")
             .page_token("Lorem")
             .on_behalf_of_content_owner("gubergren")
             .my_rating("justo")
             .max_width(49)
             .max_results(75)
             .max_height(73)
             .locale("rebum.")
             .id("consetetur")
             .hl("sadipscing")
             .chart("vero")
             .doit();

Methods

impl<'a, C, A> VideoListCall<'a, C, A> where
    C: BorrowMut<Client>,
    A: GetToken
[src]

[src]

Perform the operation you have build so far.

[src]

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.

Sets the part query property to the given value.

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

[src]

The videoCategoryId parameter identifies the video category for which the chart should be retrieved. This parameter can only be used in conjunction with the chart parameter. By default, charts are not restricted to a particular category.

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

[src]

The regionCode parameter instructs the API to select a video chart available in the specified region. This parameter can only be used in conjunction with the chart parameter. The parameter value is an ISO 3166-1 alpha-2 country code.

Sets the region code query property to the given value.

[src]

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.

[src]

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.

[src]

Set this parameter's value to like or dislike to instruct the API to only return videos liked or disliked by the authenticated user.

Sets the my rating query property to the given value.

[src]

The maxWidth parameter specifies a maximum width of the embedded player. If maxHeight is provided, maxWidth may not be reached in order to not violate the height request.

Sets the max width query property to the given value.

[src]

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.

[src]

The maxHeight parameter specifies a maximum height of the embedded player. If maxWidth is provided, maxHeight may not be reached in order to not violate the width request.

Sets the max height query property to the given value.

[src]

DEPRECATED

Sets the locale query property to the given value.

[src]

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

Sets the id query property to the given value.

[src]

The hl parameter instructs the API to retrieve localized resource metadata for a specific application language that the YouTube website supports. The parameter value must be a language code included in the list returned by the i18nLanguages.list method.

If localized resource details are available in that language, the resource's snippet.localized object will contain the localized values. However, if localized details are not available, the snippet.localized object will contain resource details in the resource's default language.

Sets the hl query property to the given value.

[src]

The chart parameter identifies the chart that you want to retrieve.

Sets the chart query property to the given value.

[src]

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.

[src]

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.

[src]

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.

Trait Implementations

impl<'a, C, A> CallBuilder for VideoListCall<'a, C, A>
[src]