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

出力専用。ユーザーを Google フォト（ウェブ版）にリダイレクトして、現在のセッションで使用する写真や動画を選択できるようにするために使用される URI。

このページを正常に表示するには、ウェブブラウザでこのセッションを所有する Google アカウントにログインしている必要があります。

セキュリティ上の理由から、pickerUri を iframe で開くことはできません。

ウェブベースのアプリケーションの場合は、この URI に /autoclose を追加できます。ユーザーが選択を終えると、[完了] 画面が表示される代わりに、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 で終わる小数点以下 9 桁までの秒単位の期間。例: "3.5s"。
timeoutIn

string (Duration format)

出力専用。クライアントがポーリングを停止するまでの時間。

値 0 は、クライアントがまだポーリングを停止していない場合は停止する必要があることを示します。

s で終わる小数点以下 9 桁までの秒単位の期間。例: "3.5s"。

PickingConfig

このセッション中のユーザーの選択エクスペリエンスに関するクライアント指定の構成。

JSON 表現 
{
  "maxItemCount": string
}
フィールド
maxItemCount

string (int64 format)

省略可。このセッション中にユーザーが選択できるアイテムの最大数。指定しない場合のデフォルトは 2000 です。

指定しない場合や 0 に設定した場合は、最大 2, 000 個のアイテムを選択できます。2,000 を超える値は 2,000 に強制変換されます。負の値は INVALID_ARGUMENT エラーになります。

メソッド

create

 ユーザーがサードパーティによるアクセス用に写真や動画を選択できる新しいセッションを生成します。

delete

 指定されたセッションを削除します。

get

 指定されたセッションに関する情報を取得します。