API Documentation
\
Google
Photos
Library
V1
AlbumPosition
Gapic
MediaTypeFilter
GPBMetadata
Google
Photos
Library
V1

\Google\Photos\Library\V1SearchMediaItemsRequest

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.

Generated from protobuf message google.photos.library.v1.SearchMediaItemsRequest

Summary

Methods
Properties
Constants
__construct()
getAlbumId()
setAlbumId()
getPageSize()
setPageSize()
getPageToken()
setPageToken()
getFilters()
setFilters()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$album_id
$page_size
$page_token
$filters
N/A

Properties

$album_id

$album_id :

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

Generated from protobuf field string album_id = 1;

Type

$page_size

$page_size :

Maximum number of media items to return in the response. The default number of media items to return at a time is 25. The maximum `pageSize` is 100.

Generated from protobuf field int32 page_size = 2;

Type

$page_token

$page_token :

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.

Generated from protobuf field string page_token = 3;

Type

$filters

$filters :

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

Generated from protobuf field .google.photos.library.v1.Filters filters = 4;

Type

Methods

__construct()

__construct(array  $data = NULL)

Constructor.

Parameters

array $data

{ Optional. Data for populating the Message object.

@type string $album_id
      Identifier of an album. If populated, lists all media items in
      specified album. Can't set in conjunction with any filters.
@type int $page_size
      Maximum number of media items to return in the response. The default number
      of media items to return at a time is 25. The maximum
      `pageSize` is 100.
@type string $page_token
      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.
@type \Google\Photos\Library\V1\Filters $filters
      Filters to apply to the request. Can't be set in conjunction with an
      `albumId`.

}

getAlbumId()

getAlbumId() : string

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

Generated from protobuf field string album_id = 1;

Returns

string

setAlbumId()

setAlbumId(string  $var) : $this

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

Generated from protobuf field string album_id = 1;

Parameters

string $var

Returns

$this

getPageSize()

getPageSize() : integer

Maximum number of media items to return in the response. The default number of media items to return at a time is 25. The maximum `pageSize` is 100.

Generated from protobuf field int32 page_size = 2;

Returns

integer

setPageSize()

setPageSize(integer  $var) : $this

Maximum number of media items to return in the response. The default number of media items to return at a time is 25. The maximum `pageSize` is 100.

Generated from protobuf field int32 page_size = 2;

Parameters

integer $var

Returns

$this

getPageToken()

getPageToken() : 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.

Generated from protobuf field string page_token = 3;

Returns

string

setPageToken()

setPageToken(string  $var) : $this

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.

Generated from protobuf field string page_token = 3;

Parameters

string $var

Returns

$this

getFilters()

getFilters() : \Google\Photos\Library\V1\Filters

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

Generated from protobuf field .google.photos.library.v1.Filters filters = 4;

Returns

\Google\Photos\Library\V1\Filters

setFilters()

setFilters(\Google\Photos\Library\V1\Filters  $var) : $this

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

Generated from protobuf field .google.photos.library.v1.Filters filters = 4;

Parameters

\Google\Photos\Library\V1\Filters $var

Returns

$this