開始使用 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. 在 Google API 控制台中開啟 API 程式庫。
  2. 按照系統說明選取專案，或建立新專案。API 程式庫會列出所有可用的 API，並按照產品系列及熱門程度分組。
  3. 如果清單裡找不到您想啟用的 API，請使用搜尋功能，或點選所屬產品系列的「查看全部」。
  4. 選取要啟用的 API，然後按一下「啟用」按鈕。
  5. 如果系統顯示提示，請啟用帳單功能。
  6. 如果系統顯示提示，請詳閱並接受 API 的《服務條款》。

建立 OAuth2 憑證

請按照下列操作說明，建立 OAuth 2.0 用戶端 ID，以便搭配安裝版應用程式流程使用。

  1. 前往「用戶端」頁面。

  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 用戶端都可以向 AdMob API 傳送要求並剖析回應。不過，Google API 用戶端程式庫可提供更好的語言整合環境、更高的安全性，並支援發出授權要求。用戶端程式庫支援多種程式設計語言，只要善加利用，您就不必再手動設定 HTTP 要求及剖析回應。

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

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

使用 Java、PHP、Python 或 curl 的範例，發出第一項要求來產生報表。

撤銷共用權杖

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

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

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