Trước khi bắt đầu
- Hãy yêu cầu nhân viên đại diện khách hàng thiết lập các quyền thích hợp cho những tài khoản mà ứng dụng của bạn sẽ truy cập.
- Nếu bạn chưa hiểu rõ các khái niệm về Authorized Buyers, hãy truy cập vào Trung tâm trợ giúp Authorized Buyers và thử nghiệm với giao diện người dùng. Nếu ứng dụng của bạn dự kiến sẽ đặt giá thầu theo thời gian thực, hãy đọc tài liệu về Giao thức RTB.
- Truy cập vào Bảng điều khiển API để thiết lập một dự án mới. Đăng nhập vào Tài khoản Google dành cho nhà phát triển của bạn hoặc tạo một tài khoản. Sau đó, bạn sẽ được nhắc tạo một dự án và ký vào một số Điều khoản dịch vụ.
Tài khoản mẹ và tài khoản con
Nếu đang làm việc trong cấu trúc tài khoản chứa tài khoản mẹ và tài khoản con, bạn có thể làm việc hiệu quả hơn nếu hiểu cách các tài khoản này tương tác với nhau. Dưới đây là nội dung tóm tắt ngắn gọn:
Tài khoản con
Người dùng có thông tin đăng nhập cấp quyền truy cập vào tài khoản con chỉ có thể xem và sửa đổi các tài nguyên liên kết với tài khoản của họ. Tài khoản con không thể xem hoặc sửa đổi các tài nguyên thuộc về tài khoản con hoặc tài khoản mẹ khác.
Tài khoản mẹ
Người dùng có thông tin đăng nhập cấp quyền truy cập vào tài khoản mẹ có thể xem và sửa đổi các tài nguyên cho tài khoản mẹ, ngoài tất cả các tài khoản con được liên kết. Đối với các thao tác liệt kê tất cả một tài nguyên nhất định, người dùng này sẽ nhận được phản hồi, bao gồm dữ liệu của tài khoản và tất cả các tài khoản con của họ. Xin lưu ý rằng đối với các loại yêu cầu khác nhắm đến tài nguyên cho tài khoản con, tài khoản mẹ sẽ phải chỉ định tham số đường dẫn accountId cho tài khoản con thay vì accountId của riêng tài khoản con.
Mô hình dữ liệu API REST
Tài nguyên là một thực thể dữ liệu riêng lẻ có một giá trị nhận dạng duy nhất. Tài nguyên Tài khoản đại diện cho mục nhập tài khoản Authorized Buyers và là lớp dữ liệu gốc cho API Người mua Ad Exchange. Các phương thức của API hoạt động trên từng tài nguyên Tài khoản và trên tập hợp tài nguyên Tài khoản.
Tài nguyên tài khoản bao gồm: Mã tài khoản, thông tin dùng khi so khớp cookie, vị trí bên đặt giá thầu, URL nhận yêu cầu giá thầu và một yêu cầu chỉ định số truy vấn tối đa mỗi giây mà nền tảng trao đổi quảng cáo sẽ gửi đi.
Ngoài tài nguyên và bộ sưu tập Tài khoản, API Người mua Ad Exchange xác định các cấu trúc dữ liệu sau đây:
- Vị trí của bên đặt giá thầu
Vị trí của bên đặt giá thầu là cấu trúc được trả về cùng với Tài nguyên tài khoản để cung cấp URL mà nền tảng trao đổi quảng cáo sẽ gửi yêu cầu giá thầu đến và số lượt truy vấn tối đa mỗi giây mà nền tảng trao đổi quảng cáo sẽ gửi. Dưới đây là ví dụ về vị trí của bên đặt giá thầu, được thể hiện trong JSON:
"bidderLocation": [ { "url": "http://bid.url.com/bidder", "maximumQps": 1500 } ],- Mục
Các mục cung cấp danh sách tài khoản. Dưới đây là ví dụ về các mục được thể hiện trong JSON:
{ "kind": "adexchangebuyer#accountsList", "items": [ accounts Resource ] }
Thao tác được hỗ trợ
Bạn có thể gọi 3 phương thức khác nhau trên các bộ sưu tập và tài nguyên trong Ad Exchange Buyer API như mô tả trong bảng sau. Mọi thao tác đều cần có uỷ quyền.
| Hoạt động | Nội dung mô tả | Liên kết HTTP REST |
|---|---|---|
| list | Liệt kê tất cả tài khoản mà người dùng hiện đã xác thực có thể truy cập. | GET trên một URI tập hợp. |
| nhận | Lấy một tài nguyên Tài khoản cụ thể. | GET trên URI tài nguyên. |
| cập nhật | Cập nhật một tài nguyên cụ thể của Tài khoản. | PUT trên URI tài nguyên, nơi bạn truyền dữ liệu cho tài nguyên đã cập nhật. |
Kiểu gọi
REST là một kiểu cấu trúc phần mềm cung cấp phương pháp thuận tiện và nhất quán trong việc yêu cầu và sửa đổi dữ liệu.
Thuật ngữ REST là viết tắt của "Dịch vụ chuyển trạng thái đại diện". Trong ngữ cảnh của Google API, API này đề cập đến việc sử dụng các động từ HTTP để truy xuất và sửa đổi các cách trình bày dữ liệu do Google lưu trữ.
Trong hệ thống RESTful, các tài nguyên được lưu trữ trong kho dữ liệu; ứng dụng gửi yêu cầu để máy chủ thực hiện một hành động cụ thể (chẳng hạn như tạo, truy xuất, cập nhật hoặc xoá tài nguyên), sau đó máy chủ thực hiện hành động đó và gửi phản hồi, thường ở dạng đại diện cho tài nguyên đã chỉ định.
Trong các API RESTful của Google, ứng dụng chỉ định một thao tác bằng động từ HTTP như POST, GET, PUT hoặc DELETE. Phương thức này chỉ định tài nguyên bằng một URI duy nhất trên toàn cầu có dạng sau:
https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters
Vì tất cả các tài nguyên API đều có các URI duy nhất có thể truy cập HTTP, nên REST cho phép lưu dữ liệu vào bộ nhớ đệm và được tối ưu hoá để hoạt động với cơ sở hạ tầng phân phối của web.
Bạn có thể thấy định nghĩa về phương thức trong tài liệu về các tiêu chuẩn HTTP 1.1 hữu ích; các định nghĩa này bao gồm thông số kỹ thuật cho GET, POST, PUT và DELETE.
REST trong API Người mua Ad Exchange
Các thao tác được hỗ trợ ánh xạ trực tiếp đến các động từ HTTP trong REST, như mô tả trong phần Các thao tác API.
Định dạng cụ thể của URI API là:
https://www.googleapis.com/adexchangebuyer/v1.4/resourceID?parameters
trong đó resourceID là giá trị nhận dạng cho tài nguyên Tài khoản và parameters là bất kỳ tham số nào áp dụng cho truy vấn. Xem tham số truy vấn chuẩn và tài liệu tham khảo để biết thông tin chi tiết.
Định dạng của phần mở rộng đường dẫn resourceID cho phép bạn xác định tài nguyên mình đang sử dụng, chẳng hạn như:
https://www.googleapis.com/adexchangebuyer/v1.4/accounts
https://www.googleapis.com/adexchangebuyer/v1.4/accounts/id
Bạn có thể tóm tắt bộ URI đầy đủ dùng cho mỗi thao tác được hỗ trợ trong API trong tài liệu tham khảo.
Dưới đây là ví dụ về cách hoạt động của tính năng này trong API Người mua Ad Exchange.
Lấy danh sách tài khoản của người dùng đã xác thực:
GET https://www.googleapis.com/adexchangebuyer/v1.4/accounts
Định dạng dữ liệu
JSON
JSON (Ký hiệu đối tượng JavaScript) là một định dạng dữ liệu phổ biến, độc lập về ngôn ngữ, cung cấp bản trình bày văn bản đơn giản của các cấu trúc dữ liệu tuỳ ý. Để biết thêm thông tin, hãy xem json.org.