開始使用 AdMob API

本指南適用於想使用 AdMob API 以程式輔助方式取得 AdMob 帳戶中的資料 ( ) 的開發人員。

所有 Google AdMob API 呼叫都必須透過 OAuth2 授權，才能讓應用程式代表使用者與網路服務互動。OAuth2 可讓 AdMob API 用戶端應用程式存取使用者的 AdMob 帳戶，而無須處理或儲存使用者的使用者名稱或密碼。如需授權總覽，請參閱「授權」。

請執行下列步驟，產生 OAuth2 憑證並提出第一個要求。

必要條件

決定驗證類型

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

選擇 OAuth2 驗證類型 適用條件
電腦版應用程式
  • 您使用單一頂層管理員帳戶管理所有 AdMob API 帳戶。
  • 您是初次使用者，或想快速開始使用最簡單的設定。
  • 您的應用程式只會從一台電腦驗證 Google AdMob 使用者。
網頁應用程式
  • 您想以可授予應用程式存取其 AdMob API 帳戶資料的使用者身分進行驗證。
  • 您想輕鬆產生多個授權憑證，例如管理第三方帳戶。
  • 您的應用程式需要回呼網址。回呼網址不支援電腦版應用程式流程。

建立專案

如要開始使用 AdMob API，請先在 Google API 控制台中建立或選取專案，然後使用設定工具啟用 API。這項工具會引導您完成該程序，並自動啟用 AdMob API。

為現有專案啟用 API

以下步驟適用於擁有現有專案，且偏好手動啟用 AdMob API 的使用者。

為您的項目啟用API：

  1. Open the API Library中的Google API Console 。
  2. If prompted, select a project, or create a new one. API Library列出了所有可用的API，並按產品系列和受歡迎程度分組。
  3. 如果您要啟用的API在列表中不可見，請使用搜索找到它，或單擊其所屬產品系列中的“ 查看全部 ”。
  4. 選擇要啟用的API，然後單擊“ 啟用”按鈕。
  5. If prompted, enable billing.
  6. If prompted, read and accept the API's Terms of Service.

建立 OAuth2 憑證

下列操作說明會逐步引導您建立 OAuth 2.0 用戶端 ID，以便與安裝版應用程式流程搭配使用。

  1. Go to the Credentials page.

  2. 依序點選「建立憑證」>「OAuth 用戶端 ID」。

    如果您之前尚未為這項專案設定 OAuth 同意畫面，系統會將您導向此頁面。按一下「設定同意畫面」。您可以透過多種方式設定同意畫面，以便使用 OAuth 2.0 用戶端 ID。

    1. 將使用者類型設為「外部」，並將發布狀態設為「已發布」。

    2. 或者，您也可以將使用者類型設為「外部」，並將發布狀態設為「測試」，然後選取「新增使用者」來新增測試使用者，讓他們可以使用您的 OAuth 2.0 用戶端 ID。

      詳情請參閱設定 OAuth 同意畫面。

  3. 選取「Desktop app」或「Web Application」做為應用程式類型，為應用程式命名，然後按一下「Create」。

完成後，您會看到 OAuth 2.0 用戶端 ID 與用戶端密鑰，您可以下載 JSON 格式並儲存供日後使用。

提出要求

AdMob API 是以 HTTP 和 JSON 做為建構基礎，因此任何標準 HTTP 用戶端都可以向這個 API 傳送要求並剖析回應。不過，Google API 用戶端程式庫可以提供更出色的語言整合功能、更高的安全性，並支援需要授權的要求。用戶端程式庫支援多種程式設計語言，只要善加利用，您就不必再手動設定 HTTP 要求及剖析回應。

建立 OAuth 2.0 憑證後，就可以開始使用 AdMob API。如要透過 OAuth 2.0 要求存取權，您的應用程式也需要範圍資訊：

範圍 意義
https://www.googleapis.com/auth/admob.readonly 查看所有 AdMob 資料。這些 AdMob 資料可能包含帳戶資訊、廣告空間和中介服務設定、報表以及其他資料。但不含付款或廣告活動詳細資料等機密資料。
https://www.googleapis.com/auth/admob.report 查看廣告成效和收益報表。查看發布商 ID、時區和預設貨幣代碼。

請使用 Java、PHP、Python 或 curl 中的範例，提出第一個產生報表的要求。

撤銷共用權杖

您可以透過下列兩種方式撤銷共用權杖：

  1. 前往 Google 帳戶權限頁面，然後撤銷相關專案的存取權。

  2. 或者，您也可以使用 Google Identity API 撤銷網頁應用程式權杖。