AdMob API のスタートガイド

このガイドは、AdMob API を使用して AdMob アカウントのデータをプログラムで取得 することを目的としたデベロッパーの方を対象としています。

アプリがユーザーに代わってウェブサービスとやり取りできるように、すべての Google AdMob API 呼び出しは OAuth2 による認証を受ける必要があります。OAuth2 を使用すると、ユーザー名やパスワードの処理や保存を行うことなく、AdMob API クライアント アプリからユーザーの AdMob アカウントにアクセスできます。認可の概要については、認可をご覧ください。

次の手順で OAuth2 認証情報を生成し、最初のリクエストを行います。

前提条件

認証タイプを決定する

以下の表を参照して、アプリに最も適した認証タイプを確認してください。

OAuth2 認証タイプを選択する 適しているケース
パソコン用アプリ
  • すべての AdMob API アカウントを 1 つの最上位の MCC アカウントで管理している。
  • API をはじめて利用する場合や、簡単な設定ですぐに利用を開始したい場合
  • お客様のアプリは 1 台のマシンでのみ Google AdMob ユーザーの認証を行います。
ウェブアプリ
  • アプリケーションに AdMob API アカウントのデータへのアクセスを許可するユーザーとして認証を行う場合
  • 複数の認証情報を簡単に生成して、サードパーティなどのアカウントを管理したい場合
  • アプリでコールバック URL が必要な場合（コールバック URL はパソコンアプリのフローでは利用できません）

プロジェクトを作成する

AdMob API の使用を開始するには、まず Google API Console でプロジェクトを作成または選択し、設定ツールを使用して API を有効にする必要があります。設定ツールの手順に沿って操作すると、AdMob API が自動的に有効になります。

既存のプロジェクトで API を有効にする

すでにあるプロジェクトに対して、AdMob API を手動で有効にするには、次の手順を実施します。

OAuth2 認証情報を作成する

以下の手順に沿って、インストール済みアプリのフローで使用する OAuth 2.0 クライアント ID を作成します。

  2. [認証情報を作成] > [OAuth クライアント ID] をクリックします。

    このプロジェクトの OAuth 同意画面をまだ設定していない場合は、この段階で作成するよう求められます。[同意画面を構成] をクリックします。OAuth 2.0 クライアント ID を使用するように同意画面を構成する方法は複数あります。

    1. ユーザータイプを [外部] に、公開ステータスを [公開済み] に設定します。

    2. または、ユーザータイプを [外部]、公開ステータスを [テスト] に設定し、[ユーザーを追加] を選択して [テストユーザー] を追加し、OAuth 2.0 クライアント ID を使用するアクセス権を付与します。

      OAuth 同意画面の設定に関する追加情報をご確認ください。

  3. アプリケーションの種類として [デスクトップ アプリ] または [ウェブ アプリケーション] を選択し、名前を付けて [作成] をクリックします。

手順を完了すると、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 のすべてのデータを表示します。これには、アカウント情報、広告枠設定、メディエーション設定、レポートなどのデータが含まれる場合があります。お支払いやキャンペーンの詳細などのセンシティブ データは含まれません。
https://www.googleapis.com/auth/admob.report 広告の掲載結果と収益レポートを表示します。パブリッシャー ID、タイムゾーン、デフォルトの通貨コードを確認します。

Java、PHP、Python、または curl の例を使用して、最初のリクエストを行い、レポートを生成します。

共有トークンを取り消す

共有トークンは次の 2 つの方法で取り消すことができます。

  1. Google アカウントの権限ページに移動し、関連するプロジェクトからアクセス権を取り消します。

  2. または、Google Identity API を使用してウェブ アプリケーション トークンを取り消すこともできます。