Otorisasi dan Header HTTP

Anda memerlukan kredensial aplikasi OAuth 2.0 saat memanggil Search Ads 360 Reporting API. Jika Anda melakukan panggilan API sebagai Akun Pengelola Search Ads 360, Anda juga harus menentukan header login-customer-id dengan setiap permintaan. Halaman ini menjelaskan cara menetapkan nilai ini dan mendokumentasikan beberapa header HTTP khusus API tambahan yang dikirim dan diterima saat menggunakan antarmuka REST.

Kredensial OAuth 2.0

Search Ads 360 Reporting API menggunakan kredensial aplikasi untuk mengidentifikasi dan mengizinkan permintaan API. Klien OAuth 2.0 dapat dikonfigurasi. Semua panggilan Search Ads 360 Reporting API harus diotorisasi melalui OAuth2. OAuth2 memungkinkan aplikasi klien Search Ads 360 Reporting API Anda mengakses akun Search Ads 360 pengguna tanpa harus menangani atau menyimpan info login pengguna.

Jika Anda baru menggunakan Google API, Anda dapat menggunakan oauth2l atau OAuth 2.0 Playground untuk bereksperimen dengan kredensial aplikasi dan Search Ads 360 Reporting API sebelum menulis kode untuk aplikasi Anda. Anda juga dapat membuat token refresh OAuth dengan menjalankan skrip pembuatan kredensial pengguna yang disediakan.

Membuat token akses baru

Setelah memiliki client ID, client secret, dan refresh token, Anda dapat membuat token akses baru untuk digunakan dalam panggilan API dengan alat command line curl:

curl \
  --data "grant_type=refresh_token" \
  --data "client_id=CLIENT_ID" \
  --data "client_secret=CLIENT_SECRET" \
  --data "refresh_token=REFRESH_TOKEN" \
  https://www.googleapis.com/oauth2/v3/token

Kemudian, Anda menggunakan token akses yang ditampilkan oleh permintaan curl di header HTTP Authorization dari setiap panggilan API ke Search Ads 360 Reporting API:

GET /v0/customers:listAccessibleCustomers HTTP/1.1
Host: searchads360.googleapis.com
Authorization: Bearer ACCESS_TOKEN

Header permintaan

ID pelanggan login

Untuk panggilan Search Ads 360 Reporting API yang dilakukan oleh pengelola ke akun klien (yaitu, saat login sebagai pengelola untuk melakukan panggilan API ke salah satu akun kliennya), Anda juga perlu memberikan header HTTP login-customer-id. Nilai ini merepresentasikan ID pelanggan Search Ads 360 dari pengelola yang melakukan panggilan API.

Menyertakan header ini sama dengan memilih akun di UI Search Ads 360 setelah login atau mengklik foto profil Anda di sudut kanan atas halaman. Saat menentukan ID pelanggan, pastikan untuk menghapus tanda hubung (—), misalnya: 1234567890, bukan 123-456-7890.

GET /v0/customers:listAccessibleCustomers HTTP/1.1
Host: searchads360.googleapis.com
Authorization: Bearer ACCESS_TOKEN
login-customer-id: MANAGER_CUSTOMER_ID

Header respons

Header berikut ditampilkan dalam respons HTTP dari API.

ID Permintaan

request-id adalah string yang secara unik mengidentifikasi permintaan API. Saat men-debug atau memecahkan masalah pada panggilan API tertentu, request-id adalah ID penting yang harus tersedia saat menghubungi dukungan developer Google.

request-id: 2a5Cj89VV7CNhya1DZjjrC