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 を手動で有効にするには、次の手順を実施します。

プロジェクトで API を有効にするには:

  1. Google API ConsoleのOpen the API Library
  2. If prompted, select a project, or create a new one. API Library には、利用可能なすべての API がプロダクト ファミリーと人気度に応じて分類されて表示されます。
  3. 有効にする API がリストで見当たらない場合は、検索して見つけるか、その 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 を作成します。この ID はインストール型アプリのフローで使用します。

  1. Go to the Credentials page.
  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、タイムゾーン、デフォルトの通貨コードを確認します。

JavaPHPPythoncurl の例を使用して、レポートを生成する最初のリクエストを作成します。

共有トークンを取り消す

共有トークンを取り消す方法は 2 つあります。

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

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