AdMob API のスタートガイド

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

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

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

前提条件

認証タイプを決定する

アプリに最適な認証タイプについては、以下の表をご覧ください。

OAuth2 認証タイプを選択する 適しているケース
パソコン版アプリ
  • 1 つの最上位の MCC アカウントを使用して、すべての AdMob API アカウントを管理している。
  • 初めて使用する場合や、最も簡単な設定ですぐに開始したい場合。
  • アプリが 1 台のマシンからのみ Google AdMob ユーザーを認証する。
ウェブアプリ
  • アプリが AdMob API アカウント データにアクセスする権限を付与できるユーザーとして認証する。
  • 複数の認証情報を簡単に生成して、サードパーティ アカウントなどを管理する場合。
  • アプリでコールバック URL が必要です。コールバック URL は、デスクトップ アプリフローではサポートされていません。

プロジェクトを作成する

AdMob API を使用するには、まず Google API Console でプロジェクトを作成または選択し、セットアップ ツールを使用して API を有効にする必要があります。このツールを使用すると、プロセスがガイドされ、AdMob API が自動的に有効になります。

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

以下の手順は、既存のプロジェクトがあり、そのプロジェクトで AdMob API を手動で有効にしたいユーザーを対象としています。

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

  1. Google API Console で API ライブラリを開きます。
  2. プロンプトが表示されたら、プロジェクトのいずれかを選択するか、新しいプロジェクトを作成します。API ライブラリには、利用可能なすべての API がプロダクト ファミリーと人気度に応じて分類されて表示されます。
  3. 有効にする API がリストで見当たらない場合は、検索して見つけるか、その 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. アプリケーションの種類として [デスクトップ アプリ] または [ウェブ アプリケーション] を選択し、名前を付けて [作成] をクリックします。

完了すると、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 を使用してウェブ アプリケーション トークンを取り消すこともできます。