リマーケティング ユーザーリストに関するデベロッパー ガイド

このドキュメントでは、Management API を使って Google アナリティクス リマーケティング ユーザーリストを管理する方法について説明します。

はじめに

Management API を使って、Google アナリティクスのプロパティのリマーケティング ユーザーリストに対して create、get、delete、list、update、patch を実行できます。リマーケティング ユーザーリストの仕組みについて詳しくは、ヘルプセンターでアナリティクスのリマーケティング ユーザーリストについてをご覧ください。

使用例

リマーケティング ユーザーリスト リソースでは、get、delete、list、patch、update がサポートされています。ただし、主な使用例は次のとおりです。

リマーケティング ユーザーリストを一覧表示する

プロパティのすべてのリマーケティング ユーザーリストを一覧表示するには:

  1. Management API または Account Explorer を使って、accountId と webPropertyId を取得します。
  2. リマーケティング ユーザーリスト リソースの list メソッドを実行します。

リマーケティング ユーザーリスト リソースの list メソッドについて詳しくは、API リファレンスをご覧ください。

新しいリマーケティング ユーザーリストを作成する

プロパティの新しいリマーケティング ユーザーリストを作成するには:

  1. Management API または Account Explorer を使って、accountId と webPropertyId を取得します。
  2. Management API または Account Explorer を使って、linkedViews [] プロパティのビュー（旧「プロファイル」）の ID を取得します。
  3. Google 広告リンク コレクションを使用して、linkedAdAccounts.linkedAccountId の Google 広告アカウント ID を取得します。
    • 現在のところ、linkedAdAccounts[] プロパティに設定できる linkedForeignAccount は 1 つのみです。
    • linkedAdAccounts[].type は ADWORDS_LINKS、DBM_LINKS、MCC_LINKS、OPTIMIZE のいずれかに設定できます。
  4. オプションのセグメント コレクションを使用して includeConditions の segment プロパティを設定します。状態ベースのユーザーリストを作成する場合は、excludeConditions について同様の手順を行います。なお、セグメントの定義について詳しくは、セグメント リファレンスをご覧ください。
    • includeConditions には、必要に応じて membershipDurationDays および daysToLookBack の値を設定できます。
    • excludeConditions.exclusionDuration は、必要に応じて PERMANENT に設定できます。
  5. リマーケティング ユーザーリスト リソースの insert メソッドを実行します。

API を使うと、2 種類のユーザーリスト（SIMPLE と STATE_BASED）を作成できます。SIMPLE ユーザーリストの場合は、一致条件の segment で audienceDefinition のみを作成します。このとき、NOT 演算子（「!」）は使用しません。除外条件を含める必要がある場合は、statebasedDefinition を定義する必要があります。詳しくは、状態ベースのユーザーリストやリファレンスのサンプルをご覧ください。

既存のリマーケティング ユーザーリストを更新する

プロパティの既存のリマーケティング ユーザーリストを更新するには:

  1. すでにリマーケティング ユーザーリスト ID を把握している場合は、get を呼び出すことができます。それ以外の場合は、list を呼び出して、更新するユーザーリストを選択します。
  2. 任意の書き込み可能なフィールドを更新し、update を呼び出して、更新したユーザーリスト オブジェクトを渡します。