本文件說明如何驗證 Ad Manager API。如何 「驗證」 取決於您使用的介面 ,但所有 API 要求都必須包含具有 Ad Manager API 範圍。
Ad Manager 用戶端程式庫使用應用程式預設憑證 以透過 Ad Manager API 範圍產生存取權杖本指南列出 如何設定應用程式預設憑證。
如果您不是使用用戶端程式庫,仍需建立憑證 並使用這些憑證來授權您的要求
如要進一步瞭解驗證和授權,請參閱 OAuth 2.0 使用指南。
決定驗證類型
驗證類型 | 說明 |
---|---|
服務帳戶 | 如要以專屬帳戶進行驗證,請選擇這個選項
而非特定使用者 瞭解詳情。 |
Web 應用程式 | 如要以任何使用者的身分進行驗證,請選擇這個選項
授予應用程式存取權
他們的 Ad Manager 資料 瞭解詳情 |
本機開發 | 如要以自己的名義進行驗證,請選擇這個選項 本機上的 Google 帳戶或服務帳戶 開發環境的專區 |
啟用 Ad Manager API
在 Ad Manager API 中啟用 Google API 控制台 Cloud 專案。
按照系統說明選取專案,或建立新專案。
建立憑證
按一下驗證類型的分頁,然後按照操作說明 建立憑證:
服務帳戶
在 Google Cloud 上
如要驗證在 Google Cloud 上執行的工作負載,請使用 連結至程式碼所在運算資源的服務帳戶 備用資源
舉例來說,您可以將服務帳戶附加至 Compute Engine 虛擬伺服器 例如 Cloud Run 或 Dataflow 工作這個方法 是 Google Cloud 中運作程式碼的首選驗證方式 資源用量
如要瞭解服務帳戶可以附加哪些資源, 如要瞭解如何將服務帳戶附加至資源,請參閱 附加服務帳戶的說明文件。
地端部署或其他雲端服務供應商
如要透過 Google Cloud 以外的方式設定驗證機制,建議您
使用工作負載身分聯盟。可建立
憑證設定檔,然後設定 GOOGLE_APPLICATION_CREDENTIALS
目標環境變數這個方法的安全性比
建立服務帳戶金鑰
如果您無法設定 Workload Identity 聯盟,則必須 建立服務帳戶並為服務帳戶建立金鑰:
在「憑證」頁面上選取「建立憑證」,然後 選取「Service Account」。
按一下您要建立的服務帳戶的電子郵件地址 的鍵/值
按一下「Keys」(金鑰) 分頁標籤。
按一下「新增金鑰」下拉式選單,然後選取「建立新的金鑰」。
選取「JSON」做為金鑰類型,然後按一下「Create」(建立)。
將環境變數
GOOGLE_APPLICATION_CREDENTIALS
設為路徑 檔案。
Linux 或 macOS
export GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH
Windows
set GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH
網頁應用程式
畫面出現提示時,請選取您已啟用 Ad Manager API 的專案。
在「憑證」頁面上選取「建立憑證」,然後 選取「OAuth 用戶端 ID」。
選取「網頁應用程式」應用程式類型。
填寫表單,然後按一下「建立」。使用語言和 API 的應用程式 例如 PHP、Java、Python、Ruby 和 .NET 等架構 重新導向 URI。重新導向 URI 是 OAuth 2.0 的端點 伺服器可以傳送回應這些端點必須遵循 Google 的 驗證規則。
建立憑證後,請下載 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 聯播網
服務帳戶
- 前往您的 Ad Manager 聯播網。
- 按一下 [管理] 標籤。
- 確認已啟用 API 存取權。
- 按一下「新增服務帳戶使用者」按鈕。
- 使用服務帳戶電子郵件地址填寫表單。 服務帳戶使用者必須加入適當的角色和團隊 以及 API 整合
- 按一下「Save」按鈕。系統會顯示訊息 以及新增服務帳戶
- 如要查看現有服務帳戶使用者,請前往「使用者」分頁,然後 按一下 [Service Account] (服務帳戶) 篩選器。
網頁應用程式
- 前往您的 Ad Manager 聯播網。
- 按一下 [管理] 標籤。
- 確認已啟用 API 存取權。
本機開發
- 前往您的 Ad Manager 聯播網。
- 按一下 [管理] 標籤。
- 確認已啟用 API 存取權。
沒有用戶端程式庫
如果您並未使用用戶端程式庫,我們強烈建議使用 使用 OAuth2 程式庫進行驗證。
如需取得存取權杖的詳細操作說明,請參閱 將 OAuth2 與 Google API 搭配使用。
存取權杖
在對 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 REST API 只有一個範圍。應於使用者執行授權 應該在產品內或產品層級
範圍 | 權限 |
---|---|
https://www.googleapis.com/auth/admanager
|
查看及管理廣告活動 關於 Google Ad Manager 的影片 |