Halaman ini mengasumsikan Anda telah memahami panduan developer Desain Berorientasi Resource dan Nama Resource serta melengkapi panduan tersebut dengan detail penerapan tertentu dari Google Ads API.
Desain yang berorientasi pada resource
Umumnya, Google Ads API mengikuti desain berorientasi resource, yang dimodelkan sebagai koleksi resource yang dapat diberi alamat satu per satu (kata benda API). Resource direferensikan dengan nama resource-nya dan dimanipulasi menggunakan serangkaian kecil metode (juga dikenal sebagai verbs atau operasi).
Nama resource dan metode ini, yang dikombinasikan dengan awalan versi API khusus, membentuk URL antarmuka REST. Misalnya, URL di bawah ini dapat dibagi menjadi komponen individual sesuai dengan tabel berikut:
https://googleads.googleapis.com/v16/customers/1234567890:mutate
| Awalan Versi API | Nama Resource (relatif) | Metode |
|---|---|---|
https://googleads.googleapis.com/v16
|
customers/1234567890
|
mutate
|
Semua URL REST untuk versi API tertentu (mis., v16)
memiliki awalan versi API yang sama. Nama resource dan metode secara bersamaan
mengidentifikasi layanan API mana yang dipanggil.
Google Ads API banyak menggunakan metode kustom, dibandingkan dengan REST API yang paling tradisional yang menggunakan metode REST standar seperti list, get, create, update, dan delete. Contoh metode kustom di Google Ads API
mencakup search, searchStream, dan mutate.
Halaman berikut membahas detail lebih lanjut tentang nama resource, metode layanan, dan konvensi penamaan JSON Google Ads API untuk menggambarkan cara keduanya digunakan bersama untuk menentukan endpoint antarmuka REST.