REST Resource: sessions

Resource: PickingSession

Representasi sesi pengguna saat pengguna dapat memilih foto dan video menggunakan Google Foto.

Representasi JSON
{
  "id": string,
  "pickerUri": string,
  "pollingConfig": {
    object (PollingConfig)
  },
  "expireTime": string,
  "pickingConfig": {
    object (PickingConfig)
  },
  "mediaItemsSet": boolean
}
Kolom
id

string

Hanya output. ID yang dibuat Google untuk sesi ini.

pickerUri

string

Hanya output. URI yang digunakan untuk mengalihkan pengguna ke Google Foto (di web) sehingga mereka dapat memilih foto dan video untuk sesi saat ini.

Agar dapat melihat halaman ini dengan berhasil, pengguna harus login ke Akun Google yang memiliki sesi ini di browser web mereka.

pickerUri tidak dapat dibuka di iframe karena alasan keamanan.

Untuk aplikasi berbasis web, Anda dapat menambahkan /autoclose ke URI ini. Jendela atau tab Google Foto akan otomatis ditutup setelah pengguna selesai memilih, bukan menampilkan layar "Selesai".

pollingConfig

object (PollingConfig)

Hanya output. Konfigurasi yang direkomendasikan yang harus digunakan aplikasi saat melakukan polling sessions.get.

Kolom ini hanya diisi jika item media belum dipilih untuk sesi ini (yaitu, mediaItemsSet adalah salah (false).

expireTime

string (Timestamp format)

Hanya output. Waktu saat akses ke sesi ini (dan item media yang dipilihnya) akan berakhir.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".

pickingConfig

object (PickingConfig)

Opsional. Konfigurasi pemilihan foto untuk pengalaman pemilihan pengguna selama sesi ini.

ID ini ditentukan oleh aplikasi klien saat memanggil sessions.create, dan tidak dapat diubah setelahnya (tanpa membuat sesi baru).

mediaItemsSet

boolean

Hanya output. Jika disetel ke true, item media telah dipilih untuk sesi ini dan aplikasi Anda dapat meminta daftar item media yang dipilih melalui mediaItems.list.

PollingConfig

Konfigurasi untuk melakukan polling API.

Representasi JSON
{
  "pollInterval": string,
  "timeoutIn": string
}
Kolom
pollInterval

string (Duration format)

Hanya output. Waktu yang direkomendasikan di antara permintaan polling.

Durasi dalam detik dengan maksimal sembilan digit pecahan, yang diakhiri dengan 's'. Contoh: "3.5s".

timeoutIn

string (Duration format)

Hanya output. Durasi waktu setelah klien harus berhenti melakukan polling.

Nilai 0 menunjukkan bahwa klien harus berhenti melakukan polling jika belum melakukannya.

Durasi dalam detik dengan maksimal sembilan digit pecahan, yang diakhiri dengan 's'. Contoh: "3.5s".

PickingConfig

Konfigurasi yang ditentukan klien untuk pengalaman pemilihan pengguna selama sesi ini.

Representasi JSON
{
  "maxItemCount": string
}
Kolom
maxItemCount

string (int64 format)

Opsional. Jumlah maksimum item yang dapat dipilih pengguna selama sesi ini. Jika tidak ditentukan, nilai defaultnya adalah 2000.

Jika tidak ditentukan atau disetel ke 0, paling banyak 2.000 item dapat diambil. Nilai di atas 2000 akan dikonversi menjadi 2000. Nilai negatif akan menghasilkan error INVALID_ARGUMENT.

Metode

create

Membuat sesi baru selama pengguna dapat memilih foto dan video untuk akses pihak ketiga.

delete

Menghapus sesi yang ditentukan.

get

Mengambil informasi tentang sesi yang ditentukan.