セッションを作成、管理する

セッションは Picker API の中核であり、安全で管理されたユーザーが Google フォトライブラリから写真やアルバムを選択できるようになりました。このガイドでは、セッションを作成、管理、効果的にポーリングして、アプリでシームレスな写真選択を可能にする方法について説明します。

始める前に

アプリを構成する: API を有効にして認証を設定します。詳細な手順については、アプリを構成するをご覧ください。
フローを理解する: 写真選択プロセス全体の概要については、Picker API の使用を開始するをご覧ください。
必要な認可スコープを確認する: セッションの操作には photospicker.mediaitems.readonly スコープが必要です。スコープについて詳しくは認可スコープをご覧ください。

Picker API には、アプリケーションに関する情報を作成、取得するためのメソッドがセッションを削除できます。ユーザーを認証した後、セッションを使用して写真選択のライフサイクルを管理できます。

セッションを作成すると、ユーザーがセッションから写真を直接安全に選択できるようになります。アプリと共有し、共有することもできます。

sessions.create が新しいセッションを生成し、一意の pickerUri を返します。数多くありますセッションは、ユーザーがメディアアイテムを正常に選択するか、セッションがタイムアウトするまでアクティブな状態が維持されます。

セッション数の上限に注意してください。Picker API は、責任ある使用を確実にし、不正使用を防ぐために、作成できるセッション数に上限を適用します。アンダー通常はこの上限に達することはありません。ただし、事前にセッションを追跡してクリーンアップし、サポートします。

セッションが作成されたら、定期的に sessions.get エンドポイントをポーリングして、ステータスです。レスポンスの mediaItemsSet プロパティが次を返します。ユーザーが選択を完了したら true を返します。

効率的なポーリングを使用してください。sessions.get レスポンスには、次の内容が含まれます。 pollingConfig オブジェクト。次のフィールドを使用すると、スムーズなユーザーエクスペリエンスを実現します。

詳しくは、ポーリングフローの例をご覧ください。

sessions.delete はセッションを削除します。通常はユーザーの後のクリーンアップに使用されます。がメディアの選択を終了した場合やセッションがタイムアウトした場合などです。

ユーザーがメディアアイテムを選択し、アプリがメディアアイテムのバイト数を取得したら、セッションを削除することをおすすめします。

これは、セッションの作成とポーリングの例です。最初の認証後新しいセッションを作成します。

セッションを作成する: sessions.create を呼び出して新しいセッションを開始します。 pickerUri を取得します。
pickerUri をユーザーに提示する: URL を表示するか、QR を生成しますスキャンするコードを入力します
セッションをポーリングします。 <ph type="x-smartling-placeholder">
1. pollingConfig から推奨される pollInterval を使用します。
2. mediaItemsSet が true かどうかを確認します。
  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 が false で timeoutIn に達していない場合は、 pollInterval を実行してから、再度ポーリングします。

mediaItemsSet が true の場合、選択したメディアアイテムの一覧表示に進みます。

timeoutIn に達した場合は、タイムアウトを適切に処理します。