Thiết kế giao diện REST

Trang này giả định rằng bạn đã quen thuộc với hướng dẫn Định hướng tài nguyên Thiết kếTài nguyên Tên hướng dẫn dành cho nhà phát triển và bổ sung cho họ thông tin triển khai cụ thể của API Google Ads.

Thiết kế dựa trên tài nguyên

Nhìn chung, API Google Ads tuân theo thiết kế hướng đến tài nguyên, được lập mô hình như tập hợp các tài nguyên có thể định địa chỉ riêng lẻ (danh từ của API). Các tài nguyên được tham chiếu theo tên tài nguyên và được thao tác bằng một mã nhỏ tập hợp phương thức (còn được gọi là động từ hoặc phép toán).

Tên tài nguyênphương thức này được kết hợp lại có một tiền tố phiên bản API cụ thể, sẽ bao gồm các URL của giao diện REST. Ví dụ: URL bên dưới có thể được chia nhỏ thành các thành phần riêng lẻ này theo bảng sau:

https://googleads.googleapis.com/v17/customers/1234567890:mutate
Tiền tố phiên bản API Tên tài nguyên (tương đối) Phương thức
https://googleads.googleapis.com/v17 customers/1234567890 mutate

Tất cả URL REST cho một phiên bản cụ thể của API (ví dụ: v17) có chung một tiền tố phiên bản API. Tên tài nguyên và phương thức kết hợp với nhau xác định dịch vụ API nào đang được gọi.

API Google Ads chủ yếu sử dụng các phương thức tuỳ chỉnh, thay vì hầu hết các phương thức API REST truyền thống sử dụng các phương thức REST tiêu chuẩn như list, get, create, updatedelete. Ví dụ về các phương thức tuỳ chỉnh trong API Google Ads bao gồm search, searchStreammutate.

Các trang sau đây trình bày chi tiết hơn về tài nguyên của API Google Ads tên, phương thức dịch vụQuy ước đặt tên JSON để minh hoạ cách sử dụng các giá trị này cùng nhau để xác định điểm cuối của giao diện REST.