Authentication

所有 Google Ad Manager API 呼叫都必須透過 OAuth2 授權，這是一種開放標準，可讓使用者授予權限給第三方應用程式，讓應用程式代表使用者與網路服務互動。OAuth2 可讓 Ad Manager API 用戶端應用程式存取使用者的 Ad Manager 一般管理員帳戶，而不必處理或儲存使用者的使用者名稱或密碼。

產生 OAuth2 憑證

請按照下列步驟產生 OAuth2 憑證。

1. 判斷驗證類型

請參閱下表，瞭解哪種驗證類型最適合您的 Ad Manager API 應用程式：

選擇 OAuth2 驗證類型
服務帳戶

如果只需要存取自己的 Ad Manager 資料，請選擇這個選項。

瞭解詳情。
網頁應用程式

如要以任何授予應用程式權限的使用者身分進行驗證，以便存取他們的 Ad Manager 資料，請選擇這個選項。

瞭解詳情。

2. 建立 OAuth2 憑證

決定驗證類型後，請按一下下方對應的分頁標籤，然後按照操作說明產生 OAuth2 憑證：

服務帳戶
  1. 開啟 Google API 控制台憑證頁面。
  2. 從專案下拉式選單中選擇「Create a new project」(建立新專案)，輸入專案名稱，並視需要編輯提供的專案 ID。按一下「Create」(建立)。
  3. 在「憑證」頁面上，依序選取「建立憑證」和「服務帳戶金鑰」。
  4. 選取「新增服務帳戶」，然後選取「JSON」。
  5. 按一下「建立」，下載含有私密金鑰的檔案。
網頁應用程式
  1. 開啟 Google API 控制台憑證頁面。
  2. 從專案下拉式選單中選擇「Create a new project」(建立新專案)，輸入專案名稱 (並視需要編輯提供的專案 ID)，然後按一下「Create」(建立)。
  3. 在「憑證」頁面上，依序選取「建立憑證」和「OAuth 用戶端 ID」。
  4. 系統可能會提示您在「Consent Screen」(同意畫面) 頁面上設定產品名稱。如果是這樣，請按一下「Configure consent screen」(設定同意畫面)，提供要求的資訊，然後按一下「Save」(儲存)，返回「Credentials」(憑證) 頁面。
  5. 在「應用程式類型」中選取 [網路應用程式]。按照操作說明輸入 JavaScript 來源、重新導向 URI，或兩者皆輸入。
  6. 點選「建立」。
  7. 在顯示的頁面中，將用戶端 ID 和用戶端密鑰複製到剪貼簿，設定用戶端程式庫時會用到。
用戶端 ID 及用戶端密鑰螢幕擷圖

3. 設定 Ad Manager 聯播網

如果您是第三方開發人員，可能需要請客戶代為完成這個步驟。

服務帳戶
  1. 前往 Ad Manager 聯播網。
  2. 按一下 [管理] 標籤。
  3. 確認已啟用「API 存取權」。
  4. 按一下「新增服務帳戶使用者」按鈕。
  5. 使用服務帳戶電子郵件填寫表單。服務帳戶使用者必須具備實體存取權限，才能在 UI 存取實體。
  6. 按一下「儲存」按鈕。畫面上應會顯示訊息，確認已新增服務帳戶。
  7. 如要查看現有的服務帳戶使用者，請前往「使用者」分頁，然後按一下「服務帳戶」篩選器。
網頁應用程式
  1. 前往 Ad Manager 聯播網。
  2. 按一下 [管理] 標籤。
  3. 確認已啟用「API 存取權」。

4. 設定及使用用戶端程式庫

請按照下列適用的指南，在用戶端程式庫中使用憑證：

如果選擇不使用我們的用戶端程式庫，則必須自行實作 OAuth2 服務帳戶或網頁應用程式流程。

幕後花絮

我們的用戶端程式庫會自動處理下列細節，因此如果您對幕後發生的情況感興趣，請繼續閱讀。本節適用於已熟悉 OAuth2 規格，且知道如何搭配 Google API 使用 OAuth2 的進階使用者。

HTTP 要求標頭

傳送至 Ad Manager API 的每項要求，其 HTTP 標頭都必須包含下列格式的存取權杖：

Authorization: Bearer ACCESS_TOKEN

例如：

POST … HTTP/1.1
Host: …
Authorization: Bearer 1/fFAGRNJru1FTz70BzhT3Zg
Content-Type: text/xml;charset=UTF-8
Content-Length: …

<?xml version="1.0"?>
<soap:Envelope xmlns:soap="http://www.w3.org/2001/12/soap-envelope">
…
</soap:Envelope>

範圍

單一存取權杖可授予多個 API 不同程度的存取權。名為 scope 的變數參數可控制存取權杖允許的一組資源和作業。在存取權杖要求期間，應用程式會在 scope 參數中傳送一或多個值。

Ad Manager 只有一個範圍，如下所示。授權應在產品的使用者層級執行。

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