このドキュメントでは、Management API を使って Google アナリティクス リマーケティング ユーザーリストを管理する方法について説明します。
はじめに
Management API を使用すると、Google アナリティクス プロパティのリマーケティング オーディエンスをcreate
、get
、delete
、list
、update
、patch
することができます。リマーケティング オーディエンスの仕組みについて詳しくは、ヘルプセンターのアナリティクスのリマーケティング オーディエンスについてをご覧ください。
ユースケース
リマーケティング オーディエンス リソースでは get、delete、list、patch、update がサポートされていますが、主なユースケースは次のとおりです。
リマーケティング ユーザーリストを一覧表示する
プロパティのすべてのリマーケティング ユーザーリストを一覧表示するには:
- Management API またはアカウント エクスプローラを使用して、
accountId
とwebPropertyId
を取得します。 - リマーケティング オーディエンス リソースの
list
メソッドを実行します。
リマーケティング オーディエンス リソースの list
メソッドについて詳しくは、API リファレンスをご覧ください。
新しいリマーケティング オーディエンスを作成する
プロパティの新しいリマーケティング ユーザーリストを作成するには:
- Management API またはアカウント エクスプローラを使用して、
accountId
とwebPropertyId
を取得します。 - Management API またはアカウント エクスプローラを使用して、
linkedViews []
プロパティのビュー(プロファイル)ID を取得します。 - Google 広告リンク コレクションを使用して、
linkedAdAccounts.linkedAccountId
の Google 広告アカウント ID を取得します。- 現在、
linkedAdAccounts[]
プロパティは 1 つのlinkedForeignAccount
のみに制限されています。 linkedAdAccounts[].type
は、ADWORDS_LINKS
、DBM_LINKS
、MCC_LINKS
、OPTIMIZE
に設定できます。
- 現在、
- セグメント コレクションを使用して、
includeConditions
のsegment
プロパティを設定します。状態ベースのオーディエンスを作成する場合は、excludeConditions
についても同様に行います。セグメントの定義については、セグメント リファレンスをご覧ください。includeConditions
には、必要に応じてmembershipDurationDays
とdaysToLookBack
の値を設定できます。- 必要に応じて、
excludeConditions.exclusionDuration
をPERMANENT
に設定できます。
- リマーケティング オーディエンス リソースの
insert
メソッドを実行します。
API を使用すると、SIMPLE
と STATE_BASED
の 2 種類のオーディエンスを作成できます。SIMPLE
オーディエンスの場合、NOT 演算子(!
文字)を使用せず、正の segment
を指定して audienceDefinition
を作成する必要があります。除外条件を含める場合は、statebasedDefinition
を定義する必要があります。詳しくは、状態ベースのオーディエンスをご覧ください。詳しくは、リファレンス例をご覧ください。
既存のリマーケティング ユーザーリストを更新する
プロパティの既存のリマーケティング ユーザーリストを更新するには:
- リマーケティング オーディエンス ID がすでにある場合は、
get
を呼び出すことができます。または、list
を呼び出して、更新するオーディエンスを選択できます。 - 書き込み可能なフィールドのいずれかを更新し、
update
を呼び出して、更新したオーディエンス オブジェクトを渡します。