REST Resource: sessions

Resource: PickingSession

Representation of a user session during which the user can pick photos and videos using Google Photos.

JSON representation 
{
  "id": string,
  "pickerUri": string,
  "pollingConfig": {
    object (PollingConfig)
  },
  "expireTime": string,
  "pickingConfig": {
    object (PickingConfig)
  },
  "mediaItemsSet": boolean
}
Fields
id

string

Output only. The Google-generated identifier for this session.
pickerUri

string

Output only. The URI used to redirect the user to Google Photos (on web) so they can pick photos and videos for the current session.

To view this page successfully, the user must be logged into the Google account that owns this session in their web browser.

The pickerUri cannot be opened in an iframe due to security reasons.
pollingConfig

object (PollingConfig)

Output only. The recommended configuration that applications should use while polling sessions.get.

This field is only populated if media items have not yet been picked for this session (i.e., mediaItemsSet is false).
expireTime

string (Timestamp format)

Output only. Time when access to this session (and its picked media items) will expire.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
pickingConfig

object (PickingConfig)

Optional. Photo-picking configuration for the user's picking experience during this session.

This is specified by the client application when calling sessions.create, and cannot be modified after the fact (without creating a new session).
mediaItemsSet

boolean

Output only. If set to true, media items have been picked for this session and your application can request the list of picked media items via mediaItems.list.

PollingConfig

Configuration for polling the API.

JSON representation 
{
  "pollInterval": string,
  "timeoutIn": string
}
Fields
pollInterval

string (Duration format)

Output only. Recommended time between poll requests.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
timeoutIn

string (Duration format)

Output only. The length of time after which the client should stop polling.

A value of 0 indicates that the client should stop polling if it hasn't already.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

PickingConfig

Client-specified configuration for the user's picking experience during this session.

JSON representation 
{
  "maxItemCount": string
}
Fields
maxItemCount

string (int64 format)

Optional. The maximum number of items that the user can pick during this session. Defaults to 2000 if not specified.

If unspecified or set to 0, at most 2000 items can be picked. Values above 2000 will be coerced to 2000. Negative values will result in an INVALID_ARGUMENT error.

Methods

create

 Generates a new session during which the user can pick photos and videos for third-party access.

delete

 Deletes the specified session.

get

 Retrieves information about the specified session.