Trang này giả định rằng bạn đã quen thuộc với hướng dẫn 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 đó bằng thông tin chi tiết cụ thể về cách triển khai Google Ads API.
Thiết kế hướng đến tài nguyên
Nhìn chung, Google Ads API tuân theo thiết kế hướng đến tài nguyên, được mô hình hoá dưới dạng tập hợp các tài nguyên có thể định địa chỉ riêng lẻ (các danh từ của API). Các 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 thao tác). 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ể, tạo thành URL của giao diện REST. Ví dụ: URL ví dụ này có thể được chia thành các thành phần riêng lẻ theo bảng sau:
https://googleads.googleapis.com/v24/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/v24
|
customers/1234567890
|
mutate
|
Tất cả URL REST cho một phiên bản cụ thể của API (ví dụ: v24) đều 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 Google Ads 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 sử dụng các phương thức REST tiêu chuẩn như list, get,
create, update, và delete. Ví dụ về các phương thức tuỳ chỉnh trong API Google Ads bao gồm search, searchStream, và mutate.
Các trang sau đây trình bày chi tiết hơn về tên tài nguyên của API Google Ads, phương thức dịch vụ và quy ước đặt tên JSON để minh hoạ cách các thành phần này được sử dụng cùng nhau để xác định các điểm cuối của giao diện REST.
Quản lý lỗi
Hãy xem bài viết Tìm hiểu về lỗi API để biết hướng dẫn về cách phân tích và gỡ lỗi cho mọi lỗi phát sinh.
Tài liệu khám phá
Để tạo điều kiện và tự động hoá việc khám phá các phương thức có sẵn trong Google Ads API, bạn có thể sử dụng tài liệu khám phá được xuất bản cho từng phiên bản.
Tài liệu này có tại
https://googleads.googleapis.com/$discovery/rest?version=<API_VERSION>.
Ví dụ: đây là
tài liệu khám phá
cho phiên bản mới nhất của Google Ads API.
Tài liệu khám phá chứa thông tin về tất cả các dịch vụ, phương thức, tài nguyên và thực thể được sử dụng trong Google Ads API, chẳng hạn như tài liệu tham khảo, nhưng ở định dạng JSON có thể đọc được bằng máy.