Internal OAuth 2.0 untuk Google Ads API

Bagian ini ditujukan bagi pengguna tingkat lanjut yang sudah memahami spesifikasi OAuth 2.0 dan mengetahui cara menggunakan OAuth 2.0 dengan Google API.

Cakupan

Satu token akses dapat memberikan berbagai tingkat akses ke beberapa API. Parameter variabel yang disebut scope mengontrol kumpulan resource dan operasi yang diizinkan oleh token akses. Selama permintaan token akses, aplikasi Anda mengirim satu atau beberapa nilai dalam parameter scope.

Cakupan untuk Google Ads API adalah:

https://www.googleapis.com/auth/adwords

Akses offline dan masa berlaku token

Aplikasi klien Google Ads API biasanya meminta akses offline. Misalnya, aplikasi Anda mungkin ingin menjalankan tugas batch saat pengguna Anda tidak sedang online secara fisik menjelajahi situs Anda. Token akses memiliki masa aktif 3.600 detik (1 jam), setelah itu aplikasi Anda harus menukarkan token refresh dengan token akses baru.

Untuk meminta akses offline untuk jenis aplikasi web, pastikan Anda menetapkan parameter access_type ke offline. Anda dapat menemukan informasi tambahan di panduan OAuth 2.0 Google.

Untuk jenis aplikasi desktop, akses offline diaktifkan secara default—Anda tidak perlu memintanya secara eksplisit.

Header permintaan

Semua permintaan ke Google Ads API harus menyertakan token akses OAuth 2.0 di header permintaan. Bagian berikut menjelaskan cara meneruskan kredensial ini menggunakan gRPC dan REST.

Header gRPC

Saat menggunakan gRPC API, sertakan token akses dalam setiap permintaan. Anda dapat mengikat Credential ke Channel untuk digunakan pada semua permintaan di saluran tersebut. Anda juga dapat mengirim kredensial yang disesuaikan untuk setiap panggilan. Panduan Otorisasi gRPC berisi detail selengkapnya tentang penanganan otorisasi.

Header REST

Saat menggunakan REST API, teruskan token akses melalui header HTTP Authorization: Bearer <ACCESS_TOKEN>. Contoh permintaan HTTP ditampilkan:

# Returns the resource names of customers directly accessible by the user
# authenticating the call.
#
# Variables:
#   API_VERSION,
#   OAUTH2_ACCESS_TOKEN:
#     See https://developers.google.com/google-ads/api/rest/auth#request_headers
#     for details.
#
curl -f --request GET \
"https://googleads.googleapis.com/v${API_VERSION}/customers:listAccessibleCustomers" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer ${OAUTH2_ACCESS_TOKEN}" \