Halaman ini mengasumsikan pemahaman tentang panduan developer Desain Berorientasi Resource dan Nama Resource, serta melengkapinya dengan detail implementasi spesifik Google Ads API.
Desain berorientasi resource
Secara umum, Google Ads API mengikuti desain berorientasi resource, yang dimodelkan sebagai koleksi resource yang dapat diakses secara individual (kata benda API). Resource direferensikan dengan nama resourcenya dan dimanipulasi menggunakan sekumpulan 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 contoh ini dapat dipecah menjadi komponen individual berikut sesuai dengan tabel berikut:
https://googleads.googleapis.com/v25/customers/1234567890:mutate
| Awalan Versi API | Nama Resource (relatif) | Metode |
|---|---|---|
https://googleads.googleapis.com/v25
|
customers/1234567890
|
mutate
|
Semua URL REST untuk versi API tertentu (misalnya, v25) menggunakan 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 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 lebih detail tentang nama resource, metode layanan, dan konvensi penamaan JSON Google Ads API untuk mengilustrasikan cara penggunaannya bersama-sama untuk menentukan endpoint antarmuka REST.
Pengelolaan error
Lihat Memahami error API untuk mendapatkan panduan tentang cara menganalisis dan men-debug error yang muncul.
Dokumen discovery
Untuk memfasilitasi dan mengotomatiskan penemuan metode yang tersedia di Google Ads API, Anda dapat menggunakan dokumen discovery yang dipublikasikan untuk setiap versi.
Dokumen ini tersedia di
https://googleads.googleapis.com/$discovery/rest?version=<API_VERSION>.
Jadi, misalnya, ini adalah
dokumen discovery
untuk versi terbaru Google Ads API.
Dokumen discovery berisi informasi tentang semua layanan, metode, resource, dan entity yang digunakan di Google Ads API, seperti dokumentasi referensi, tetapi dalam format JSON yang dapat dibaca mesin.