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 quyền thích hợp cho 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õ về các khái niệm của 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ẽ thực hiện đặ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 tài khoản. Sau đó, bạn sẽ được nhắc tạo một dự án và đăng xuất về một số Điều khoản dịch vụ.
Tài khoản mẹ và tài khoản con
Nếu bạn đang làm việc trong cấu trúc tài khoản có nhà xuất bản mẹ và nhà xuất bản con tài khoản, bạn có thể làm việc hiệu quả hơn nếu hiểu được cách chúng tương tác. Sau đâ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 được 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 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 của cha mẹ
Người dùng có thông tin xác thực cấp quyền truy cập vào tài khoản của cha 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 nguyên
tài khoản con. Đối với các thao tác liệt kê tất cả tài nguyên đã cho, người dùng này
sẽ nhận được phản hồi, bao gồm cả dữ liệu về tài khoản và tất cả
tài khoản con. 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 ghế trẻ em, hãy tham khảo
tài khoản mẹ cần chỉ định một tham số đường dẫn accountId
cho nhà xuất bản con
thay vì accountId
của chính họ.
Mô hình dữ liệu của API REST
Tài nguyên là một thực thể dữ liệu riêng lẻ có giá trị nhận dạng duy nhất. Chiến lược phát hành đĩa đơn Tài nguyên tài khoản đại diện cho một mục nhập của tài khoản Authorized Buyers và là tài nguyên gốc lớp dữ liệu cho Ad Exchange Buyer API. 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à tập hợp tài nguyên Tài khoản.
Thẻ Tài khoản Tài nguyên bao gồm: Mã tài khoản, thông tin dùng để so khớp cookie, vị trí của bên đặt giá thầu, URL mà yêu cầu giá thầu được gửi đến và yêu cầu để chỉ định số truy vấn tối đa mỗi giây được Ad Exchange gửi.
Ngoài tài nguyên và tập hợp Tài khoản, Ad Exchange Buyer API xác định các cấu trúc dữ liệu sau:
- 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ề bằng Tài nguyên tài khoản để cung cấp URL mà Ad Exchange sẽ gửi yêu cầu giá thầu đến và số truy vấn tối đa mỗi giây mà Ad Exchange cần gửi. Dưới đây là một ví dụ về vị trí của bên đặt giá thầu, được thể hiện dưới dạng 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 biểu thị bằng 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 đối với các tập hợp và tài nguyên trong Ad Exchange Buyer API như mô tả trong bảng sau. Tất cả các thao tác đều yêu cầu uỷ quyền.
Hoạt động | 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 đã được xác thực có thể truy cập người dùng. | GET trên URI của bộ sưu tập. |
nhận | Nhận 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 Tài khoản cụ thể. | 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 kiến trúc phần mềm mang lại cách tiếp cận thuận tiện và nhất quán để yêu cầu và sửa đổi dữ liệu.
Thuật ngữ REST là viết tắt của "Đại diện chuyển trạng thái". Trong ngữ cảnh của API Google, nó đề cập đến việc sử dụng các động từ HTTP để truy xuất và sửa đổi bản 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 một kho dữ liệu; ứng dụng gửi yêu cầu mà 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 biểu diễn tài nguyên được chỉ định.
Trong API RESTful của Google, ứng dụng chỉ định một hành động bằng cách sử dụ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 hệ thống có dạng sau:
https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters
Vì mọi tài nguyên API đều có URI riêng biệ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; chúng bao gồm thông số kỹ thuật cho GET
, POST
, PUT
và DELETE
.
REST trong Ad Exchange Buyer API
Các thao tác được hỗ trợ sẽ liên kết trực tiếp đến các động từ HTTP REST, như mô tả trong Hoạt động API.
Định dạng cụ thể cho 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ỳ
để á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 các phần mở rộng về đường dẫn resourceID
cho phép bạn xác định tài nguyên bạn hiện đang hoạt động, ví dụ:
https://www.googleapis.com/adexchangebuyer/v1.4/accounts
https://www.googleapis.com/adexchangebuyer/v1.4/accounts/id
Tập hợp đầy đủ URI được dùng cho mỗi tác vụ được hỗ trợ trong API là được tóm tắt trong tài liệu tham khảo.
Dưới đây là ví dụ về cách thức hoạt động của tính năng này trong Ad Exchange Buyer API.
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, không phụ thuộc vào 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 tùy ý. Để biết thêm thông tin, hãy xem json.org.