開始する

このドキュメントは、AdSense Management API を使用して AdSense アカウントに関する情報を取得するデベロッパーを対象としています。このドキュメントは、ウェブ プログラミングの概念とウェブ用のデータ形式について理解していることを前提としています。

始める前に

AdSense アカウントを取得

ご利用を開始するには、AdSense アカウントに登録またはログインしてください。

AdSense を使ってみる

AdSense の仕組みに詳しくない方は、AdSense の基本情報を参照し、コードの作成を始める前に AdSense の管理画面をテストしてください。

クライアント ライブラリを選択する

クライアント ライブラリとサンプルのページでは、使用可能なライブラリとサンプルに関する情報を確認できます。選択した言語のタブをクリックし、リンクをクリックしてソースをダウンロードします。クライアント ライブラリは次の処理を自動的に行います。

  • 認証
  • サービスの検出
  • API へのリクエストの構築
  • レスポンスの解析

選択したクライアント ライブラリをインストールして構成する手順を確認します。通常は、リポジトリのルート ディレクトリの README ファイルにあります。

サポートされていない言語を使用するなど、実装に特別なニーズがある場合は、クライアント ライブラリを使用する代わりに、API に直接リクエストできます。

アプリケーションを登録する

AdSense Management API を使用するには、プロジェクトを作成し、クライアント ID を生成して、開発するアプリケーションを登録する必要があります。

アプリを登録する

作成した新しい認証情報を使用して、クライアント ライブラリ プロジェクトの構成ファイルを編集します。詳しくは、クライアント ライブラリのドキュメントをご覧ください。

注: 登録に使用する Google アカウントは、デベロッパー アカウント、つまりアプリケーションのユーザーにアプリケーションのデベロッパーとして認識させるアカウントである必要があります。ユーザーがアプリケーションの使用中に自分のアカウントへのアクセスを付与するため、このアカウントを AdSense ログインに関連付ける必要はありません。

クイック スタート チュートリアル

以下の手順に沿って、最初のリクエストを行います。この手順は、使用しているライブラリや言語によって若干異なる場合があります。

  1. 適切なサンプルを使用して、AdSense アカウントから広告クライアントのリストを取得します。このリクエストにより、AdSense ユーザーがプロジェクトの認証と承認を行う 1 回限りのプロセスが開始されます。

    広告クライアントは、AdSense アカウントと AdSense サービス（コンテンツ広告や検索広告など）との関連付けを表します。AdSense アカウントには、1 つまたは複数の広告クライアントを設定できます。

    1. ウェブ アプリケーションの場合、ユーザーはサイトにリダイレクトされ、そこでアクセス権を付与できます。承認されると、ユーザーは Google API Console で定義されたコールバック URL にリダイレクトされます。
    2. インストール済みアプリケーションも同じように動作します。クライアント ライブラリはブラウザ ウィンドウを開いて認証コードを使用します。Android、Chrome、iOS アプリの場合、この方法はプラットフォームによって異なります。
  2. reports.generate の Google APIs Explorer を使用して、次のレポートをリクエストします。
    • date_range: YESTERDAY
    • dimensions: DATE
    • metrics: ESTIMATED_EARNINGS

    レポートでは、収益の内容と収益に影響を与えている要因に関する分析情報を確認できます。広告ユニットはアカウント全体で掲載することも、チャネルを使用して一部の広告ユニットで掲載することもできます。

  3. アプリケーションから同じレポートをリクエストしてみます。
  4. レポートは広告ユニットでフィルタできます。adunits.list を使用して広告ユニットのリストを取得します。 なお、広告クライアント ID が必要です（手順 1 で取得してください）。広告ユニットを選択したら、その ID を reports.generate の filter パラメータで指定します。

    広告ユニットは、表示される広告の一部のプロパティ（サイズや形状など）を定義する、ユーザーが設定する広告のプレースホルダです。

    • date_range: YESTERDAY
    • dimensions: DATE
    • metrics: ESTIMATED_EARNINGS
    • filter: AD_UNIT_ID==ca-pub-123456789:987654321
  5. カスタム チャネルや URL チャネルでフィルタするか、複数のフィルタを組み合わせてみてください。

    チャネルは、一部の広告ユニットのパフォーマンスをトラッキングできるツールです。チャネルには、URL とカスタムの 2 種類があります。前者では特定のページやドメイン全体でパフォーマンスをトラッキングでき、後者ではユーザーが選択した特定の広告ユニットのグループのパフォーマンスをトラッキングできます。

実装を開始するには、リファレンス ドキュメントで、利用可能な残りの呼び出しとリソースを確認します。