Halaman ini mengasumsikan Anda telah memahami topik Berorientasi Sumber Daya Desain dan Referensi Panduan developer dan nama melengkapinya dengan detail penerapan khusus Google Ads API.
Desain yang berorientasi pada sumber daya
Umumnya, Google Ads API mengikuti desain berorientasi resource, dengan model sebagai koleksi resource yang dapat diberi alamat individual (kata benda API). Resource dirujuk dengan nama resource-nya dan dimanipulasi menggunakan kumpulan metode (juga dikenal sebagai kata kerja 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 komponen individual menurut 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. Nama resource dan metode bersama-sama
mengidentifikasi layanan API mana yang dipanggil.
Google Ads API banyak menggunakan metode kustom, dibandingkan
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 selengkapnya tentang referensi Google Ads API nama, metode layanan, dan Konvensi penamaan JSON untuk menggambarkan cara penggunaannya bersama-sama untuk menentukan endpoint antarmuka REST.