1.1: Penautan Akun OAuth
Pengantar dan Dampak Bisnis
Untuk memanfaatkan Google API, OAuth diperlukan untuk memberi integrasi Anda akses penjual yang diperlukan untuk mengaktivasinya ke Listingan Gratis dan Iklan Berbayar.
Aplikasi Anda harus menggunakan OAuth 2.0 untuk mengizinkan permintaan. Tidak ada protokol otorisasi lain yang didukung.
Panduan UX
Tujuan: Meminta penjual diizinkan untuk membagikan penggunaan data mereka untuk aplikasi Google.
Prinsip desain: Minta izin yang tepat pada waktu yang tepat. Jika penjual tidak memberikan izin, Anda akan gagal.
Penjual diminta untuk memberikan izin akses. Cari contoh bagaimana petunjuk ini dapat ditampilkan kepada penjual:
Setelah penjual melakukan langkah-langkah awal ini, ada tiga kemungkinan hasil:
Hasil #1: Jika penjual menyetujui semua izin:
Jika penjual memberikan izin penuh, ia akan mencentang semua kotak dan diminta untuk melanjutkan proses orientasi.
Hasil #2: Jika penjual tidak menyetujui Google Ads
Penjual mencentang semua kotak, kecuali izin yang terkait dengan Google Ads. Pengguna melanjutkan proses aktivasi, lalu saat membuat akun Google Ads baru atau terhubung ke akun yang sudah ada, mereka akan diminta kembali untuk memberikan izin:
Hasil #3: Jika verifikasi situs atau data produk tidak dicentang, penjual tidak dapat melanjutkan aktivasi
Semua opsi sebelumnya menghasilkan pesan error yang sama:
Panduan Teknologi
Pilih permintaan otorisasi dengan OAuth 2.0
Ada dua metode untuk memilih metode autentikasi penjual:
OAuth 2.0 untuk akun non-layanan (Sangat Disarankan) | OAuth 2.0 untuk akun layanan |
---|---|
Klien OAuth 2.0 mengidentifikasi aplikasi dan memungkinkan pengguna akhir memberi aplikasi Anda akses terbatas ke data Google mereka. Izin ini memungkinkan aplikasi Anda mengakses Google Cloud API atas nama pengguna akhir. Kemunculan yang tercantum menyebabkan token akses dibatalkan yang harus diperhitungkan dalam kode: ● Pengguna telah mencabut akses ● Pengguna telah mengubah sandi ● Jumlah token refresh yang diberikan melebihi batas ● Token refresh tidak digunakan dalam 6 bulan |
Akun layanan adalah Akun Google khusus yang dapat digunakan oleh aplikasi untuk mengakses Google API secara terprogram menggunakan OAuth 2.0.Akun layanan ini menggunakan alur OAuth 2.0 yang tidak memerlukan otorisasi manusia. Sebagai gantinya, proses ini akan menggunakan file kunci yang hanya dapat diakses oleh aplikasi Anda. Catatan: Aplikasi yang menggunakan akun layanan untuk autentikasi hanya dapat mengakses akun Merchant Center-nya sendiri. Jika Anda membuat aplikasi pihak ketiga yang memerlukan akses ke akun Merchant Center klien, lihat panduan Permintaan Otorisasi. Catatan: project Cloud diperlukan dan memungkinkan pembuatan hingga 100 akun layanan. Lihat dokumentasi |
Menyiapkan alur OAuth
Framework otorisasi OAuth 2.0 memungkinkan aplikasi pihak ketiga memperoleh akses terbatas ke layanan HTTP, baik atas nama pemilik resource dengan mengorkestrasi interaksi persetujuan antara pemilik resource dan layanan HTTP, atau dengan mengizinkan aplikasi pihak ketiga untuk mendapatkan akses atas namanya sendiri.
Karena aplikasi Anda mengakses data yang dilindungi (non-publik), Anda memerlukan client ID OAuth 2.0. Google API menggunakan protokol OAuth 2.0 untuk autentikasi dan otorisasi. Google mendukung skenario OAuth 2.0 umum, seperti skenario untuk aplikasi server web, terinstal, dan sisi klien.
Pelajari Lebih Lanjut
Hal-hal yang perlu diketahui tentang penggunaan OAuth untuk Content API for Shopping:
Pastikan Anda telah menetapkan access_type ke offline: Masa berlaku token akses akan berakhir secara berkala dan menjadi kredensial yang tidak valid untuk permintaan API terkait.
Memperbarui token akses: Anda dapat melakukannya tanpa meminta izin kepada pengguna (termasuk saat pengguna tidak ada) jika Anda meminta akses offline ke cakupan yang terkait dengan token tersebut (pelajari lebih lanjut).
Implementasi OAuth di Library: Sebaiknya gunakan Library Klien Google API.
Cakupan: Anda perlu meminta penjual untuk memberi Anda akses baca dan tulis ke Akun Google miliknya dengan cakupan OAuth Google Merchant Center: https://www.googleapis.com/auth/content.
Anda dapat menggunakan OAuth untuk mendapatkan info utama profil pengguna.
Cakupan yang akan digunakan untuk integrasi Anda
Bergantung pada jenis integrasi yang ingin Anda buat untuk penjual, sebaiknya minta semua cakupan yang diperlukan saat ini.
Program | Cakupan | Format mana yang merupakan cakupan yang diperlukan |
---|---|---|
Content API | https://www.googleapis.com/auth/content |
Listingan Gratis |
Verifikasi Situs | https://www.googleapis.com/auth/siteverification |
Listingan Gratis & Iklan Berbayar |
Iklan | https://www.googleapis.com/auth/adwords |
Listingan Gratis & Iklan Berbayar |
Periksa apakah penjual telah memberikan akses OAuth
Penjual harus mencentang kotak dalam alur izin OAuth untuk memberi Anda akses ke cakupan tertentu: Jika cakupan yang diperlukan tidak ada, jelaskan kepada penjual mengapa cakupan tersebut diperlukan dan minta izin lagi (detail selengkapnya). Karena tidak memiliki akses ke semua izin ini, penjual tidak akan dapat melakukan orientasi sepenuhnya.
Panggil endpoint API berikut untuk memeriksa cakupan yang diberikan:
https://www.oauth2.googleapis.com/token
URL tersebut menampilkan informasi berikut:
- access_token
- cakupan yang diberikan ke pengguna
- waktu sebelum masa berlaku token habis
Cakupan Sensitif dan Proses Verifikasi OAuth
Beberapa cakupan yang digunakan oleh OAuth API dianggap sensitif dan memerlukan proses verifikasi. Informasi dan contoh tambahan dapat ditemukan di OAuth untuk Content API.
Cakupan aplikasi sensitif untuk memenuhi kebijakan: Perlu memastikan bahwa aplikasi Anda mematuhi Kebijakan Data Pengguna Layanan API Google. Anda juga harus menyetujui persyaratan layanan API.
Pastikan aplikasi Anda tidak termasuk dalam salah satu kasus penggunaan yang tercantum dalam Pengecualian untuk persyaratan verifikasi.
Verifikasi kepemilikan domain resmi project Anda menggunakan Search Console. Gunakan akun yang merupakan Pemilik Project atau Editor Project dari project Konsol Cloud Anda.
Pastikan semua informasi branding di layar izin OAuth cocok dan valid, seperti: nama project yang ditampilkan kepada pengguna, email dukungan, URL halaman beranda, dan URL kebijakan privasi, mewakili identitas aplikasi secara akurat.
Minta aplikasi Anda untuk cakupan sensitif dengan proses verifikasi: Ikuti proses yang mengharuskan pengisian formulir, memberikan justifikasi, dan mengirim video.