Trang này giả định rằng bạn đã quen thuộc với hướng dẫn dành cho nhà phát triển về Thiết kế hướng đến tài nguyên và Tên tài nguyên, đồng thời bổ sung cho các hướng dẫn đó thông tin chi tiết về cách triển khai cụ thể của API Báo cáo Search Ads 360.
Thiết kế hướng đến tài nguyên
Nhìn chung, Search Ads 360 Reporting API tuân theo thiết kế hướng đến tài nguyên, được mô hình hoá dưới dạng bộ sưu tập các tài nguyên có thể định địa chỉ riêng lẻ (danh từ của API). Tài nguyên được tham chiếu bằng tên tài nguyên và được thao tác bằng một nhóm nhỏ phương thức (còn gọi là động từ hoặc toán tử).
Các tên tài nguyên và phương thức này, kết hợp với một tiền tố phiên bản API cụ thể, bao gồm các URL của giao diện REST. Ví dụ: URL dưới đây có thể được chia thành các thành phần riêng lẻ này 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 API cụ thể (ví dụ: v0) có chung một tiền tố phiên bản API. Tên tài nguyên và phương thức cùng nhau xác định dịch vụ API nào đang được gọi.
API Báo cáo Search Ads 360 sử dụng nhiều phương thức tuỳ chỉnh, trái ngược với hầu hết các API REST truyền thống sử dụng các phương thức REST 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 trình bày chi tiết 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 sử dụng các tên này cùng nhau nhằm xác định các điểm cuối giao diện REST.