Struct google_youtube3::api::SearchListCall

source ·

pub struct SearchListCall<'a, S>where
    S: 'a,
{ /* private fields */ }

Expand description

Retrieves a list of search resources

A builder for the list method supported by a search resource. It is not used directly, but through a SearchMethods 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.search().list(&vec!["Lorem".into()])
             .video_type("magna")
             .video_syndicated("takimata")
             .video_paid_product_placement("rebum.")
             .video_license("At")
             .video_embeddable("invidunt")
             .video_duration("clita")
             .video_dimension("Stet")
             .video_definition("aliquyam")
             .video_category_id("ut")
             .video_caption("sit")
             .add_type("vero")
             .topic_id("rebum.")
             .safe_search("dolores")
             .relevance_language("consetetur")
             .region_code("dolores")
             .q("sed")
             .published_before(chrono::Utc::now())
             .published_after(chrono::Utc::now())
             .page_token("invidunt")
             .order("clita")
             .on_behalf_of_content_owner("dolor")
             .max_results(19)
             .location_radius("magna")
             .location("diam")
             .for_mine(false)
             .for_developer(true)
             .for_content_owner(true)
             .event_type("est")
             .channel_type("takimata")
             .channel_id("dolor")
             .doit().await;

Implementations§

source §

impl<'a, S> SearchListCall<'a, S>
where S: Service<Uri> + Clone + Send + Sync + 'static, S::Response: Connection + AsyncRead + AsyncWrite + Send + Unpin + 'static, S::Future: Send + Unpin + 'static, S::Error: Into<Box<dyn StdError + Send + Sync>>,

source

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

Perform the operation you have build so far.

source

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

The part parameter specifies a comma-separated list of one or more search resource properties that the API response will include. Set the parameter value to snippet.

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_type(self, new_value: &str) -> SearchListCall<'a, S>

Filter on videos of a specific type.

Sets the video type query property to the given value.

source

pub fn video_syndicated(self, new_value: &str) -> SearchListCall<'a, S>

Filter on syndicated videos.

Sets the video syndicated query property to the given value.

source

pub fn video_paid_product_placement( self, new_value: &str ) -> SearchListCall<'a, S>

Sets the video paid product placement query property to the given value.

source

pub fn video_license(self, new_value: &str) -> SearchListCall<'a, S>

Filter on the license of the videos.

Sets the video license query property to the given value.

source

pub fn video_embeddable(self, new_value: &str) -> SearchListCall<'a, S>

Filter on embeddable videos.

Sets the video embeddable query property to the given value.

source

pub fn video_duration(self, new_value: &str) -> SearchListCall<'a, S>

Filter on the duration of the videos.

Sets the video duration query property to the given value.

source

pub fn video_dimension(self, new_value: &str) -> SearchListCall<'a, S>

Filter on 3d videos.

Sets the video dimension query property to the given value.

source

pub fn video_definition(self, new_value: &str) -> SearchListCall<'a, S>

Filter on the definition of the videos.

Sets the video definition query property to the given value.

source

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

Filter on videos in a specific category.

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

source

pub fn video_caption(self, new_value: &str) -> SearchListCall<'a, S>

Filter on the presence of captions on the videos.

Sets the video caption query property to the given value.

source

pub fn add_type(self, new_value: &str) -> SearchListCall<'a, S>

Restrict results to a particular set of resource types from One Platform.

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

source

pub fn topic_id(self, new_value: &str) -> SearchListCall<'a, S>

Restrict results to a particular topic.

Sets the topic id query property to the given value.

source

pub fn safe_search(self, new_value: &str) -> SearchListCall<'a, S>

Indicates whether the search results should include restricted content as well as standard content.

Sets the safe search query property to the given value.

source

pub fn relevance_language(self, new_value: &str) -> SearchListCall<'a, S>

Return results relevant to this language.

Sets the relevance language query property to the given value.

source

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

Display the content as seen by viewers in this country.

Sets the region code query property to the given value.

source

pub fn q(self, new_value: &str) -> SearchListCall<'a, S>

Textual search terms to match.

Sets the q query property to the given value.

source

pub fn published_before(self, new_value: DateTime<Utc>) -> SearchListCall<'a, S>

Filter on resources published before this date.

Sets the published before query property to the given value.

source

pub fn published_after(self, new_value: DateTime<Utc>) -> SearchListCall<'a, S>

Filter on resources published after this date.

Sets the published after query property to the given value.

source

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

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.

Sets the page token query property to the given value.

source

pub fn order(self, new_value: &str) -> SearchListCall<'a, S>

Sort order of the results.

Sets the order query property to the given value.

source

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

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 max_results(self, new_value: u32) -> SearchListCall<'a, S>

The maxResults parameter specifies the maximum number of items that should be returned in the result set.

Sets the max results query property to the given value.

source

pub fn location_radius(self, new_value: &str) -> SearchListCall<'a, S>

Filter on distance from the location (specified above).

Sets the location radius query property to the given value.

source

pub fn location(self, new_value: &str) -> SearchListCall<'a, S>

Filter on location of the video

Sets the location query property to the given value.

source

pub fn for_mine(self, new_value: bool) -> SearchListCall<'a, S>

Search for the private videos of the authenticated user.

Sets the for mine query property to the given value.

source

pub fn for_developer(self, new_value: bool) -> SearchListCall<'a, S>

Restrict the search to only retrieve videos uploaded using the project id of the authenticated user.

Sets the for developer query property to the given value.

source

pub fn for_content_owner(self, new_value: bool) -> SearchListCall<'a, S>

Search owned by a content owner.

Sets the for content owner query property to the given value.

source

pub fn event_type(self, new_value: &str) -> SearchListCall<'a, S>

Filter on the livestream status of the videos.

Sets the event type query property to the given value.

source

pub fn channel_type(self, new_value: &str) -> SearchListCall<'a, S>

Add a filter on the channel search.

Sets the channel type query property to the given value.

source

pub fn channel_id(self, new_value: &str) -> SearchListCall<'a, S>

Filter on resources belonging to this channelId.

Sets the channel id query property to the given value.

source

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

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) -> SearchListCall<'a, S>
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<St>(self, scope: St) -> SearchListCall<'a, S>
where St: AsRef<str>,

Identifies the authorization scope for the method you are building.

Use this method to actively specify which scope should be used, instead of 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.

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.

source

pub fn add_scopes<I, St>(self, scopes: I) -> SearchListCall<'a, S>
where I: IntoIterator<Item = St>, St: AsRef<str>,

Identifies the authorization scope(s) for the method you are building.

See Self::add_scope() for details.

source

pub fn clear_scopes(self) -> SearchListCall<'a, S>

Removes all scopes, and no default scope will be used either. In this case, you have to specify your API-key using the key parameter (see Self::param() for details).