このガイドは、AdMob API を使用して AdMob アカウントに関する情報をプログラムで取得するデベロッパーを対象としています。
アプリがユーザーに代わってウェブサービスとやり取りできるように、すべての Google AdMob API の呼び出しを OAuth2 を介して認証する必要があります。OAuth2 を使用すると、AdMob API クライアント アプリは、ユーザー名やパスワードを処理または保存することなく、ユーザーの AdMob アカウントにアクセスできます。承認の概要については、承認をご覧ください。
次の手順で OAuth2 認証情報を生成し、最初のリクエストを送信します。
前提条件
REST の基本と OAuth 2.0 によるリクエストの承認に精通していること。
認証タイプを決定する
以下の表で、アプリに最適な認証タイプを確認してください。
OAuth2 認証タイプを選択する | 適しているケース |
---|---|
デスクトップ アプリ |
|
ウェブアプリ |
|
プロジェクトを作成する
AdMob API の使用を開始するには、まず Google API Console でプロジェクトを作成または選択し、設定ツールを使用して API を有効にする必要があります。これにより、手順が案内されて AdMob API が自動的に有効になります。
既存のプロジェクトで API を有効にする
既存のプロジェクトがあり、そのプロジェクトに対して AdMob API を手動で有効にする場合は、次の手順を実施します。
プロジェクトのAPIを有効にするには:
- Open the API LibraryのGoogle API Console
- If prompted, select a project, or create a new one. API Libraryは、製品ファミリおよび人気度API Libraryグループ化された、利用可能なすべてのAPIをリストします。
- 有効にするAPIがリストに表示されない場合は、検索を使用してそれを見つけるか、それが属する製品ファミリで[すべて表示 ]をクリックします 。
- 有効にするAPIを選択して、[ 有効にする ]ボタンをクリックします。
- If prompted, enable billing.
- If prompted, read and accept the API's Terms of Service.
OAuth2 認証情報を作成する
次の手順では、インストール型アプリのフローで使用する OAuth 2.0 クライアント ID を作成する方法を説明します。
- Go to the Credentials page.
[認証情報を作成] > [OAuth クライアント ID] をクリックします。
このプロジェクトの OAuth 同意画面をまだ構成していない場合は、ここで構成するように指示されます。[同意画面を構成] をクリックします。OAuth 2.0 クライアント ID を使用するための同意画面を設定する方法は複数あります。
- ユーザータイプを [外部] に設定し、公開ステータスを [公開済み] に設定します。
または、ユーザータイプを [外部] に設定し、公開ステータスを [テスト] に設定してから、[ユーザーを追加] を選択して [テストユーザー] を追加し、OAuth 2.0 クライアント ID を使用するためのアクセス権を付与します。
詳しくは、OAuth 同意画面の設定をご覧ください。
アプリケーションの種類として [デスクトップ アプリ] または [ウェブ アプリケーション] を選択し、名前を入力して [作成] をクリックします。
完了すると、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 つの方法があります。
Google アカウントの権限ページに移動し、関連するプロジェクトのアクセス権を取り消します。
また、Google Identity API を使用してウェブ アプリケーションのトークンを取り消すこともできます。