contextData
コンテキストデータ変数を使用すると、処理ルールで読み取ることのできる各ページにカスタム変数を定義できます。 コード内の Analytics 変数に値を明示的に割り当てる代わりに、コンテキストデータ変数でデータを送信できます。 次に、処理ルールはコンテキストデータ変数の値を取得し、それぞれの Analytics 変数に渡します。 『管理ユーザガイド』の「処理ルール」を参照してください。
コンテキストデータ変数は、開発チームが番号付き変数ではなく名前付きの要素でデータを収集する場合に役立ちます。 例えば、開発チームにページの作成者の eVar10 への割り当てをリクエストする代わりに、s.contextData["author"] への割り当てをリクエストできます。 その後、組織の Analytics 管理者が、レポート用にコンテキストデータ変数を Analytics 変数にマップする処理ルールを作成できます。 最終的には、Adobeで提供される多くのページ変数ではなく、コンテキストデータ変数のみを使用することになります。
すべてのコンテキストデータ変数(キーと値を含む)の最大サイズは32 KBです。
Web SDK を使用したコンテキストデータ変数
XDM オブジェクトを使用する場合、Adobe Analytics変数にマッピングされないすべてのフィールドがコンテキストデータ変数として自動的に含まれます。 また、XDM オブジェクトを使用してコンテキストデータを明示的に設定することもできます。 次に、処理ルール を使用して、コンテキストデータ変数を目的のAnalytics変数に割り当てることができます。 詳しくは、他のXDM フィールドをAnalytics変数にマッピング を参照してください。
データオブジェクトを使用する場合、すべてのコンテキストデータ変数はキーと値のペアとしてdata.__adobe.analytics.contextData内に存在します。
alloy("sendEvent", {
"data": {
"__adobe": {
"analytics": {
"contextData": {
"example_variable": "Example value",
"second_example": "Another value"
}
}
}
}
});
処理ルール インターフェイスには、該当するドロップダウンメニューにexample_variableとsecond_exampleが表示されます。
Adobe Analytics 拡張機能を使用したコンテキストデータ変数
Adobe Experience Platform データ収集には、コンテキストデータ変数を設定するための専用の場所がありません。 AppMeasurement 構文に従って、カスタムコードエディターを使用します。
AppMeasurement および Analytics 拡張機能のカスタムコードエディターの s.contextData
s.contextData 変数は値を直接取りません。 代わりに、この変数のプロパティを文字列に設定します。
// Assign the example_variable property a value
s.contextData["example_variable"] = "Example value";
- 有効なコンテキストデータ変数には、英数字、アンダースコアおよびピリオドのみが含まれます。 ハイフンなどの他の文字を含める場合、処理ルールでのデータ収集は保証されません。
- コンテキストデータ変数を
"a."のプレフィックスで開始しないでください。 この接頭辞はアドビが予約して使用します。 例えば、s.contextData["a.InstallEvent"]を使用しないでください。 - コンテキストデータ変数では、大文字と小文字が区別されません。
s.contextData["example"]変数とs.contextData["EXAMPLE"]変数は同じです。 - 1つのキーに複数の値を含めることはできません。 複数値の変数にコンテキストデータ変数を使用する場合は、区切り文字(通常はコンマ)を使用してすべての値を連結し、処理ルールを使用して リスト propまたは リスト変数のいずれかに渡します。
処理ルールを使用した Analytics 変数の入力
- コンテキストデータ変数の名前と値を設定するには、実装を更新します。
- Adobe Analyticsにログインし、Admin > Report Suitesに移動します。
- 目的のレポートスイートを選択し、設定を編集 > 一般 > 処理ルールに移動します。
- コンテキストデータ変数の値を Analytics 変数に設定する処理ルールを作成します。
- 変更を保存します。
処理ルールは、保存するとすぐに有効になります。 履歴データには適用されません。
リンクトラッキングコールでのコンテキストデータの送信
コンテキストデータ変数を contextData のプロパティとして s.linkTrackVars に含めます。
s.contextData["example_variable"] = "Example value";
s.linkTrackVars = "contextData.example_variable";
s.tl(true,"o","Example context data link");
コンテキストデータ変数を使用したイベントの増分
処理ルールを作成する際に、コンテキストデータ変数をイベントに割り当てることができます。
- コンテキストデータ変数に任意の種類のテキストが含まれている場合、イベントは 1 つ増分されます。
- コンテキストデータ変数に整数が含まれる場合、イベントはその整数分だけ増加します。
// Assigning this context data variable to an event increments it by one
s.contextData["example_text"] = "Text value";
// Assigning this context data variable to an event increments it by four
s.contextData["example_number"] = "4";