Anda memerlukan kredensial aplikasi OAuth 2.0 dan pengembang
token saat memanggil Google Ads API. Jika Anda melakukan panggilan API
dengan akun pengelola Google Ads, Anda juga harus menentukan login-customer-id
dengan setiap permintaan. Halaman ini menjelaskan cara menetapkan nilai-nilai tersebut dan
mendokumentasikan beberapa {i>header<i} HTTP tambahan khusus API yang dikirim dan
yang diterima saat menggunakan
antarmuka REST.
Kredensial OAuth 2.0
Google Ads API menggunakan kredensial aplikasi untuk mengidentifikasi dan memberi otorisasi API permintaan. Klien OAuth 2.0 dan layanan akun Google dapat dikonfigurasi. Untuk detail selengkapnya tentang mengkonfigurasi otorisasi sisi klien, lihat OAuth2 di API Google Ads.
Jika Anda baru mengenal Google API, Anda dapat menggunakan oauth2l atau OAuth 2.0 Playground untuk bereksperimen kredensial aplikasi dan Google Ads API sebelum menulis kode untuk .
Alur penggunaan aplikasi web atau desktop
Ikuti langkah-langkah untuk mengonfigurasi project Konsol API Google untuk API Google Ads. Catat client ID dan rahasia klien, kemudian kembali ke halaman ini.
Setelah membuat klien OAuth, ikuti alur aplikasi desktop petunjuk atau alur aplikasi web petunjuk untuk buat token refresh dan token akses.
Menggunakan akun layanan
Ikuti petunjuk umum di halaman Service Akun panduan untuk menyiapkan akses akun layanan untuk Google Ads API.
Setelah menyiapkan akun layanan untuk mengakses akun Google Ads Anda, ikuti
Menggunakan OAuth 2.0 untuk Server ke Server
Aplikasi
panduan, pastikan untuk memilih tab HTTP/REST. scope yang akan digunakan untuk Google Ads API
aksesnya adalah https://www.googleapis.com/auth/adwords.
Membuat token akses baru
Setelah memiliki client ID, rahasia klien, dan token refresh, 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
Selanjutnya, gunakan token akses yang ditampilkan oleh permintaan curl di
Header HTTP Authorization dari setiap panggilan API ke Google Ads API:
GET /v17/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN
Header permintaan
Token Developer
Google Ads API juga memerlukan token developer untuk melakukan panggilan ke API. Anda dapat mengajukan permohonan token untuk akun pengelola langsung dari UI Google Ads. Untuk detail selengkapnya tentang cara menyiapkan token developer, lihat Mendapatkan Token Developer Anda.
Anda perlu menyertakan nilai token developer di HTTP developer-token
header setiap panggilan API ke Google Ads API:
GET /v17/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN
ID pelanggan login
Untuk panggilan Google Ads 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 menyediakan header HTTP login-customer-id. Nilai ini mewakili
ID pelanggan Google Ads dari pengelola yang melakukan panggilan API.
Menyertakan header ini sama dengan memilih akun di UI Google Ads
setelah masuk atau mengeklik foto profil Anda di sudut kanan atas
pada halaman. Saat menentukan ID pelanggan, pastikan untuk menghapus tanda hubung (—),
misalnya: 1234567890, bukan 123-456-7890.
GET /v17/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN
login-customer-id: MANAGER_CUSTOMER_ID
ID pelanggan tertaut
Header ini hanya digunakan oleh penyedia analisis aplikasi pihak ketiga saat mengupload konversi ke akun Google Ads tertaut menggunakan akun layanan. Lihat Panduan Struktur Panggilan API untuk mengetahui detail selengkapnya.
...
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN
login-customer-id: MANAGER_CUSTOMER_ID
linked-customer-id: LINKED_CUSTOMER_ID
Header respons
Header berikut ditampilkan dalam respons HTTP dari API.
ID Permintaan
request-id adalah string yang mengidentifikasi permintaan API secara unik. Kapan
men-debug atau memecahkan masalah terkait panggilan API tertentu, request-id
adalah ID penting yang harus berguna saat menghubungi developer Google
dukungan teknis IT.
request-id: 2a5Cj89VV7CNhya1DZjjrC