Management API - AdWords リンクに関するデベロッパー ガイド

このドキュメントでは、認証されたユーザーが Management API を使用して AdWords とアナリティクスのアカウントのリンクを管理する方法について説明します。

はじめに

Management API の AdWords リンクを使用すると、Google AdWords のアカウントと Google アナリティクスのプロパティ間のリンクを取得、一覧表示、作成、更新、削除することができます。また、どのビュー（旧プロファイル）に AdWords のデータを入力するかを管理することもできます。

AdWords リンクの仕組みとメリットの詳細については、Google アナリティクスと AdWords をリンクする（AdWords ヘルプセンター）、アナリティクスと AdWords のリンク（リンクを解除）する（アナリティクス ヘルプセンター）を参照してください。

準備

Google アナリティクス API はすべて同じ方法でアクセスできます。Management API を使用する前に、以下の準備をしてください。

  • API を扱うプログラミング言語固有のクライアント ライブラリのリストについてクライアント ライブラリ ページで確認します。
  • API インターフェースと、クライアント ライブラリを使わずにデータにアクセスする方法についてリファレンス ガイドで確認します。

各クライアント ライブラリは、すべての Management API データにアクセスするための 1 つの Analytics サービス オブジェクトを提供します。このサービス オブジェクトを作成するには、通常、次の手順に従います。

  1. Google Developers Console でアプリケーションを登録します。
  2. Google アナリティクス データへのアクセスを承認します。
  3. Analytics サービス オブジェクトを作成します。

上記の手順を完了していない場合は、まず Google アナリティクス API についてのチュートリアルをご覧ください。このチュートリアルでは、Google アナリティクス API アプリケーションを作成する基本的な手順を詳しく説明しています。この手順を完了すると、Google アナリティクス API を実際の作業に活用する方法を理解することができます。

使用例

Management API の AdWords リンクを利用して、次の処理を自動化することができます。

プロパティのアナリティクスと AdWords のリンクをすべて一覧表示する

プロパティのアクティブなアナリティクスと AdWords のリンクをすべて一覧表示するには、次の手順に従います。

  1. Management API か管理画面を使用して、アカウント ID とプロパティ ID を取得します。
  2. entityAdWordsLinks リソースの list メソッドを実行します。

詳細については、API リファレンスに記載された entityAdWordsLinks リソースの list メソッドの説明をご覧ください。

アナリティクスと AdWords の新しいリンクを作成する

アナリティクス プロパティと AdWords アカウントのリンクを作成する手順は次のとおりです。

  1. AdWords API か管理画面を使用して、お客様 ID を取得します。
  2. Google アナリティクスの Management API か管理画面を使用して、AdWords アカウントのリンク先となるアカウントとプロパティの ID を取得します。
  3. entityAdWordsLinks リソースの insert メソッドを実行して、AdWords とアナリティクスのリンクを作成します。

詳細については、API リファレンスに記載された entityAdWordsLinks リソースの insert メソッドの説明をご覧ください。

アナリティクス プロパティと AdWords アカウントのリンクを解除する手順は次のとおりです。

  1. Google アナリティクスの Management API か管理画面を使用して、リンクを解除するアカウントとプロパティの ID を取得します。
  2. Management API を使って AdWords リンクの ID を取得します。
  3. entityAdWordsLinks リソースの delete メソッドを実行してリンクを解除します。

詳細については、API リファレンスに記載された entityAdWordsLinks リソースの delete メソッドの説明をご覧ください。

ビュー（旧プロファイル）を既存のアナリティクスと AdWords のリンクに追加する

ビュー（旧プロファイル）のレポートで AdWords データを有効にする手順は次のとおりです。

  1. Google アナリティクスの Management API か管理画面を使って、アカウント、プロパティ、ビュー（旧プロファイル）の ID を取得します。
  2. Management API を使って、ビュー（旧プロファイル）のリンク先となる AdWords リンクの ID を取得します。
  3. entityAdWordsLinks リソースの patch メソッドを実行してビュー（旧プロファイル）を追加します。

詳細については、API リファレンスに記載された entityAdWordsLinks リソースの patch メソッドの説明をご覧ください。

ビュー（旧プロファイル）をアナリティクスと AdWords のリンクから削除する

ビュー（旧プロファイル）のレポートから AdWords データのリンクを解除して削除する手順は次のとおりです。

  1. Google アナリティクスの Management API か管理画面を使って、アカウント、プロパティ、ビュー（旧プロファイル）の ID を取得します。
  2. Management API を使って、削除するビュー（旧プロファイル）がリンクされている AdWords リンクの ID を取得します。
  3. entityAdWordsLinks リソースの get メソッドを実行し、AdWords リンクのプロファイル ID のリストを取得します。
  4. ステップ 3 で取得したリストからプロファイル ID を削除します。
  5. ステップ 4 のリストを使用し、entityAdWordsLinks リソースの patch メソッドを実行して、ビュー（旧プロファイル）を削除します。

詳細については、API リファレンスに記載された entityAdWordsLinks リソースの get メソッドの説明をご覧ください。

サンプルコード

AdWords Links リソースを使用すると、認証されたユーザーが AdWords リンクを一覧表示、取得、削除、更新、挿入することができます。また、AdWords リンクにパッチを適用することも可能です。これらのメソッドを使用するには、準備についてのセクションの説明に従い、まず Analytics サービス オブジェクトを作成する必要があります。

AdWords リンクを扱う方法を示すサンプルコードについては、以下のメソッド リファレンスをご覧ください。

AdWords リンクの管理

  • list - ユーザーがアクセスできる AdWords リンクを一覧表示します。
  • get - ユーザーがアクセスできる AdWords リンクを取得します。
  • insert - 新しい AdWords リンクを作成します。
  • patch - 既存の AdWords リンクにパッチを適用します。
  • update - 既存の AdWords リンクを更新します。
  • delete - 既存の AdWords リンクを削除します。