Desain Antarmuka REST

Halaman ini mengasumsikan bahwa Anda sudah memahami panduan developer Desain Berorientasi Resource dan Nama Resource serta melengkapinya dengan detail implementasi spesifik Search Ads 360 Reporting API.

Desain yang berorientasi pada resource

Umumnya, Search Ads 360 Reporting API mengikuti desain berorientasi resource, yang dimodelkan sebagai koleksi resource yang dapat diberi alamat satu per satu (kata benda API). Resource dirujuk 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://searchads360.googleapis.com/v0/customers/1234567890/searchAds360:search
Awalan Versi API Nama Resource (relatif) Metode
https://searchads360.googleapis.com/v0 customers/1234567890 search

Semua URL REST untuk versi API tertentu (misalnya, v0) memiliki awalan versi API umum. Nama dan metode resource bersama-sama mengidentifikasi layanan API yang dipanggil.

Search Ads 360 Reporting API banyak menggunakan metode kustom, bukan REST API tradisional yang menggunakan metode REST standar seperti list dan get. Search Ads 360 Reporting API menyertakan dua metode kustom: search dan searchStream.

Halaman berikut membahas lebih lanjut nama resource, metode layanan, dan konvensi penamaan JSON Search Ads 360 Reporting API untuk mengilustrasikan cara penggunaannya bersama-sama untuk menentukan endpoint antarmuka REST.