スタートガイド

このドキュメントは、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 サービスの関連付けを表します。1 つの AdSense アカウントに、1 つまたは複数の広告クライアントを設定できます。

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

    レポートでは、収益の内容や収益に影響を及ぼしている要因に関する分析情報が得られます。広告は、アカウント全体またはチャネルを使用して一部の広告ユニットに配信可能です。

  3. アプリケーションから同じレポートをリクエストしてみてください。
  4. 広告ユニットでレポートを絞り込むことができます。adunits.list を使用して、広告ユニットのリストを取得します。その際、広告クライアント ID が必要です（ステップ 1 で取得します）。広告ユニットを選択したら、reports.generate の filter パラメータでその ID を使用します。

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

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

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

リファレンス ドキュメントで、利用可能な残りの呼び出しとリソースを調べて、実装を開始しましょう。