Authentication

本文件說明如何驗證 Ad Manager API。驗證方式取決於您使用的介面和程式碼執行環境，但所有 API 要求都必須包含具有 Ad Manager API 範圍的存取權杖。

Ad Manager 用戶端程式庫會使用應用程式預設憑證，產生具有 Ad Manager API 範圍的存取權存證。本指南說明如何設定應用程式預設憑證。

如果您未使用用戶端程式庫，仍需建立憑證，並使用這些憑證授權要求。

如要進一步瞭解驗證和授權，請參閱「使用 OAuth 2.0」指南。

決定驗證類型

驗證類型 說明
服務帳戶 如果您想以專屬帳戶身分驗證，而非特定使用者，請選擇這個選項。
瞭解詳情。
Web 應用程式 如要以任何使用者的身分進行驗證，請選擇這個選項 授予應用程式存取權 他們的 Ad Manager 資料
瞭解詳情
本機開發 如要以自己的名義進行驗證，請選擇這個選項 本機上的 Google 帳戶或服務帳戶 開發環境的專區

啟用 Ad Manager API

  1. 在 Ad Manager API 中啟用 Google API 控制台 Cloud 專案。

  2. 按照系統說明選取專案，或建立新專案。

建立憑證

按一下所需驗證類型的分頁標籤，然後按照操作說明建立憑證：

服務帳戶

在 Google Cloud 上

如要驗證在 Google Cloud 上執行的工作負載，請使用服務帳戶的憑證，該帳戶已連結至程式碼執行所在的運算資源。

舉例來說，您可以將服務帳戶連結至 Compute Engine 虛擬機器 (VM) 執行個體、Cloud Run 服務或 Dataflow 工作。在 Google Cloud 運算資源上執行程式碼時，建議採用這種驗證方法。

如要瞭解可將服務帳戶連結至哪些資源，以及如何將服務帳戶連結至資源，請參閱服務帳戶連結說明文件。

地端部署或其他雲端供應商

如要透過 Google Cloud 以外的方式設定驗證機制，建議您 使用工作負載身分聯盟。可建立 憑證設定檔，然後設定 GOOGLE_APPLICATION_CREDENTIALS 目標環境變數這個方法比建立服務帳戶金鑰更安全。

如果無法設定工作負載身分識別聯盟，則必須建立服務帳戶，並為服務帳戶建立金鑰：

  1. 開啟 Google API 控制台憑證頁面。

  2. 在「憑證」頁面上選取「建立憑證」，然後 選取「Service Account」。

  3. 點選要建立金鑰的服務帳戶電子郵件地址。

  4. 按一下「Keys」(金鑰) 分頁標籤。

  5. 按一下「Add key」(新增金鑰) 下拉式選單，然後選取「Create new key」(建立新的金鑰)。

  6. 選取「JSON」做為金鑰類型，然後按一下「Create」(建立)。

  7. 將環境變數 GOOGLE_APPLICATION_CREDENTIALS 設為路徑 檔案。

Linux 或 macOS

export GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH

Windows

set GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH

網頁應用程式

  1. 開啟 Google API 控制台「憑證」頁面。

  2. 畫面出現提示時，請選取您已啟用 Ad Manager API 的專案。

  3. 在「憑證」頁面上，依序選取「建立憑證」和「OAuth 用戶端 ID」。

  4. 選取「Web application」應用程式類型。

  5. 填寫表單，然後按一下「建立」。使用語言和 API 的應用程式 例如 PHP、Java、Python、Ruby 和 .NET 等架構 重新導向 URI。重新導向 URI 是 OAuth 2.0 的端點 伺服器可以傳送回應這些端點必須遵守 Google 的驗證規則。

  6. 建立憑證後，請下載 client_secret.json 檔案。將檔案安全地儲存在只有您的應用程式可存取的位置。

然後按照這裡的步驟取得 OAuth 2.0 存取權杖

本機開發

在本機環境中設定應用程式預設憑證 (ADC)。

安裝 Google Cloud CLI，然後執行下列指令來初始化：

gcloud init

為 Google 帳戶建立本機驗證憑證並進行相關設定 專案 ID 對應至已啟用 Ad Manager API 的專案 ID：

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

或者，您也可以將環境變數 GOOGLE_APPLICATION_CREDENTIALS 設為金鑰檔案的路徑，以服務帳戶身分進行驗證。

Linux 或 macOS

export GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH

Windows

set GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH

設定 Ad Manager 聯播網

服務帳戶

  1. 前往您的 Ad Manager 聯播網。
  2. 按一下 [管理] 標籤。
  3. 確認已啟用 API 存取權。
  4. 按一下「新增服務帳戶使用者」按鈕。
  5. 使用服務帳戶電子郵件地址填寫表單。服務帳戶使用者必須加入適當的角色和團隊，才能整合 API。
  6. 按一下「儲存」按鈕。系統應會顯示訊息，確認您已新增服務帳戶。
  7. 如要查看現有服務帳戶使用者，請前往「使用者」分頁，然後 按一下 [Service Account] (服務帳戶) 篩選器。

網頁應用程式

  1. 前往您的 Ad Manager 聯播網。
  2. 按一下 [管理] 標籤。
  3. 確認已啟用 API 存取權。

本機開發

  1. 前往您的 Ad Manager 聯播網。
  2. 按一下 [管理] 標籤。
  3. 確認已啟用 API 存取權。

不使用用戶端程式庫

如果您並未使用用戶端程式庫，我們強烈建議使用 使用 OAuth2 程式庫進行驗證。

如需取得存取權杖的詳細操作說明，請參閱「在 Google API 中使用 OAuth 2.0」。

存取權杖

在 API 要求中加入存取權杖，方法是加入 access_token 查詢參數或 Authorization HTTP 標頭 Bearer 值。盡可能使用 HTTP 標頭，因為查詢字串通常會顯示在伺服器記錄中。

例如：

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

範圍

每個存取權存證都與一或多個範圍相關聯。範圍控制了 一組存取權杖允許的資源和作業。Ad Manager API 只有一個範圍。授權應在產品的使用者層級執行。

範圍 權限
https://www.googleapis.com/auth/admanager 在 Google Ad Manager 中查看及管理廣告活動。