Bạn cần có thông tin đăng nhập OAuth 2.0 khi gọi Google Ads API. Nếu đang thực hiện lệnh gọi API bằng tài khoản người quản lý Google Ads, 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 thiết lập các giá trị này và ghi lại một số tiêu đề HTTP dành riêng cho API khác được gửi và nhận khi sử dụng giao diện REST.
Thông tin đăng nhập OAuth 2.0
Google Ads API sử dụng OAuth 2.0 để cấp quyền cho các yêu cầu API. Cả quy trình xác thực người dùng OAuth 2.0 và quy trình tài khoản dịch vụ đều được hỗ trợ. Để biết thêm chi tiết, hãy xem OAuth 2.0 trong Google Ads API.
Nếu bạn mới sử dụng các API của Google, bạn có thể dùng gcloud CLI hoặc OAuth 2.0 Playground để thử nghiệm thông tin đăng nhập OAuth 2.0 và Google Ads API trước khi viết mã cho ứng dụng.
Bạn nên sử dụng một trong các thư viện OAuth 2.0 có tại https://oauth.net/code/ để triển khai quy trình cấp quyền OAuth 2.0. Tuy nhiên, chúng tôi đã liệt kê các hướng dẫn về curl trong trường hợp bạn cần tự triển khai.
Tài khoản dịch vụ
Làm theo các bước để định cấu hình một dự án trên Google Cloud cho Google Ads API. Ghi lại email tài khoản dịch vụ và khoá tài khoản dịch vụ. Tiếp theo, hãy làm theo hướng dẫn chung trong hướng dẫn Tài khoản dịch vụ để thiết lập tài khoản dịch vụ nhằm truy cập vào tài khoản Google Ads.
Xác thực người dùng
Làm theo các bước để định cấu hình một dự án trên Google Cloud Console cho
Google Ads API. Ghi lại mã ứng dụng khách và khoá bí mật của ứng dụng khách. Tiếp theo, hãy làm theo hướng dẫn về quy trình ứng dụng dành cho máy tính
hoặc hướng dẫn về quy trình ứng dụng web
để tạo mã làm mới và mã truy cập. scope cần sử dụng để truy cập vào Google Ads API là https://www.googleapis.com/auth/adwords.
Tạo mã truy cập mới
Tài khoản dịch vụ
Khi bạn có email tài khoản dịch vụ và khoá tài khoản dịch vụ,
hãy làm theo hướng dẫn Sử dụng OAuth 2.0 cho các ứng dụng
từ máy chủ đến máy chủ
để tạo tập hợp khai báo JWT. Sau đó, bạn có thể đổi tập hợp này để lấy
mã truy cập OAuth 2.0. Hãy nhớ chọn thẻ HTTP/REST khi làm theo hướng dẫn. scope OAuth 2.0 cần sử dụng để truy cập vào Google Ads API là https://www.googleapis.com/auth/adwords. Ngoài ra, bạn có thể bỏ qua tham số sub khi tạo tập hợp khai báo JWT, vì các bước thiết lập sẽ cấp cho tài khoản dịch vụ quyền truy cập trực tiếp vào tài khoản Google Ads, nhờ đó tránh được việc mạo danh người dùng Google Ads.
Sau đó, bạn sử dụng mã truy cập trong tiêu đề HTTP Authorization của mọi lệnh gọi API đến Google Ads API:
GET /v26/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
Xác thực người dùng
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
token OAuth 2.0, 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/tokenSau đó, bạn 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 Google Ads API:
GET /v26/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
Tiêu đề của yêu cầu
Các phần sau đây mô tả các tiêu đề HTTP bắt buộc hoặc được sử dụng khi đưa ra yêu cầu đến Google Ads API.
Mã khách hàng đăng nhập
Đối với các lệnh gọi Google Ads API do người quản lý thực hiện đến 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 lệnh gọi API đến một trong các tài khoản khách hàng của mình), 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 Google Ads 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 Google Ads sau khi đăng nhập hoặc nhấp vào hình ả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, không phải 123-456-7890. Hãy tham khảo hướng dẫn
về mô hình truy cập Google Ads để tìm hiểu thêm về mã khách hàng đăng nhập.
GET /v26/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
login-customer-id: MANAGER_CUSTOMER_ID
Mã khách hàng được liên kết
Tiêu đề Mã khách hàng được liên kết được các đối tác (chẳng hạn như nhà cung cấp dịch vụ phân tích ứng dụng bên thứ ba hoặc đối tác dữ liệu) sử dụng khi thực hiện hành động trên một tài khoản Google Ads được liên kết. Hãy xem hướng dẫn về Cấu trúc lệnh gọi API để biết thêm chi tiết.
Authorization: Bearer ACCESS_TOKEN
login-customer-id: PARTNER_CUSTOMER_ID
linked-customer-id: ADVERTISER_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 cần có khi liên hệ với nhóm hỗ trợ nhà phát triển của Google.
request-id: 2a5Cj89VV7CNhya1DZjjrC