Search Ads 360 Reporting API versi baru kini tersedia. Bergabunglah dengan grup Google searchads-api-announcements untuk terus mendapatkan informasi terbaru tentang peningkatan dan rilis mendatang.

Halaman ini diterjemahkan oleh Cloud Translation API.

Struktur panggilan Search Ads 360 Reporting API

Panggilan ke Search Ads 360 Reporting API biasanya dilakukan melalui library klien Anda. Lihat Penjelasan library klien untuk mengetahui informasi selengkapnya. Namun, pengetahuan tentang struktur detail permintaan yang mendasarinya dapat berguna saat menguji dan men-debug.

Search Ads 360 Reporting API adalah gRPC API dengan binding REST. Artinya, Anda dapat melakukan panggilan ke API dengan dua cara alternatif:

Metode pilihan

Gunakan library klien:

Buat isi permintaan sebagai buffer protokol.
Kirim permintaan ke server menggunakan HTTP/2.
Lakukan deserialisasi respons ke buffering protokol.
Menginterpretasi hasil.

Metode alternatif opsional

Menggunakan REST:

Buat isi permintaan sebagai objek JSON.
Kirim permintaan ke server menggunakan HTTP 1.1.
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 di API diidentifikasi oleh 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 Komposit

Jika ID objek tidak unik secara global, ID gabungan untuk objek tersebut akan dibuat dengan menambahkan ID induk dan tilde (~) di awal.

Misalnya, karena ID iklan grup iklan tidak unik secara global, ID objek induk (grup iklan) ditambahkan di awal sehingga menghasilkan ID gabungan yang 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 bentuk:

Authorization: Bearer [OAUTH_2.0_ACCESS_TOKEN]

Token harus mengidentifikasi akun pengelola yang bertindak atas nama klien atau pengiklan yang langsung mengelola akun sub-pengelola atau akun kliennya sendiri. Lihat 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 sub-pengelola atau klien. Hal ini tidak diperlukan saat mengakses akun sub-pengelola atau klien secara langsung. Meskipun tidak sepenuhnya diperlukan, sebaiknya selalu tentukan login-customer-id untuk pengguna yang diautentikasi dan memiliki akses ke lebih dari satu akun. Hal ini menghindari ambiguitas dan mencegah konteks ditetapkan ke akun yang salah secara tidak sengaja.

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 Anda mencatat nilai ini ke dalam log untuk tujuan proses debug.

ID Permintaan

Header request-id adalah string yang secara unik mengidentifikasi permintaan.