Halaman ini mengasumsikan Anda telah memiliki pengetahuan tentang panduan developer Resource Oriented Design dan Resource Names serta melengkapi mereka dengan detail penerapan spesifik Search Ads 360 Reporting API.
Desain yang berorientasi pada sumber daya
Umumnya, Search Ads 360 Reporting API mengikuti desain berorientasi resource, yang dimodelkan sebagai koleksi resource yang dapat diberi alamat individual (kata benda API). Resource dirujuk dengan nama resource-nya dan dimanipulasi menggunakan sekumpulan kecil metode (juga dikenal sebagai verbs atau operasi).
Nama resource dan metode ini, digabungkan dengan awalan versi API tertentu, terdiri dari URL antarmuka REST. Misalnya, URL di bawah dapat dibagi menjadi beberapa komponen individual sesuai dengan tabel berikut:
https://searchads360.googleapis.com/v0/customers/1234567890/searchAds360:search
| Awalan Versi API | Nama Resource (relatif) | Metode |
|---|---|---|
https://searchads360.googleapis.com/v0
|
customers/1234567890
|
search
|
Semua URL REST untuk versi API tertentu (mis., v0)
memiliki awalan versi API yang sama. Nama dan metode resource bersama-sama mengidentifikasi layanan API mana yang dipanggil.
Search Ads 360 Reporting API banyak menggunakan metode kustom, dibandingkan dengan REST API paling tradisional yang menggunakan metode REST standar seperti list dan get. Search Ads 360 Reporting API menyertakan dua metode kustom: search dan searchStream.
Halaman berikut memberikan detail selengkapnya tentang nama resource, metode layanan, dan konvensi penamaan JSON Search Ads 360 Reporting API untuk menggambarkan cara keduanya digunakan bersama untuk menentukan endpoint antarmuka REST.