Ủy quyền và tiêu đề HTTP

Bạn cần có thông tin đăng nhập ứng dụng OAuth 2.0 khi gọi Search Ads 360 Reporting API. Nếu đang thực hiện lệnh gọi API dưới dạng Tài khoản người quản lý Search Ads 360, bạn cũng cần chỉ định tiêu đề login-customer-id cho mỗi yêu cầu. Trang này mô tả cách đặt các giá trị này và ghi lại một số tiêu đề HTTP bổ sung dành riêng cho API được gửi và nhận khi sử dụng giao diện REST.

Thông tin đăng nhập OAuth 2.0

Search Ads 360 Reporting API sử dụng thông tin đăng nhập ứng dụng để xác định và uỷ quyền các yêu cầu API. Bạn có thể định cấu hình ứng dụng OAuth 2.0. Tất cả các lệnh gọi Search Ads 360 Reporting API đều phải được uỷ quyền thông qua OAuth2. OAuth2 cho phép ứng dụng khách Search Ads 360 Reporting API truy cập vào tài khoản Search Ads 360 của người dùng mà không cần xử lý hoặc lưu trữ thông tin đăng nhập của người dùng.

Nếu mới làm quen với các API của Google, bạn có thể sử dụng oauth2l hoặc OAuth 2.0 Playground để thử nghiệm thông tin đăng nhập của ứng dụng và API Báo cáo Search Ads 360 trước khi viết mã cho ứng dụng của mình. Bạn cũng có thể tạo mã làm mới OAuth bằng cách chạy tập lệnh tạo thông tin đăng nhập của người dùng được cung cấp.

Tạo mã truy cập mới

Sau khi có mã ứng dụng khách, khoá bí mật của ứng dụng khách và mã làm mới, bạn có thể tạo mã truy cập mới để sử dụng trong các lệnh gọi API bằng công cụ dòng lệnh curl:

curl \
  --data "grant_type=refresh_token" \
  --data "client_id=CLIENT_ID" \
  --data "client_secret=CLIENT_SECRET" \
  --data "refresh_token=REFRESH_TOKEN" \
  https://www.googleapis.com/oauth2/v3/token

Sau đó, bạn sẽ sử dụng mã truy cập do yêu cầu curl trả về trong tiêu đề HTTP Authorization của mọi lệnh gọi API đến Search Ads 360 Reporting API:

GET /v0/customers:listAccessibleCustomers HTTP/1.1
Host: searchads360.googleapis.com
Authorization: Bearer ACCESS_TOKEN

Tiêu đề của yêu cầu

Mã khách hàng đăng nhập

Đối với các lệnh gọi Search Ads 360 Reporting API do người quản lý thực hiện đến một tài khoản khách hàng (tức là khi đăng nhập với tư cách là người quản lý để thực hiện các lệnh gọi API đến một trong các tài khoản khách hàng của người quản lý đó), bạn cũng cần cung cấp tiêu đề HTTP login-customer-id. Giá trị này đại diện cho mã khách hàng Search Ads 360 của người quản lý thực hiện lệnh gọi API.

Việc thêm tiêu đề này tương đương với việc chọn một tài khoản trong giao diện người dùng Search Ads 360 sau khi đăng nhập hoặc nhấp vào ảnh hồ sơ của bạn ở góc trên cùng bên phải của trang. Khi chỉ định mã khách hàng, hãy nhớ xoá mọi dấu gạch ngang (—), ví dụ: 1234567890 chứ không phải 123-456-7890.

GET /v0/customers:listAccessibleCustomers HTTP/1.1
Host: searchads360.googleapis.com
Authorization: Bearer ACCESS_TOKEN
login-customer-id: MANAGER_CUSTOMER_ID

Tiêu đề phản hồi

Các tiêu đề sau đây được trả về trong phản hồi HTTP từ API.

Mã yêu cầu

request-id là một chuỗi xác định duy nhất yêu cầu API. Khi gỡ lỗi hoặc khắc phục sự cố với các lệnh gọi API cụ thể, request-id là một giá trị nhận dạng quan trọng mà bạn nên có sẵn khi liên hệ với bộ phận hỗ trợ nhà phát triển của Google.

request-id: 2a5Cj89VV7CNhya1DZjjrC