REST Resource: sessions

Ресурс: PickingSession

Представление сеанса пользователя, в ходе которого пользователь может выбирать фотографии и видео с помощью Google Photos.

JSON-представление 
{
  "id": string,
  "pickerUri": string,
  "pollingConfig": {
    object (PollingConfig)
  },
  "expireTime": string,
  "pickingConfig": {
    object (PickingConfig)
  },
  "mediaItemsSet": boolean
}
Поля
id

string

Только вывод. Идентификатор, сгенерированный Google для этого сеанса.

pickerUri

string

Только вывод. URI, используемый для перенаправления пользователя в Google Фото (в веб-версии), где он может выбрать фотографии и видео для текущего сеанса.

Для успешного просмотра этой страницы пользователь должен войти в учетную запись Google, которой принадлежит этот сеанс, в своем веб-браузере.

pickerUri невозможно открыть в iframe по соображениям безопасности.

Для веб-приложений можно добавить /autoclose к этому URI. В этом случае окно или вкладка Google Фото будут автоматически закрываться после того, как пользователь завершит выбор, вместо отображения экрана «Готово».

pollingConfig

object ( PollingConfig )

Только вывод. Рекомендуемая конфигурация, которую приложения должны использовать при опросе sessions.get .

Это поле заполняется только в том случае, если элементы мультимедиа еще не были выбраны для этого сеанса (т. е. mediaItemsSet имеет значение false).

expireTime

string ( Timestamp format)

Только вывод. Время истечения доступа к этому сеансу (и выбранным в нём медиафайлам).

Использует RFC 3339, согласно которому сгенерированный вывод всегда будет нормализован по оси Z и содержать 0, 3, 6 или 9 знаков после запятой. Также допускаются смещения, отличные от «Z». Примеры: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30" .

pickingConfig

object ( PickingConfig )

Необязательно. Конфигурация выбора фотографий для удобства пользователя во время этого сеанса.

Это указывается клиентским приложением при вызове sessions.create и не может быть изменено постфактум (без создания нового сеанса).

mediaItemsSet

boolean

Только вывод. Если установлено значение true , медиа-элементы были выбраны для этого сеанса, и ваше приложение может запросить список выбранных медиа-элементов через mediaItems.list .

PollingConfig

Конфигурация для опроса API.

JSON-представление 
{
  "pollInterval": string,
  "timeoutIn": string
}
Поля
pollInterval

string ( Duration format)

Только вывод. Рекомендуемое время между запросами опроса.

Длительность в секундах, содержащая до девяти знаков после запятой, заканчивается на « s ». Пример: "3.5s" .

timeoutIn

string ( Duration format)

Только вывод. Интервал времени, по истечении которого клиент должен прекратить опрос.

Значение 0 указывает, что клиент должен прекратить опрос, если он этого еще не сделал.

Длительность в секундах, содержащая до девяти знаков после запятой, заканчивается на « s ». Пример: "3.5s" .

PickingConfig

Конфигурация, заданная клиентом для пользовательского опыта выбора во время этого сеанса.

JSON-представление 
{
  "maxItemCount": string
}
Поля
maxItemCount

string ( int64 format)

Необязательно. Максимальное количество элементов, которые пользователь может выбрать в этом сеансе. Если не указано иное, по умолчанию используется значение 2000.

Если значение не указано или равно 0, можно выбрать не более 2000 элементов. Значения выше 2000 будут приведены к 2000. Отрицательные значения приведут к ошибке INVALID_ARGUMENT .

Методы

create

 Создает новый сеанс, в ходе которого пользователь может выбирать фотографии и видео для доступа третьих лиц.

delete

 Удаляет указанный сеанс.

get

 Извлекает информацию об указанном сеансе.