Google Photos API berisi beberapa cakupan yang digunakan untuk mengakses item media dan album. Respons yang ditampilkan dari berbagai panggilan berbeda berdasarkan cakupan yang telah diminta oleh developer.
Setiap permintaan yang dikirimkan aplikasi Anda ke Google Photos API harus menyertakan token otorisasi. Token ini juga mengidentifikasi aplikasi Anda ke Google.
Tentang protokol otorisasi
Aplikasi Anda harus menggunakan OAuth 2.0 untuk mengizinkan permintaan. Tidak ada protokol otorisasi lain yang didukung. Jika aplikasi Anda menggunakan Login dengan Google, beberapa aspek otorisasi akan ditangani untuk Anda.
Mengizinkan permintaan dengan OAuth 2.0
Semua permintaan ke Google Photos API harus diizinkan oleh pengguna terautentikasi.
Detail proses otorisasi, atau "alur", untuk OAuth 2.0 bervariasi bergantung pada jenis aplikasi yang Anda tulis. Proses umum berikut berlaku untuk semua jenis aplikasi:
- Saat membuat aplikasi, Anda mendaftarkannya menggunakan Konsol Google API. Selanjutnya, Google menyediakan informasi yang akan Anda perlukan nanti, seperti ID klien dan rahasia klien.
- Aktifkan Google Photos API di Konsol API Google. (Jika API tidak tercantum di Konsol API, lewati langkah ini.)
- Saat memerlukan akses ke data pengguna, aplikasi Anda akan meminta cakupan akses tertentu kepada Google.
- Google menampilkan layar izin kepada pengguna, yang meminta mereka mengizinkan aplikasi Anda untuk meminta beberapa data.
- Jika pengguna menyetujui, Google akan memberikan token akses berumur singkat ke aplikasi Anda.
- Aplikasi Anda meminta data pengguna, dengan menambahkan token akses ke permintaan.
- Jika Google menentukan bahwa permintaan Anda dan token tersebut valid, data yang diminta akan ditampilkan.
Beberapa alur mencakup langkah tambahan, seperti penggunaan token refresh untuk memperoleh token akses baru. Informasi selengkapnya tentang alur untuk berbagai jenis aplikasi dapat dilihat di dokumentasi OAuth 2.0 Google.
Berikut adalah informasi cakupan OAuth 2.0 untuk Google Photos API:
Cakupan API pemilih
Cakupan | Arti |
---|---|
https://www.googleapis.com/auth/photospicker.mediaitems.readonly |
Akses untuk membuat, mendapatkan, dan menghapus sesi, serta menampilkan daftar item media untuk sesi. |
Cakupan Library API
Cakupan | Arti |
---|---|
https://www.googleapis.com/auth/photoslibrary.readonly https://www.googleapis.com/auth/photoslibrary.sharing https://www.googleapis.com/auth/photoslibrary
|
|
https://www.googleapis.com/auth/photoslibrary.appendonly |
Akses untuk mengupload byte, membuat item media, membuat album, dan menambahkan pengayaan. Hanya mengizinkan media baru dibuat di galeri foto pengguna dan di album yang dibuat oleh aplikasi. |
https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata |
Akses baca ke item media dan album yang dibuat oleh developer. Untuk mengetahui informasi selengkapnya, lihat Mengakses item media dan Mencantumkan konten koleksi, album, dan item media. Dimaksudkan untuk diminta bersama dengan cakupan |
https://www.googleapis.com/auth/photoslibrary.edit.appcreateddata |
Hanya akses edit. Akses untuk mengubah detail ini untuk album dan item media yang dibuat oleh developer:
|
Untuk meminta akses menggunakan OAuth 2.0, aplikasi Anda memerlukan informasi cakupan, serta informasi yang disediakan oleh Google saat Anda mendaftarkan aplikasi (seperti ID klien dan rahasia klien).
Tips: Library klien Google API dapat menangani beberapa proses otorisasi secara otomatis. Library klien ini tersedia untuk berbagai bahasa pemrograman. Periksa halaman yang menjelaskan library beserta contohnya untuk mendapatkan informasi lebih mendetail.
Memilih cakupan
Sebagai aturan umum, pilih cakupan yang paling ketat dan hindari meminta cakupan yang tidak diperlukan aplikasi Anda. Pengguna lebih mudah memberikan akses ke cakupan terbatas yang dijelaskan dengan jelas. Pengguna mungkin ragu untuk memberikan akses yang luas ke media mereka kecuali jika mereka memercayai aplikasi Anda dan memahami mengapa aplikasi tersebut memerlukan informasi tersebut.
Meminta cakupan secara bertahap
Dengan mengikuti praktik terbaik untuk otorisasi, aplikasi Anda hanya boleh meminta cakupan sesuai kebutuhan. Hindari meminta semua cakupan untuk aplikasi Anda di awal saat login. Sebagai gantinya, berikan justifikasi dan buat permintaan dalam konteks. Jelaskan dengan jelas apa yang akan Anda lakukan dengan data pengguna dan manfaat yang akan mereka peroleh dengan memberikan akses, sesuai dengan Panduan UX dan praktik terbaik untuk memberikan pemberitahuan dan meminta izin.
Akun layanan
Google Photos API tidak mendukung akun layanan. Aplikasi Anda harus menggunakan alur OAuth 2.0 lain yang tersedia seperti OAuth 2.0 untuk aplikasi server web atau OAuth 2.0 untuk aplikasi seluler dan desktop.