OAuth

Catatan: Dokumen ini menjelaskan alur OAuth2 berkaki tiga yang digunakan untuk meminta akses ke data pihak lain. Gunakan alur autentikasi ini jika Anda mengembangkan aplikasi pihak ketiga yang memerlukan akses ke akun Merchant Center klien Anda. Jika Anda mengembangkan aplikasi internal yang hanya akan mengakses akun Merchant Center Anda sendiri, lihat panduan Akun Layanan.

Setiap permintaan yang dikirimkan aplikasi Anda ke Google Content API for Shopping 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 Content API for Shopping 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:

  1. Saat membuat aplikasi, Anda mendaftarkannya menggunakan Konsol Google API. Selanjutnya, Google menyediakan informasi yang akan Anda perlukan nanti, seperti ID klien dan rahasia klien.
  2. Aktifkan Google Content API for Shopping di Konsol API Google. (Jika API tidak tercantum di Konsol API, lewati langkah ini.)
  3. Saat memerlukan akses ke data pengguna, aplikasi Anda akan meminta cakupan akses tertentu kepada Google.
  4. Google menampilkan layar izin kepada pengguna, yang meminta mereka mengizinkan aplikasi Anda untuk meminta beberapa data.
  5. Jika pengguna menyetujui, Google akan memberikan token akses berumur singkat ke aplikasi Anda.
  6. Aplikasi Anda meminta data pengguna, dengan menambahkan token akses ke permintaan.
  7. 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 informasi cakupan OAuth 2.0 untuk Google Content API for Shopping:

Cakupan Arti
https://www.googleapis.com/auth/content Akses baca/tulis.

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.

Mendapatkan cakupan OAuth

Sebaiknya gunakan otorisasi inkremental untuk menghindari masalah terkait pemilihan cakupan.

Cakupan OAuth tidak dipilih secara default di layar izin untuk aplikasi Anda jika Anda meminta lebih dari satu. Saat aplikasi Anda menampilkan layar izin kepada pengguna, mereka harus memilih setiap cakupan secara manual untuk mengizinkan akses.

Periksa respons dari permintaan OAuth untuk memverifikasi bahwa Anda menerima cakupan yang sesuai.

Lihat halaman Kebijakan OAuth 2.0 untuk detail selengkapnya.

Meminta verifikasi aplikasi

Aplikasi apa pun yang mengakses Content API harus melalui proses peninjauan verifikasi OAuth. Pengguna aplikasi yang belum diverifikasi yang mengakses Content API akan menerima peringatan dan aplikasi tersebut akan memiliki fungsi terbatas. Dalam konteks ini, aplikasi didefinisikan sebagai Client ID OAuth 2.0 unik di Google Cloud.

Proses verifikasi biasanya memerlukan waktu 3-5 hari kerja. Untuk mempelajari proses tersebut lebih lanjut dan mengirimkan permintaan verifikasi, lihat Verifikasi untuk aplikasi.

Kebijakan ini berlaku untuk semua aplikasi, dan sebaiknya semua aplikasi menjalani proses verifikasi Google OAuth sesegera mungkin untuk menghindari gangguan bisnis.

Contoh Otorisasi

Kode berikut menunjukkan cara mengonfigurasi klien Anda dan mengizinkan permintaan menggunakan OAuth 2.0 untuk aplikasi web. Bahasa lain tersedia di halaman Contoh dan Library kami.

PHP

Contoh ini menggunakan alur Aplikasi Web. URI pengalihan harus berupa URI halaman PHP ini.

<?php
require_once 'Google/Client.php';

session_start();

$client = new Google_Client();
$client->setApplicationName('Sample Content API application');
$client->setClientId('YOUR_CLIENT_ID');
$client->setClientSecret('YOUR_CLIENT_SECRET');
$client->setRedirectUri('YOUR_REDIRECT_URI');
$client->setScopes('https://www.googleapis.com/auth/content');

if (isset($_SESSION['oauth_access_token'])) {
  $client->setAccessToken($_SESSION['oauth_access_token']);
} elseif (isset($_GET['code'])) {
  $token = $client->authenticate($_GET['code']);
  $_SESSION['oauth_access_token'] = $token;
} else {
  header('Location: ' . $client->createAuthUrl());
  exit;
}

Setelah mengautentikasi, Anda dapat membuat objek Service untuk membuat permintaan API.

require_once 'Google/Service/ShoppingContent.php';

$service = new Google_Service_ShoppingContent($client);