Authentication
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.
Tài liệu này mô tả cách xác thực với 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ề việc 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 loại này nếu bạn muốn xác thực dưới dạng tài khoản chuyên dụng thay vì một người cụ thể.
Tìm hiểu thêm. |
Ứng dụng web
|
Chọn phương thức này nếu bạn muốn xác thực dưới dạng bất kỳ người dùng nào cấp quyền cho ứng dụng của bạn truy cập vào 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
Bật Ad Manager API trong Dự án trên Google Cloud Console.
Nếu bạn nhận được lời nhắc, hãy chọn một dự án hoặc tạo dự án mới.
Tạo thông tin xác thực
Nhấp vào thẻ cho loại xác thực của bạn rồi làm theo hướng dẫn để tạo thông tin xác thực:
Tài khoản dịch vụ
Trên Google Cloud
Để xác thực một khối lượng công việc chạy trên Google Cloud, bạn cần 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ó 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à cách đính kèm tài khoản dịch vụ vào tài nguyên, hãy xem tài liệu về cách đính kèm tài khoản dịch vụ.
Tại cơ sở hạ tầng riêng hoặc trên 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 việc 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ụ:
Mở trang Thông tin đăng nhập Bảng điều khiển Google API.
Trên trang Thông tin xác thực, hãy chọn Tạo thông tin xác thực, sau đó chọn Tài khoản dịch vụ.
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á.
Nhấp vào thẻ Khoá.
Nhấp vào trình đơn thả xuống Thêm khoá, rồi chọn Tạo khoá mới.
Chọn JSON làm Loại khoá rồi nhấp vào Tạo.
Đặ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
Mở trang Thông tin xác thực trên Google API Console.
Nếu được nhắc, hãy chọn dự án mà bạn đã bật API Ad Manager.
Trên trang Thông tin đăng nhập, hãy chọn Tạo thông tin xác thực, sau đó
chọn Mã ứng dụng OAuth.
Chọn loại ứng dụng Ứng dụng web.
Đ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à máy chủ OAuth 2.0 có thể gửi phản hồi. Các điểm cuối này phải tuân thủ các quy tắc xác thực của Google.
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 một cách an toàn ở một 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 để lấy 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ài đặt Google Cloud CLI, sau đó 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à đặt mã dự án thành một dự án đã 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 dưới dạng Tài khoản dịch vụ bằng cách đặt biến môi trường GOOGLE_APPLICATION_CREDENTIALS
thành đườ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
Tài khoản dịch vụ
- Chuyển đến Mạng Ad Manager.
- Nhấp vào tab Quản trị.
- Đảm bảo rằng bạn đã bật quyền truy cập API.
- Nhấp vào nút Thêm người dùng tài khoản dịch vụ.
- Đ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.
- Nhấp vào nút Lưu. Một thông báo sẽ xuất hiện, xác nhận việc thêm tài khoản dịch vụ của bạn.
- Xem người dùng tài khoản dịch vụ hiện có 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
- Truy cập vào mạng Ad Manager của bạn.
- Nhấp vào tab Quản trị.
- Đảm bảo rằng bạn đã bật quyền truy cập API.
Phát triển địa phương
- Truy cập vào mạng Ad Manager của bạn.
- Nhấp vào tab Quản trị.
- Đả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 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 chỉ có một phạm vi. Bạn nên thực hiện việc uỷ quyền ở cấp 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. |
Trừ phi có lưu ý khác, nội dung của trang này được cấp phép theo Giấy phép ghi nhận tác giả 4.0 của Creative Commons và các mẫu mã lập trình được cấp phép theo Giấy phép Apache 2.0. Để biết thông tin chi tiết, vui lòng tham khảo Chính sách trang web của Google Developers. Java là nhãn hiệu đã đăng ký của Oracle và/hoặc các đơn vị liên kết với Oracle.
Cập nhật lần gần đây nhất: 2025-08-31 UTC.
[null,null,["Cập nhật lần gần đây nhất: 2025-08-31 UTC."],[[["\u003cp\u003eGoogle Ad Manager API authentication depends on the interface and environment but always requires an access token.\u003c/p\u003e\n"],["\u003cp\u003eChoose between service account, web application, or local development authentication based on your needs.\u003c/p\u003e\n"],["\u003cp\u003eEnable the Ad Manager API in your Google API Console and create the necessary credentials for your chosen authentication type.\u003c/p\u003e\n"],["\u003cp\u003eConfigure your Ad Manager network settings and add the service account user or enable API access depending on authentication type.\u003c/p\u003e\n"],["\u003cp\u003eInclude your access token in API requests using either a query parameter or an HTTP header.\u003c/p\u003e\n"]]],["To access the Ad Manager API, you need an access token, generated using Application Default Credentials (ADC) or custom credentials. First, enable the Ad Manager API in your Google Cloud project. Then, choose an authentication type: Service Account, Web application, or Local development. Create credentials via the Google API Console, selecting the appropriate method. If not using a client library, use an OAuth2 library. Finally, include the access token in API requests, preferably in the `Authorization` HTTP header. Each access token should be associated with the `https://www.googleapis.com/auth/admanager` scope.\n"],null,["# Authentication\n\nThis document describes how to authenticate to the Ad Manager API. How you\nauthenticate depends on the interface you use and the environment where your\ncode is running, but all API requests must include an access token with the\nAd Manager API [scope](#scope).\n\nThe Ad Manager client libraries use [Application Default Credentials](//cloud.google.com/docs/authentication/application-default-credentials)\nto generate access tokens with the Ad Manager API scope. This guide shows\nhow to configure Application Default Credentials.\n\nIf you aren't using a client library, you still need to create credentials\nand use them to authorize your requests.\n\nFor more information about authentication and authorization, see the\n[Using OAuth 2.0](/identity/protocols/oauth2) guide.\n\nDetermine your authentication type\n----------------------------------\n\n| Authentication type | Description |\n|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| Service Account | Choose this if you want to authenticate as dedicated account rather than a particular person. [Learn more](//cloud.google.com/iam/docs/service-account-overview). |\n| Web application | Choose this if you want to authenticate as any user who grants permission to your application to access their Ad Manager data. [Learn more](/identity/oauth2/web/guides/overview) |\n| Local development | Choose this if you want to authenticate as your own Google Account or a Service Account from your local development environment. |\n\nEnable the Ad Manager API\n-------------------------\n\n1. Enable the [Ad Manager API](https://console.cloud.google.com/apis/library/admanager.googleapis.com) in your\n Google API Console Cloud Project.\n\n2. If prompted, select a project, or create a new one.\n\nCreate credentials\n------------------\n\nClick the tab for your authentication type and follow the instructions to\ncreate your credentials: \n\n### Service Account\n\n### On Google Cloud\n\nTo authenticate a workload running on Google Cloud, you use the credentials of\nthe service account attached to the compute resource where your code is\nrunning.\n\nFor example, you can attach a service account to a Compute Engine virtual\nmachine (VM) instance, a Cloud Run service, or a Dataflow job. This approach\nis the preferred authentication method for code running on a Google Cloud\ncompute resource.\n\nFor information about which resources you can attach a service account to,\nand help with attaching the service account to the resource, see the\n[documentation on attaching a service account](//cloud.google.com/iam/docs/attach-service-accounts).\n\n### On-premises or on a different cloud provider\n\nThe preferred method to set up authentication from outside of Google Cloud is\nto use [workload identity federation](//cloud.google.com/iam/docs/workload-identity-federation); you create a\ncredential configuration file and set the `GOOGLE_APPLICATION_CREDENTIALS`\nenvironment variable to point to it. This approach is more secure than\ncreating a service account key.\n\nIf you are not able to configure workload identity federation, then you must\ncreate a service account and create a key for the service account:\n\n1. Open the [Google API Console Credentials page](https://console.cloud.google.com/apis/credentials).\n\n2. On the Credentials page, select **Create credentials** , then\n select **Service Account**.\n\n3. Click the email address of the service account that you want to create\n a key for.\n\n4. Click the **Keys** tab.\n\n5. Click the **Add key** drop-down menu, then select **Create new key**.\n\n6. Select **JSON** as the **Key type** and click **Create**.\n\n7. Set the environment variable `GOOGLE_APPLICATION_CREDENTIALS` to the path\n of the JSON file.\n\n#### Linux or macOS\n\n export GOOGLE_APPLICATION_CREDENTIALS=\u003cvar label=\"key file\" translate=\"no\"\u003eKEY_FILE_PATH\u003c/var\u003e\n\n#### Windows\n\n set GOOGLE_APPLICATION_CREDENTIALS=\u003cvar label=\"key file\" translate=\"no\"\u003eKEY_FILE_PATH\u003c/var\u003e\n\n### Web application\n\n1. Open the [Google API Console Credentials page](https://console.cloud.google.com/apis/credentials).\n\n2. If prompted, select the project where you enabled the Ad Manager API.\n\n3. On the Credentials page, select **Create credentials** , then\n select **OAuth client ID**.\n\n4. Select the **Web application** application type.\n\n5. Fill in the form and click **Create** . Applications that use languages and\n frameworks like PHP, Java, Python, Ruby, and .NET must specify authorized\n **redirect URIs** . The redirect URIs are the endpoints to which the OAuth 2.0\n server can send responses. These endpoints must adhere to [Google's\n validation rules](/identity/protocols/oauth2/web-server#uri-validation).\n\n6. After creating your credentials, download the **client_secret.json** file. Securely store the file in a location that only your application can access.\n\nFrom here, follow the steps to [obtain OAuth 2.0 access tokens](/identity/protocols/oauth2/web-server#obtainingaccesstokens)\n\n### Local development\n\nSet up Application Default Credentials (ADC) in your local environment.\n\nInstall the Google Cloud CLI, then initialize it by running the following\ncommand: \n\n gcloud init\n\nCreate local authentication credentials for your Google Account and set\nthe project ID to a project where the Ad Manager API is enabled: \n\n gcloud auth application-default login --scopes=\"https://www.googleapis.com/auth/admanager\"\n gcloud auth application-default set-quota-project \u003cvar label=\"project id\" translate=\"no\"\u003ePROJECT_ID\u003c/var\u003e\n\nAlternatively, authenticate as a Service Account setting the environment\nvariable `GOOGLE_APPLICATION_CREDENTIALS` to the path of your key file.\n\n#### Linux or macOS\n\n export GOOGLE_APPLICATION_CREDENTIALS=\u003cvar label=\"key file\" translate=\"no\"\u003eKEY_FILE_PATH\u003c/var\u003e\n\n#### Windows\n\n set GOOGLE_APPLICATION_CREDENTIALS=\u003cvar label=\"key file\" translate=\"no\"\u003eKEY_FILE_PATH\u003c/var\u003e\n\nConfigure your Ad Manager network\n---------------------------------\n\n**Tip:** If you are a third-party developer, ask your client to complete this step for you. Send them to [Add a service account user for API access](//support.google.com/admanager/answer/6078734) and provide the email address of your service account. \n\n### Service Account\n\n1. Go to your [Ad Manager network](//admanager.google.com).\n2. Click the **Admin** tab.\n3. Ensure that **API access** is enabled.\n4. Click the **Add a service account user** button.\n5. Fill in the form using the service account email. The service account user must be added to appropriate roles and teams for your API integration.\n6. Click the **Save** button. A message should appear, confirming the addition of your service account.\n7. View existing service account users by going to the Users tab and then clicking the **Service Account** filter.\n\n### Web application\n\n1. Go to your [Ad Manager network](//admanager.google.com).\n2. Click the **Admin** tab.\n3. Ensure that **API access** is enabled.\n\n### Local Development\n\n1. Go to your [Ad Manager network](//admanager.google.com).\n2. Click the **Admin** tab.\n3. Ensure that **API access** is enabled.\n\nWithout a client library\n------------------------\n\nIf you are not using a client library, we still strongly recommend using\nan OAuth2 library for authentication.\n\nFor detailed instructions on obtaining access tokens, see\n[Using OAuth2 with Google APIs](/identity/protocols/oauth2).\n\n### Access tokens\n\nInclude your access token in a request to the API by including either an\n`access_token` query parameter or an `Authorization` HTTP header `Bearer` value.\nWhen possible, the HTTP header is preferable, because query strings tend to be\nvisible in server logs.\n\nFor example: \n\n GET /v1/networks/1234\n Host: admanager.googleapis.com\n Authorization: Bearer ya29.a0Ad52N3_shYLX\n\n GET https://admanager.googleapis.com/v1/networks/1234?access_token=1/fFAGRNJru1FTz70BzhT3Zg\n\n### Scope\n\nEach access token is associated with one or more scopes. A scope controls the\nset of resources and operations that an access token permits. The Ad Manager\nAPI has only one scope. Authorization should be performed at the user\nlevel within the product.\n\n| Scope | Permissions |\n|---------------------------------------------|------------------------------------------------------|\n| `https://www.googleapis.com/auth/admanager` | View and manage your campaigns on Google Ad Manager. |"]]