Trang này giả định bạn đã quen thuộc với hướng dẫn cho nhà phát triển về Thiết kế hướng tài nguyên và Tên tài nguyên, đồng thời bổ sung các thông tin chi tiết cụ thể về cách triển khai của API Báo cáo Search Ads 360 vào các hướng dẫn đó.
Thiết kế hướng tài nguyên
Nhìn chung, API Báo cáo Search Ads 360 tuân theo thiết kế hướng tài nguyên, được mô hình hoá dưới dạng bộ sưu tập gồm các tài nguyên có thể định địa chỉ riêng (danh từ của API). Các tài nguyên được tham chiếu cùng với tên tài nguyên và được điều khiển bằng một tập hợp nhỏ các phương thức (còn gọi là động từ hoặc phép toán).
Các tên tài nguyên và phương thức này (kết hợp với tiền tố phiên bản API cụ thể) tạo thành các URL của giao diện REST. Ví dụ: có thể phân tích URL bên dưới thành các thành phần riêng lẻ theo bảng sau:
https://searchads360.googleapis.com/v0/customers/1234567890/searchAds360:search
| Tiền tố phiên bản API | Tên tài nguyên (tương đối) | Phương thức |
|---|---|---|
https://searchads360.googleapis.com/v0
|
customers/1234567890
|
search
|
Tất cả URL REST cho một phiên bản cụ thể của API (ví dụ: v0) chia sẻ một tiền tố phổ biến của phiên bản API. Tên và phương thức tài nguyên cùng xác định dịch vụ API nào đang được gọi.
API Báo cáo Search Ads 360 chủ yếu sử dụng các phương thức tuỳ chỉnh, thay vì hầu hết các API REST truyền thống sử dụng phương thức REST tiêu chuẩn như list và get. API Báo cáo Search Ads 360
bao gồm hai phương thức tuỳ chỉnh: search và searchStream.
Các trang sau đây sẽ đi sâu hơn về tên tài nguyên, phương thức dịch vụ và quy ước đặt tên JSON của API Báo cáo Search Ads 360 để minh hoạ cách chúng được sử dụng cùng nhau nhằm xác định điểm cuối trên giao diện REST.