REST Resource: sessions

Ресурс: PickingSession

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

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 по соображениям безопасности.

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 .

Конфигурация опроса

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

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

string ( Duration format)

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

Длительность в секундах, содержащая до девяти дробных цифр и оканчивающаяся на « s ». Пример: "3.5s" .

timeoutIn

string ( Duration format)

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

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

Длительность в секундах, содержащая до девяти дробных цифр и оканчивающаяся на « s ». Пример: "3.5s" .

Выбор конфигурации

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

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

string ( int64 format)

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

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

Методы

create

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

delete

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

get

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