スタートガイド

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

目次

準備

AdSense アカウントの取得

テスト用の AdSense アカウントが必要です。テスト アカウントを既にお持ちの場合は、テストデータの設定、編集、表示などを行う AdSense の管理画面を表示できます。

AdSense について学ぶ

AdSense で使用される概念についてあまり詳しくない場合は、AdSense の基本情報に目を通し、コードの作成を始める前に管理画面を操作してみてください。

クライアント ライブラリの選択

クライアント ライブラリとサンプルのページでは、使用可能なライブラリとサンプルの情報を参照できます。選択する言語のタブをクリックし、リンクからソースをダウンロードします。クライアント ライブラリは次の処理を実行します。

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

選択したクライアント ライブラリのインストールと設定については、説明を参照してください。通常は、リポジトリのルート ディレクトリにある README ファイルに説明が記載されています。

サポート対象外の言語を使用するなど特殊なニーズのある実装の場合は、クライアント ライブラリを使用せず API に直接リクエストすることができます。

アプリケーションの登録

AdSense Management API を使用するには、作成するアプリケーションを Google に登録する必要があります。

  1. API コンソールに移動します。
  2. Google アカウントにログインするか、アカウントを作成します。
  3. 新規プロジェクトを作成します。
  4. 新しく作成したプロジェクトで [AdSense Management API] の下の [有効にする] ボタンをクリックします。
  5. [API アクセス] セクションに移動します。
  6. 次のクライアント ID を作成します。
    1. ウェブ アプリケーション(ウェブサーバーに実装する場合)
    2. インストールされているアプリケーション(上記以外の場合)

    注: 保護されたデータにアクセスするときにはサービス アカウントはサポートされません。

  7. クライアント ライブラリのプロジェクトの設定ファイルを編集して、新たに作成した認証情報を反映させます。詳細についてはクライアント ライブラリのドキュメントをご覧ください。

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

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

初めてリクエストを作成する場合は次の手順に従います。ただし、この手順は使用するライブラリや言語によって多少異なります。

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

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

    1. ウェブ アプリケーションの場合は他のサイトにリダイレクトされ、そちらでアクセス権を付与する対象を選択します。認証が完了したら、API コンソールで定義されているコールバック URL にリダイレクトされます。
    2. インストールされているアプリケーションの場合も同様で、クライアント ライブラリはブラウザの画面を開いて認証コードを使用します。Android や Chrome、iOS のアプリケーションでは、この手順はプラットフォームによって異なります。
  2. reports.generate で APIs Explorer を使用して次のレポートをリクエストします。
    • startDate: today-1m
    • endDate: today
    • dimensions: DATE
    • metrics: EARNINGS

    レポートは、何が収益を上げているか、何が収益に影響を与えているかといった事柄を把握するために役立ちます。また、レポートはアカウント全体に対して、またはチャネルを使用して広告ユニットのサブセットごとに実行できます。

  3. 同じレポートをアプリケーションからリクエストします。
  4. レポートは広告ユニットでフィルタリングできます。adunits.list を使用すると広告ユニットのリストを取得できます。このとき、手順 1 で取得した広告クライアント ID が必要です。広告ユニットを選択したら、reports.generatefilter パラメータでその ID を使用します。

    広告ユニットは、表示される広告の一部の(広告サイズや形状など)を定義する、ユーザー設定の広告用プレースホルダです。

    • startDate: today-1m
    • endDate: today
    • dimensions: DATE
    • metrics: EARNINGS
    • filter: AD_UNIT_ID==ca-pub-123456789:987654321
  5. カスタム チャネルや URL チャネルを使用して、または複数のフィルタを組み合わせてフィルタリングします。

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

  6. 必要に応じて、AdSense API メーリング リストに参加します。

使用可能な他の呼び出しやリソースについてリファレンス ドキュメントを参照し、実装を開始しましょう。

フィードバックを送信...