Panggilan ke Search Ads 360 Reporting API biasanya dilakukan melalui library klien. Lihat Penjelasan library klien untuk informasi selengkapnya. Namun, pengetahuan tentang struktur detail permintaan yang mendasarinya dapat berguna saat pengujian dan proses debug.
Search Ads 360 Reporting API adalah gRPC API dengan binding REST. Ini berarti Anda dapat melakukan panggilan ke API dengan dua cara alternatif:
- Metode yang diinginkan
- Gunakan library klien:
- Buat isi permintaan sebagai buffering protokol.
- Kirim permintaan ke server menggunakan HTTP/2.
- Melakukan deserialisasi respons ke buffering protokol.
- Menginterpretasi hasil.
- Metode alternatif opsional
- Gunakan REST:
- Buat isi permintaan sebagai objek JSON.
- Mengirim permintaan ke server menggunakan HTTP 1.1.
- Melakukan deserialisasi respons sebagai objek JSON.
- Menginterpretasi hasil.
Lihat Google Cloud API untuk mengetahui informasi selengkapnya.
Bagian berikut berlaku untuk protokol gRPC dan REST.
Nama resource
Sebagian besar objek dalam API diidentifikasi melalui string nama resource-nya. String ini juga berfungsi sebagai URL saat menggunakan antarmuka REST.
Lihat Referensi > REST untuk mengetahui informasi selengkapnya tentang resource yang didukung dan representasi jalurnya. Format yang sama digunakan untuk layanan lainnya.
ID Gabungan
Jika ID objek tidak unik secara global, ID gabungan untuk objek tersebut akan dibuat dengan menambahkan ID induknya dan tanda gelombang (~).
Misalnya, karena ID iklan grup iklan tidak unik secara global, ID objek induk (grup iklan) ditambahkan di awal sehingga menghasilkan ID gabungan unik.
Contoh: AdGroupId dari 123 + ~ + AdGroupAdId dari 45678
= ID iklan grup iklan gabungan dari 123~45678.
Header permintaan
Header HTTP (atau metadata gRPC) di bagian berikut harus disertakan dalam isi permintaan.
Otorisasi
Anda harus menyertakan token akses OAuth2 dalam formulir:
Authorization: Bearer [OAUTH_2.0_ACCESS_TOKEN]
Token tersebut harus mengidentifikasi akun pengelola yang bertindak atas nama klien atau pengiklan yang mengelola langsung akun sub-pengelola atau klien mereka sendiri. Lihat artikel Tentang akun pengelola Search Ads 360 dan Autentikasi untuk mempelajari lebih lanjut.
Header ID pelanggan login
Header login-customer-id diperlukan saat menggunakan akun pengelola untuk mengakses akun klien atau sub-pengelola. Hal ini tidak diperlukan saat mengakses
akun klien atau sub-pengelola secara langsung. Meskipun tidak terlalu diperlukan, sebaiknya selalu tentukan login-customer-id untuk pengguna terautentikasi yang memiliki akses ke lebih dari satu akun. Hal ini menghindari ambiguitas dan mencegah
setelan konteks secara tidak sengaja ke akun yang salah.
Permintaan harus menyertakan ID pelanggan pengguna yang diotorisasi, tanpa tanda hubung (-), misalnya:
https://searchads360.googleapis.com/VERSION_NUMBER/customers/CUSTOMER_ID/campaignBudgets
Menetapkan login-customer-id sama dengan memilih akun di UI Search Ads 360 setelah login atau mengklik gambar profil Anda di kanan atas.
Header respons
Header berikut (atau metadata akhir gRPC) ditampilkan dengan isi respons. Sebaiknya catat nilai ini ke dalam log untuk tujuan proses debug.
ID Permintaan
Header request-id adalah string yang mengidentifikasi permintaan secara unik.