Halaman ini mengasumsikan Anda telah memahami panduan developer Desain Berorientasi Resource dan Nama Resource serta melengkapinya dengan detail implementasi spesifik Google Ads API.
Desain yang berorientasi pada sumber daya
Umumnya, Google Ads API mengikuti desain berorientasi resource, yang dimodelkan sebagai koleksi resource yang dapat diberi alamat satu per satu (kata benda API). Resource dirujuk dengan nama resource-nya dan dimanipulasi menggunakan sejumlah kecil metode (juga dikenal sebagai verbs atau operasi).
Nama resource dan metode ini, yang digabungkan dengan awalan versi API tertentu, akan membentuk URL antarmuka REST. Misalnya, URL di bawah dapat dibagi menjadi komponen-komponen individual sesuai dengan tabel berikut:
https://googleads.googleapis.com/v17/customers/1234567890:mutate
| Awalan Versi API | Nama Resource (relatif) | Metode |
|---|---|---|
https://googleads.googleapis.com/v17
|
customers/1234567890
|
mutate
|
Semua URL REST untuk versi API tertentu (mis., v17)
memiliki awalan versi API umum. Bersama-sama nama resource dan metode
mengidentifikasi layanan API yang dipanggil.
Google Ads API banyak menggunakan metode kustom, tidak seperti REST API 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.