Создание сеансов и управление ими

Сессии лежат в основе API Picker, предоставляя пользователям безопасный и контролируемый способ выбора фотографий и видео из библиотеки Google Фото. В этом руководстве описывается, как создавать, управлять и эффективно проводить опросы, чтобы обеспечить беспрепятственный выбор фотографий в вашем приложении.

Прежде чем начать

  • Настройте свое приложение: включите API и настройте аутентификацию. Подробные инструкции см. в разделе Настройка приложения .
  • Понимание процесса: просмотрите начало работы с API Picker, чтобы получить обзор всего процесса выбора фотографий.
  • Просмотрите необходимые области авторизации . Для работы с сеансами требуется область photospicker.mediaitems.readonly . Дополнительные сведения об областях см. в разделе Области авторизации .

Жизненный цикл сеанса

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

  1. Создайте сеанс , чтобы позволить пользователю выбирать элементы мультимедиа.
  2. Опросите сеанс , чтобы проверить, когда пользователь закончил выбор элементов мультимедиа.
  3. Перечислите и извлеките элементы мультимедиа .
  4. Очистите сеанс, удалив его.

Создание сеансов

Создайте сеанс, чтобы ваши пользователи могли безопасно выбирать фотографии прямо из приложения Google Photos и отправлять их обратно в ваше приложение.

sessions.create создает новый сеанс, возвращая уникальный pickerUri , который вы можете предоставить своим пользователям. Сеанс остается активным до тех пор, пока пользователь не выберет успешно элементы мультимедиа или пока не истечет время сеанса.

Ограничения сеансов

Помните об ограничениях сеансов. API Picker устанавливает ограничения на количество сеансов, которые вы можете создать, чтобы обеспечить ответственное использование и предотвратить злоупотребления. В обычных обстоятельствах вы вряд ли достигнете этих пределов. Однако вам следует заранее отслеживать и очищать сеансы, чтобы избежать каких-либо проблем.

Опрос и мониторинг сессий

После создания сеанса периодически опрашивайте конечную точку sessions.get , чтобы получить статус сеанса. Свойство mediaItemsSet в ответе возвращает true , когда пользователь завершил свой выбор.

Обязательно используйте эффективный опрос. Ответ sessions.get включает объект pollingConfig . Используйте следующие поля, чтобы избежать ненужных вызовов и обеспечить удобство взаимодействия с пользователем:

  • pollInterval : оптимальные интервалы опроса
  • timeoutIn : продолжительность тайм-аута

Дополнительные сведения см. в примере процесса опроса .

Удаление и очистка сеансов

sessions.delete удаляет сеанс, обычно используемый для очистки после того, как пользователь завершил выбор носителя или если время сеанса истекло.

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

Пример потока опроса

Это пример создания и опроса сеанса. После первой аутентификации пользователя создайте новый сеанс.

  1. Создайте сеанс. Вызовите sessions.create чтобы инициировать новый сеанс и получить pickerUri .
  2. Предоставьте пользователю pickerUri : отобразите URL-адрес или создайте QR-код для сканирования пользователем.
  3. Опрос сессии:
    1. Используйте рекомендуемый pollInterval из pollingConfig .
    2. Проверьте, верно ли значение mediaItemsSet .
      1. Если true , перейдите к отображению выбранных элементов мультимедиа.
      2. Если false , продолжите опрос до тех пор, пока не будет достигнут timeoutIn .
    3. Грамотно обрабатывайте таймауты и отмены. 
GET https://photoslibrary.googleapis.com/v1/sessions/{sessionId}

Вот пример ответа:

{
  "id": string,
  "pickerUri": string,
  "pollingConfig": {
    object (PollingConfig)
  },
  "mediaItemsSet": boolean
}

Предоставьте пользователю pickerUri , а затем начните опрос сеанса.

Проверьте ответ на следующее:

  • mediaItemsSet : true, если пользователь закончил выбор медиа-элементов.
  • pollingConfig.pollInterval : рекомендуемое время ожидания перед следующим опросом.
  • pollingConfig.timeoutIn : общее время ожидания до истечения времени ожидания

Если mediaItemsSet имеет значение false и timeoutIn не достигнут, дождитесь pollInterval , а затем повторите опрос.

Если mediaItemsSet имеет значение true, перейдите к отображению выбранных элементов мультимедиа.

Если достигнуто timeoutIn , корректно обработайте тайм-аут.