Halaman ini mengasumsikan pemahaman tentang panduan developer Desain Berorientasi Resource dan Nama Resource serta melengkapinya dengan detail penerapan khusus Google Ads API.
Desain berorientasi resource
Secara umum, Google Ads API mengikuti desain berorientasi resource, yang dimodelkan sebagai kumpulan resource yang dapat diakses secara individual (kata benda API). Resource dirujuk dengan nama resource-nya dan dimanipulasi menggunakan serangkaian metode kecil (juga dikenal sebagai kata kerja atau operasi).
Nama resource dan metode ini, jika digabungkan dengan awalan versi API tertentu, membentuk URL antarmuka REST. Misalnya, URL di bawah dapat dipecah menjadi komponen individual ini sesuai dengan tabel berikut:
https://googleads.googleapis.com/v21/customers/1234567890:mutate
| Awalan Versi API | Nama Resource (relatif) | Metode |
|---|---|---|
https://googleads.googleapis.com/v21
|
customers/1234567890
|
mutate
|
Semua URL REST untuk versi API tertentu (misalnya, v21)
berbagi awalan versi API yang sama. Nama resource dan metode bersama-sama
mengidentifikasi layanan API mana yang dipanggil.
Google Ads API banyak menggunakan metode kustom, berbeda dengan sebagian besar
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 menjelaskan lebih lanjut nama resource, metode layanan, dan konvensi penamaan JSON Google Ads API untuk mengilustrasikan cara penggunaannya bersama-sama untuk menentukan endpoint antarmuka REST.
Dokumen discovery
Untuk memfasilitasi dan mengotomatiskan penemuan metode yang tersedia di Google Ads API, Anda dapat menggunakan dokumen penemuan yang dipublikasikan untuk setiap versi.
Fitur ini tersedia di https://googleads.googleapis.com/$discovery/rest?version=<API_VERSION>.
Jadi, misalnya, ini
adalah dokumen penemuan untuk Google Ads API versi terbaru.
Dokumen penemuan berisi informasi tentang semua layanan, metode, resource, dan entitas yang digunakan di Google Ads API, seperti dokumentasi referensi, tetapi dalam format JSON yang dapat dibaca mesin.