所有 Google Ad Manager API 呼叫都必須透過 OAuth2 授權。OAuth2 是一種開放標準,可讓使用者將權限授予第三方應用程式,以便應用程式代表使用者與網路服務互動。OAuth2 可讓 Ad Manager API 用戶端應用程式存取使用者的 Ad Manager 帳戶,不必處理或儲存使用者的使用者名稱或密碼。
產生 OAuth2 憑證
請按照下列步驟產生 OAuth2 憑證。
1. 判斷驗證類型
請參閱下表,瞭解哪種驗證類型最適合您的 Ad Manager API 應用程式:
| 選擇 OAuth2 驗證類型 | |
|---|---|
| 服務帳戶 |
如果您只需要存取自己的 Ad Manager 資料,請選擇這個選項。 瞭解詳情。 |
| 網頁應用程式 |
如果您想以任何授權應用程式存取 Ad Manager 資料的使用者身分進行驗證,請選擇這個選項。 瞭解詳情。 |
2. 建立 OAuth2 憑證
決定驗證類型後,請按一下下方的對應分頁標籤,然後按照操作說明產生 OAuth2 憑證:
- 開啟 Google API 控制台的「憑證」頁面。
- 從專案下拉式選單中選擇「建立新專案」,輸入專案名稱,並視需要編輯提供的專案 ID。按一下「建立」。
- 在「憑證」頁面中,選取「建立憑證」,然後選取「服務帳戶金鑰」。
- 選取「New service account」(新增服務帳戶),然後選取「JSON」。
- 按一下「建立」,下載內含私密金鑰的檔案。
- 開啟 Google API 控制台的「憑證」頁面。
- 從專案下拉式選單中,選擇「建立新專案」,輸入專案名稱 (也可以編輯提供的專案 ID),然後按一下「建立」。
- 在「憑證」頁面選取「建立憑證」,然後選取「OAuth 用戶端 ID」。
- 系統可能會提示您在「同意畫面」頁面設定產品名稱;如果出現提示,請按一下「設定同意畫面」,提供所需資訊,然後按一下「儲存」返回「憑證」頁面。
- 在「應用程式類型」中選取 [網路應用程式]。請按照操作說明輸入 JavaScript 來源和/或重新導向 URI。
- 點選「建立」。
- 在顯示的頁面中,將用戶端 ID 和用戶端密鑰複製到剪貼簿,設定用戶端程式庫時會用到這些資訊。

3. 設定 Ad Manager 聯播網
如果您是第三方開發人員,可能需要請客戶為您完成這個步驟。
- 前往 Ad Manager 聯播網。
- 按一下 [管理] 標籤。
- 確認已啟用「API 存取權」。
- 按一下「新增服務帳戶使用者」按鈕。
- 使用服務帳戶電子郵件地址填寫表單。服務帳戶使用者必須獲得存取實體的權限,就像該服務帳戶使用者在使用者介面上存取實體一樣。
- 按一下「儲存」按鈕。系統應會顯示訊息,確認已新增服務帳戶。
- 前往「使用者」分頁,然後按一下「服務帳戶」篩選器,即可查看現有的服務帳戶使用者。
- 前往 Ad Manager 聯播網。
- 按一下 [管理] 標籤。
- 確認已啟用「API 存取權」。
4. 設定及使用用戶端程式庫
請按照下列適當的指南,在用戶端程式庫中使用憑證:
Java
.NET
Python
PHP
Ruby
如果您選擇不使用任何用戶端程式庫,就必須自行實作 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 中查看及管理廣告活動。 |