Struct google_photoslibrary1::api::SearchMediaItemsRequest

pub struct SearchMediaItemsRequest {
    pub album_id: Option<String>,
    pub filters: Option<Filters>,
    pub order_by: Option<String>,
    pub page_size: Option<i32>,
    pub page_token: Option<String>,
}

Request to search for media items in a user’s library. If the album id is specified, this call will return the list of media items in the album. If neither filters nor album id are specified, this call will return all media items in a user’s Google Photos library. If filters are specified, this call will return all media items in the user’s library that fulfill the filter criteria. Filters and album id must not both be set, as this will result in an invalid request.

Activities

This type is used in activities, which are methods you may call on this type or where this type is involved in. The list links the activity name, along with information about where it is used (one of request and response).

• search media items (request)

Fields

album_id: Option<String>

Identifier of an album. If populated, lists all media items in specified album. Can’t set in conjunction with any filters.

filters: Option<Filters>

Filters to apply to the request. Can’t be set in conjunction with an albumId.

order_by: Option<String>

An optional field to specify the sort order of the search results. The orderBy field only works when a dateFilter is used. When this field is not specified, results are displayed newest first, oldest last by their creationTime. Providing MediaMetadata.creation_time displays search results in the opposite order, oldest first then newest last. To display results newest first then oldest last, include the desc argument as follows: MediaMetadata.creation_time desc. The only additional filters that can be used with this parameter are includeArchivedMedia and excludeNonAppCreatedData. No other filters are supported.

page_size: Option<i32>

Maximum number of media items to return in the response. Fewer media items might be returned than the specified number. The default pageSize is 25, the maximum is 100.

page_token: Option<String>

A continuation token to get the next page of the results. Adding this to the request returns the rows after the pageToken. The pageToken should be the value returned in the nextPageToken parameter in the response to the searchMediaItems request.

Trait Implementations

impl Clone for SearchMediaItemsRequest

fn clone(&self) -> SearchMediaItemsRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SearchMediaItemsRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SearchMediaItemsRequest

fn default() -> SearchMediaItemsRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SearchMediaItemsRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SearchMediaItemsRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl RequestValue for SearchMediaItemsRequest