Halaman ini mengasumsikan bahwa Anda sudah memahami panduan developer Resource Oriented Design dan Resource Names serta melengkapinya dengan detail penerapan spesifik Google Ads API.
Desain yang berorientasi pada resource
Umumnya, Google Ads API mengikuti desain yang berorientasi pada resource, yang dimodelkan sebagai koleksi resource yang dapat dialamatkan satu per satu (kata benda API). Resource direferensikan dengan nama resource-nya dan dimanipulasi menggunakan kumpulan kecil metode (juga dikenal sebagai kata kerja atau operasi).
Nama resource dan metode ini, yang digabungkan dengan awalan versi API tertentu, membentuk URL antarmuka REST. Misalnya, URL di bawah dapat dipecah menjadi setiap komponen ini sesuai dengan tabel berikut:
https://googleads.googleapis.com/v18/customers/1234567890:mutate
| Awalan Versi API | Nama Resource (relatif) | Metode |
|---|---|---|
https://googleads.googleapis.com/v18
|
customers/1234567890
|
mutate
|
Semua URL REST untuk versi API tertentu (misalnya, v18)
membagikan awalan versi API yang sama. Nama dan metode resource bersama-sama
mengidentifikasi layanan API yang dipanggil.
Google Ads API banyak menggunakan metode kustom, tidak seperti kebanyakan
REST API tradisional yang menggunakan metode REST standar seperti list, get,
create, update, dan delete. Contoh metode kustom di Google Ads API
meliputi search, searchStream, dan mutate.
Halaman berikut membahas lebih lanjut nama resource, metode layanan, dan konvensi penamaan JSON Google Ads API untuk mengilustrasikan cara penggunaannya bersama-sama untuk menentukan endpoint antarmuka REST.