Authentication

Tài liệu này mô tả cách xác thực API Ad Manager. Cách bạn xác thực phụ thuộc vào giao diện bạn sử dụng và môi trường nơi đang chạy, nhưng tất cả yêu cầu API phải bao gồm mã thông báo truy cập cùng với Phạm vi API Ad Manager.

Thư viện ứng dụng Ad Manager sử dụng Thông tin xác thực mặc định của ứng dụng để tạo mã truy cập có phạm vi API Ad Manager. Hướng dẫn này cho biết cách định cấu hình Thông tin xác thực mặc định của ứng dụng.

Nếu không sử dụng thư viện ứng dụng, bạn vẫn cần tạo thông tin đăng nhập và sử dụng chúng để uỷ quyền cho các yêu cầu của bạn.

Để biết thêm thông tin về xác thực và uỷ quyền, hãy xem Hướng dẫn Sử dụng OAuth 2.0.

Xác định hình thức xác thực

Loại xác thực Mô tả
Tài khoản dịch vụ Chọn tuỳ chọn này nếu bạn muốn xác thực là dành riêng chứ không phải một người cụ thể.
Tìm hiểu thêm.
Ứng dụng web Chọn tuỳ chọn này nếu bạn muốn xác thực với tư cách là người dùng bất kỳ người cấp quyền truy cập cho ứng dụng của bạn dữ liệu Ad Manager của họ.
Tìm hiểu thêm
Phát triển cục bộ Chọn phương thức này nếu bạn muốn xác thực là của mình Tài khoản Google hoặc Tài khoản dịch vụ trên thiết bị của bạn môi trường phát triển.

Bật API Ad Manager

  1. Bật API Ad Manager trong Dự án trên đám mây trên bảng điều khiển Google API.

  2. Nếu được nhắc, hãy chọn một dự án hoặc tạo một dự án mới.

Tạo thông tin đăng nhập

Nhấp vào thẻ tương ứng với loại hình xác thực của bạn và làm theo hướng dẫn để tạo thông tin đăng nhập của bạn:

Tài khoản dịch vụ

Trên Google Cloud

Để xác thực một tải công việc chạy trên Google Cloud, bạn phải sử dụng thông tin đăng nhập của tài khoản dịch vụ được liên kết với tài nguyên điện toán có chứa mã của bạn đang chạy.

Ví dụ: Bạn có thể đính kèm tài khoản dịch vụ vào một Compute Engine ảo máy chủ ảo (VM), dịch vụ Cloud Run hoặc công việc Dataflow. Phương pháp này là phương thức xác thực ưu tiên cho mã chạy trên Google Cloud tài nguyên điện toán.

Để biết thông tin về những tài nguyên mà bạn có thể đính kèm tài khoản dịch vụ, và trợ giúp về việc đính kèm tài khoản dịch vụ với tài nguyên, hãy xem tài liệu về việc đính kèm tài khoản dịch vụ.

Tại cơ sở hạ tầng riêng hoặc tại một nhà cung cấp dịch vụ đám mây khác

Phương pháp ưu tiên để thiết lập tính năng xác thực từ bên ngoài Google Cloud là để sử dụng liên kết thông tin nhận dạng Workload; bạn tạo một tệp cấu hình thông tin xác thực và đặt GOOGLE_APPLICATION_CREDENTIALS biến môi trường để trỏ đến đó. Phương pháp này an toàn hơn so với tạo khoá tài khoản dịch vụ.

Nếu không thể định cấu hình liên kết thông tin nhận dạng của khối lượng công việc, bạn phải tạo tài khoản dịch vụ và tạo khoá cho tài khoản dịch vụ:

  1. Mở trang Thông tin đăng nhập Bảng điều khiển Google API.

  2. Trên trang Chứng chỉ, hãy chọn Tạo thông tin xác thực, sau đó chọn Tài khoản dịch vụ.

  3. Nhấp vào địa chỉ email của tài khoản dịch vụ mà bạn muốn tạo một chìa khoá.

  4. Nhấp vào thẻ Khoá.

  5. Nhấp vào trình đơn thả xuống Add key (Thêm khoá), sau đó chọn Create new key (Tạo khoá mới).

  6. Chọn JSON làm Loại khoá rồi nhấp vào Tạo.

  7. Đặt biến môi trường GOOGLE_APPLICATION_CREDENTIALS thành đường dẫn của tệp JSON.

Linux hoặc macOS

export GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH

Windows

set GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH

Ứng dụng web

  1. Mở trang Thông tin đăng nhập Bảng điều khiển Google API.

  2. Nếu được nhắc, hãy chọn dự án mà bạn đã bật API Ad Manager.

  3. Trên trang Chứng chỉ, hãy chọn Tạo thông tin xác thực, sau đó chọn Mã ứng dụng OAuth.

  4. Chọn loại ứng dụng Web application (Ứng dụng web).

  5. Điền vào biểu mẫu rồi nhấp vào Tạo. Ứng dụng sử dụng ngôn ngữ và các khung như PHP, Java, Python, Ruby và .NET phải chỉ định URI chuyển hướng. URI chuyển hướng là các điểm cuối mà OAuth 2.0 sử dụng máy chủ có thể gửi phản hồi. Các điểm cuối này phải tuân thủ quy tắc xác thực.

  6. Sau khi tạo thông tin đăng nhập, hãy tải tệp client_secret.json xuống. Lưu trữ tệp an toàn ở vị trí mà chỉ ứng dụng của bạn mới có thể truy cập.

Từ đây, hãy làm theo các bước để nhận mã truy cập OAuth 2.0

Phát triển cục bộ

Thiết lập Thông tin xác thực mặc định của ứng dụng (ADC) trong môi trường cục bộ của bạn.

Cài đặt Google Cloud CLI, rồi khởi chạy bằng cách chạy lệnh sau :

gcloud init

Tạo thông tin xác thực cục bộ cho Tài khoản Google của bạn và thiết lập mã dự án cho một dự án có bật API Ad Manager:

gcloud auth application-default login --scopes="https://www.googleapis.com/auth/admanager"
gcloud auth application-default set-quota-project PROJECT_ID

Ngoài ra, hãy xác thực là Tài khoản dịch vụ để thiết lập môi trường biến GOOGLE_APPLICATION_CREDENTIALS vào đường dẫn của tệp khoá.

Linux hoặc macOS

export GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH

Windows

set GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH

Định cấu hình mạng Ad Manager

Tài khoản dịch vụ

  1. Truy cập vào mạng Ad Manager của bạn.
  2. Nhấp vào tab Quản trị.
  3. Đảm bảo rằng bạn đã bật quyền truy cập API.
  4. Nhấp vào nút Thêm người dùng tài khoản dịch vụ.
  5. Điền vào biểu mẫu bằng email tài khoản dịch vụ. Chiến lược phát hành đĩa đơn người dùng tài khoản dịch vụ phải được thêm vào các vai trò và nhóm thích hợp để tích hợp API.
  6. Nhấp vào nút Lưu. Một thông báo sẽ xuất hiện, xác nhận thêm tài khoản dịch vụ.
  7. Xem người dùng hiện tại của tài khoản dịch vụ bằng cách chuyển đến thẻ Người dùng, sau đó nhấp vào bộ lọc Tài khoản dịch vụ.

Ứng dụng web

  1. Truy cập vào mạng Ad Manager của bạn.
  2. Nhấp vào tab Quản trị.
  3. Đảm bảo rằng bạn đã bật quyền truy cập API.

Phát triển địa phương

  1. Truy cập vào mạng Ad Manager của bạn.
  2. Nhấp vào tab Quản trị.
  3. Đảm bảo rằng bạn đã bật quyền truy cập API.

Không có thư viện ứng dụng

Nếu không dùng thư viện ứng dụng, bạn vẫn nên sử dụng thư viện OAuth2 để xác thực.

Để biết hướng dẫn chi tiết về cách nhận mã truy cập, hãy xem Sử dụng OAuth2 với API của Google.

Mã truy cập

Đưa mã truy cập của bạn vào yêu cầu tới API bằng cách bao gồm Tham số truy vấn access_token hoặc giá trị Bearer của tiêu đề HTTP Authorization. Nếu có thể, tiêu đề HTTP sẽ được ưu tiên hơn, vì chuỗi truy vấn có xu hướng hiển thị trong nhật ký máy chủ.

Ví dụ:

GET /v1/networks/1234
Host: admanager.googleapis.com
Authorization: Bearer ya29.a0Ad52N3_shYLX
GET https://admanager.googleapis.com/v1/networks/1234?access_token=1/fFAGRNJru1FTz70BzhT3Zg

Phạm vi

Mỗi mã truy cập được liên kết với một hoặc nhiều phạm vi. Phạm vi kiểm soát một tập hợp tài nguyên và thao tác mà mã truy cập cho phép. Trình quản lý Quảng cáo API REST chỉ có một phạm vi. Việc uỷ quyền nên được thực hiện với người dùng trong sản phẩm.

Phạm vi Quyền
https://www.googleapis.com/auth/admanager Xem và quản lý chiến dịch về Google Ad Manager.