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
Umumnya, Google Ads API mengikuti desain berorientasi resource, yang dimodelkan sebagai koleksi resource yang dapat diakses secara individual (kata benda API). Resource direferensikan dengan nama resource-nya 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, contoh URL ini dapat dipecah menjadi komponen-komponen individual berikut sesuai dengan tabel berikut:
https://googleads.googleapis.com/v26/customers/1234567890:mutate
| Awalan Versi API | Nama Resource (relatif) | Metode |
|---|---|---|
https://googleads.googleapis.com/v26
|
customers/1234567890
|
mutate
|
Semua URL REST untuk versi API tertentu (misalnya, v26)
memiliki awalan versi API yang sama. Nama resource dan metode bersama-sama
mengidentifikasi layanan API yang dipanggil.
Google Ads API sangat sering menggunakan metode kustom, tidak seperti kebanyakan 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 menggambarkan 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.
Tersedia di
https://googleads.googleapis.com/$discovery/rest?version=<API_VERSION>.
Jadi, misalnya, ini adalah
dokumen discovery
untuk Google Ads API versi terbaru.
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.