Sesi merupakan inti dari Picker API, yang menyediakan API yang aman dan terkontrol bagi pengguna untuk memilih foto dan album 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
- Mengonfigurasi aplikasi: Mengaktifkan API dan menyiapkan autentikasi. Lihat Konfigurasi aplikasi Anda untuk detail langkah.
- Pahami alurnya: Tinjau mulai menggunakan Picker API untuk ringkasan keseluruhan proses pemilihan foto.
- Tinjau cakupan otorisasi yang diperlukan: Penggunaan sesi memerlukan
photospicker.mediaitems.readonly
cakupan. Untuk informasi selengkapnya tentang cakupan, lihat Cakupan otorisasi.
Siklus proses sesi
Picker API menyediakan metode untuk membuat, mengambil informasi, dan menghapus sesi. Setelah mengautentikasi pengguna, Anda dapat menggunakan sesi untuk mengelola siklus hidup pemilihan foto.
- Buat sesi agar pengguna dapat memilih item media.
- Lakukan polling sesi untuk memeriksa kapan pengguna selesai memilih item media.
- Mencantumkan dan mengambil item media.
- Bersihkan sesi dengan menghapusnya.
Membuat sesi
Buat sesi agar pengguna dapat memilih foto dengan aman langsung dari aplikasi Google Foto mereka, dan membagikannya kembali ke aplikasi Anda.
sessions.create
membuat sesi baru, yang menampilkan pickerUri
unik yang
yang dapat Anda presentasikan
kepada pengguna Anda. Sesi tetap aktif sampai pengguna
telah berhasil memilih item media, atau waktu sesi habis.
Batas sesi
Perhatikan batas sesi. Picker API menerapkan batas jumlah yang dapat Anda buat untuk memastikan penggunaan yang bertanggung jawab dan mencegah penyalahgunaan. Di Bawah keadaan normal, maka kemungkinan Anda tidak akan mencapai batas tersebut. Namun, Anda harus pantau dan bersihkan sesi secara proaktif untuk menghindari masalah performa.
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 telah menyelesaikan pilihannya.
Pastikan untuk menggunakan polling yang efisien. Respons sessions.get
mencakup
Objek pollingConfig
. Gunakan kolom berikut untuk membantu Anda menghindari panggilan yang tidak perlu
dan menciptakan pengalaman pengguna yang lancar:
pollInterval
: interval polling yang optimaltimeoutIn
: durasi waktu tunggu
Lihat Contoh alur polling untuk mengetahui detail selengkapnya.
Menghapus dan merapikan sesi
sessions.delete
menghapus sesi, yang biasanya digunakan untuk pembersihan setelah pengguna
telah selesai memilih media atau jika waktu sesi habis.
Praktik terbaik adalah menghapus sesi setelah pengguna memilih item media dan aplikasi Anda telah mengambil item media byte.
Contoh alur polling
Ini adalah contoh pembuatan dan polling sesi. Setelah autentikasi pertama pengguna Anda, buat sesi baru.
- Membuat sesi: Panggil
sessions.create
untuk memulai sesi baru dan mendapatkanpickerUri
. - Presentasikan
pickerUri
kepada pengguna: Tampilkan URL atau buat QR kode untuk dipindai oleh pengguna. - Melakukan polling sesi:
- Gunakan pollingInterval yang direkomendasikan dari
pollingConfig
. - Periksa apakah
mediaItemsSet
benar.- Jika
true
, lanjutkan untuk mencantumkan item media yang dipilih. - Jika
false
, lanjutkan polling hinggatimeoutIn
tercapai.
- Jika
- Tangani waktu tunggu dan pembatalan dengan baik.
- Gunakan pollingInterval yang direkomendasikan dari
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
: true (benar) jika pengguna telah selesai memilih item mediapollingConfig.pollInterval
: waktu tunggu yang direkomendasikan sebelum pemungutan suara berikutnyapollingConfig.timeoutIn
: total waktu tunggu sebelum waktu tunggu habis
Jika mediaItemsSet
salah dan timeoutIn
belum dijangkau, tunggu
pollInterval
lalu lakukan polling lagi.
Jika mediaItemsSet
bernilai benar, lanjutkan untuk mencantumkan item media yang dipilih.
Jika timeoutIn
tercapai, tangani waktu tunggu dengan baik.