Membuat dan mengelola sesi

Sesi adalah inti dari Picker API, yang menyediakan cara yang aman dan terkontrol bagi pengguna untuk memilih foto dan video dari galeri Google Foto mereka. Panduan ini menguraikan cara membuat, mengelola, dan melakukan polling sesi secara efektif untuk memungkinkan pemilihan foto yang lancar di aplikasi Anda.

Sebelum memulai

  • Konfigurasikan aplikasi Anda: Aktifkan API dan siapkan autentikasi. Lihat Mengonfigurasi aplikasi untuk mengetahui langkah-langkah mendetail.
  • Pahami alur: Tinjau memulai Picker API untuk mengetahui ringkasan seluruh proses pemilihan foto.
  • Tinjau cakupan otorisasi yang diperlukan: Untuk menggunakan sesi, Anda memerlukan cakupan photospicker.mediaitems.readonly. Untuk informasi selengkapnya tentang cakupan, lihat Cakupan otorisasi.

Siklus proses sesi

Picker API menyediakan metode untuk membuat, mengambil informasi tentang, dan menghapus sesi. Setelah mengautentikasi pengguna, Anda dapat menggunakan sesi untuk mengelola siklus proses pemilihan foto.

  1. Buat sesi agar pengguna dapat memilih item media.
  2. Lakukan polling sesi untuk memeriksa kapan pengguna selesai memilih item media.
  3. Mencantumkan dan mengambil item media.
  4. Bersihkan sesi dengan menghapusnya.

Membuat sesi

Buat sesi agar pengguna dapat memilih foto dengan aman langsung dari aplikasi Google Foto mereka, lalu membagikannya kembali ke aplikasi Anda.

sessions.create menghasilkan sesi baru, yang menampilkan pickerUri unik yang dapat Anda presentasikan kepada pengguna. Sesi tetap aktif hingga pengguna berhasil memilih item media, atau waktu tunggu sesi habis.

Batas sesi

Perhatikan batas sesi. Picker API menerapkan batas pada jumlah sesi yang dapat Anda buat untuk memastikan penggunaan yang bertanggung jawab dan mencegah penyalahgunaan. Dalam keadaan normal, Anda tidak akan mencapai batas ini. Namun, Anda harus melacak dan membersihkan sesi secara proaktif untuk menghindari masalah.

Melakukan polling dan memantau sesi

Setelah sesi dibuat, lakukan polling endpoint sessions.get secara berkala untuk mendapatkan status sesi. Properti mediaItemsSet dalam respons menampilkan true saat pengguna menyelesaikan pilihannya.

Pastikan untuk menggunakan polling yang efisien. Respons sessions.get menyertakan objek pollingConfig. Gunakan kolom berikut untuk membantu Anda menghindari panggilan yang tidak perlu dan menciptakan pengalaman pengguna yang lancar:

  • pollInterval: interval polling yang optimal
  • timeoutIn: durasi waktu tunggu

Lihat Contoh alur polling untuk mengetahui detail selengkapnya.

Menghapus dan merapikan sesi

sessions.delete menghapus sesi, biasanya digunakan untuk pembersihan setelah pengguna selesai memilih media atau jika waktu sesi habis.

Praktik terbaiknya adalah menghapus sesi setelah pengguna memilih item media dan aplikasi Anda telah mengambil byte item media.

Contoh alur polling

Ini adalah contoh pembuatan dan polling sesi. Setelah mengautentikasi pengguna Anda untuk pertama kali, buat sesi baru.

  1. Buat sesi: Panggil sessions.create untuk memulai sesi baru dan mendapatkan pickerUri.
  2. Presentasikan pickerUri kepada pengguna: Tampilkan URL atau buat kode QR untuk dipindai oleh pengguna. Baca ringkasan pengalaman pemilihan pengguna.
  3. Melakukan polling sesi:
    1. Gunakan pollInterval yang direkomendasikan dari pollingConfig.
    2. Periksa apakah mediaItemsSet bernilai benar.
      1. Jika true, lanjutkan untuk mencantumkan item media yang dipilih.
      2. Jika false, lanjutkan polling hingga timeoutIn tercapai.
    3. Menangani waktu tunggu dan pembatalan dengan lancar.
GET https://photoslibrary.googleapis.com/v1/sessions/{sessionId}

Berikut adalah contoh respons:

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

Tampilkan pickerUri kepada pengguna, lalu mulai lakukan polling sesi.

Periksa respons untuk hal berikut:

  • mediaItemsSet: benar jika pengguna telah selesai memilih item media
  • pollingConfig.pollInterval: waktu tunggu yang direkomendasikan sebelum polling berikutnya
  • pollingConfig.timeoutIn: total waktu tunggu sebelum waktu tunggu habis

Jika mediaItemsSet bernilai salah dan timeoutIn belum tercapai, tunggu pollInterval, lalu lakukan polling lagi.

Jika mediaItemsSet benar, lanjutkan untuk mencantumkan item media yang dipilih.

Jika timeoutIn tercapai, tangani waktu tunggu dengan baik.