Đưa ra yêu cầu trực tiếp

Bạn nên sử dụng các thư viện và mẫu ứng dụng cho quá trình triển khai. Tuy nhiên, nếu quá trình tích hợp của bạn với API có nhu cầu đặc biệt, chẳng hạn như sử dụng một ngôn ngữ không được hỗ trợ, thì bạn có thể đưa ra yêu cầu trực tiếp như mô tả bên dưới.

Kiểu gọi

REST là một kiểu kiến trúc phần mềm mang đến cho bạn 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.

Cụm từ REST là viết tắt của "Chuyển đổi trạng thái trình bày". Đối với bối cảnh là các API của Google, cụm từ này đề cập đến việc sử dụng các động từ HTTP để truy xuất và sửa đổi các dạng trình bày của dữ liệu do Google lưu trữ.

Trong hệ thống RESTful, tài nguyên được lưu trữ trong kho lưu trữ dữ liệu; khi ứng dụng gửi yêu cầu để máy chủ thực hiện một thao tác 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 thao tác đó và gửi phản hồi, thường ở dạng trình bày đối với tài nguyên đã chỉ định.

Trong API RESTful của Google, ứng dụng sẽ chỉ định một thao tác bằng cách sử dụng động từ HTTP như POST, GET, PUT hoặc DELETE. Thao tác này sẽ chỉ định tài nguyên theo URI duy nhất toàn hệ thống có dạng như sau:

https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters

Vì tất 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 trữ 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 tán của trang web.

Bạn sẽ tìm được đị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; vì trong các định nghĩa này có nội dung đặc tả cho GET, POST, PUT và DELETE.

REST trong API Quản lý AdSense

Các thao tác được hỗ trợ có liên hệ trực tiếp đến các động từ HTTP trong REST.

Các định dạng cụ thể cho URI API Quản lý AdSense là:

https://adsense.googleapis.com/v2/resourceID?parameters

trong đó resourceID là giá trị nhận dạng cho một ứng dụng khách quảng cáo, đơn vị quảng cáo, kênh URL, kênh tuỳ chỉnh hoặc tập hợp báo cáo và parameters là mọi thông số cần áp dụng cho truy vấn.

Định dạng của các tiện ích đường dẫn resourceID cho phép bạn xác định tài nguyên mà bạn hiện đang thao tác, ví dụ:

https://adsense.googleapis.com/v2/accounts/account_id/adclients
https://adsense.googleapis.com/v2/accounts/account_id/adclients/adClientId
https://adsense.googleapis.com/v2/accounts/account_id/adclients/adClientId/adunits
https://adsense.googleapis.com/v2/accounts/account_id/adclients/adClientId/adunits/adUnitId
https://adsense.googleapis.com/v2/accounts/account_id/adclients/adClientId/urlchannels
...

Bạn có thể xem tóm tắt về toàn bộ URI được dùng cho từng thao tác được hỗ trợ trong API trong tài liệu Tài liệu tham khảo về API quản lý AdSense.

Sau đây là một vài ví dụ về cách hoạt động của tính năng này trong API Quản lý AdSense.

Liệt kê ứng dụng quảng cáo:

GET https://adsense.googleapis.com/v2/accounts/account_id/adclients/

Liệt kê các đơn vị quảng cáo trong mã khách hàng quảng cáo ca-pub-1234567890123456:

GET https://adsense.googleapis.com/v2/accounts/account_id/adclients/ca-pub-1234567890123456/adunits

Định dạng dữ liệu

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 nội dung 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.

Ủy quyền yêu cầu

Xin lưu ý rằng AdSense không hỗ trợ Tài khoản dịch vụ, thay vào đó, bạn phải sử dụng quy trình Ứng dụng đã cài đặt.

Mọi yêu cầu mà ứng dụng của bạn gửi đến AdSense Management API đều phải có mã uỷ quyền. Mã này cũng giúp Google xác định ứng dụng của bạn.

Giới thiệu về giao thức cấp phép

Ứng dụng của bạn phải sử dụng OAuth 2.0 để cấp phép các yêu cầu. Chúng tôi không hỗ trợ giao thức cấp phép nào khác. Nếu ứng dụng của bạn sử dụng chức năng Đăng nhập bằng Google, thì Google sẽ giúp bạn xử lý một số bước trong quá trình cấp phép.

Cấp phép cho các yêu cầu bằng OAuth 2.0

Tất cả các yêu cầu đối với AdSense Management API đều phải do người dùng đã xác thực thực hiện.

Quá trình này được hỗ trợ bằng mã ứng dụng khách OAuth.

Hoặc tạo một mã trong trang Thông tin đăng nhập.

Các chi tiết của quy trình cấp phép đối với OAuth 2.0 sẽ khác nhau đôi chút tuỳ thuộc vào loại ứng dụng bạn đang viết. Quy trình chung sau đây áp dụng cho tất cả các loại ứng dụng:

Khi cần quyền truy cập vào dữ liệu người dùng, ứng dụng sẽ yêu cầu Google cung cấp phạm vi truy cập cụ thể.
Google hiển thị màn hình yêu cầu sự đồng ý cho người dùng để hỏi xem họ có cho phép ứng dụng của bạn yêu cầu một số dữ liệu của họ hay không.
Nếu người dùng đồng ý, thì Google sẽ cấp cho ứng dụng của bạn một mã truy cập ngắn hạn.
Sau đó, ứng dụng yêu cầu dữ liệu người dùng và đính kèm mã truy cập trong yêu cầu.
Nếu xác định rằng yêu cầu của bạn và mã này là hợp lệ, Google sẽ trả về dữ liệu mà ứng dụng yêu cầu.

Một số quy trình cấp phép có các bước bổ sung khác, chẳng hạn như sử dụng mã làm mới để lấy mã truy cập mới. Để biết thông tin chi tiết về quy trình cho các loại ứng dụng khác nhau, hãy xem tài liệu về OAuth 2.0 của Google.

Dưới đây là thông tin về phạm vi truy cập OAuth 2.0 đối với API Quản lý AdSense:

Phạm vi	Ý nghĩa
`https://www.googleapis.com/auth/adsense`	Quyền đọc/ghi dữ liệu AdSense.
`https://www.googleapis.com/auth/adsense.readonly`	Quyền chỉ đọc đối với dữ liệu AdSense.

Để yêu cầu quyền truy cập bằng OAuth 2.0, ứng dụng của bạn cần thông tin về mức truy cập, cũng như thông tin mà Google cung cấp khi bạn đăng ký ứng dụng của mình (chẳng hạn như mã ứng dụng khách và mật khẩu ứng dụng khách).

Mẹo: Thư viện ứng dụng API Google có thể xử lý một số bước trong quy trình cấp phép cho bạn. Thư viện này được cung cấp bằng nhiều ngôn ngữ lập trình. Hãy xem trang về các thư viện và mẫu để biết thêm chi tiết.

Gửi yêu cầu

Bước cuối cùng là đưa ra yêu cầu API. Hãy xem tài liệu tham khảo để biết thông tin cụ thể.

Đưa ra yêu cầu trực tiếp Sử dụng bộ sưu tập để sắp xếp ngăn nắp các trang Lưu và phân loại nội dung dựa trên lựa chọn ưu tiên của bạn.