clickCollection

clickCollection オブジェクトには、自動的に収集されたリンク データを制御するのに役立つ複数の変数が含まれています。 これらの変数は、データ収集にリンクのタイプを含めたり除外したりする場合に使用します。 Web SDK バージョン 2.25.0以降でサポートされています。

この変数には、次のすべてが必要です。

  • clickCollectionEnabledを有効にする必要があります。
  • clickCollection.filterClickDetailsを使用する場合、非推奨のメソッド onBeforeLinkClickSendは空である必要があります。
  • イベントペイロードには、訪問者の訪問のある時点でxdm.web.webPageDetails.nameの値を含める必要があります。

実装が上記のすべての要件を満たさない場合、このオブジェクトは何もしません。

clickCollection オブジェクトでは、次のプロパティを使用できます。

プロパティ
タイプ
説明
internalLinkEnabled
boolean
現在のドメイン内のリンクが自動的に追跡されるかどうかを指定します。 例えば、https://example.com/index.htmlからhttps://example.com/product.htmlは内部リンクと見なされます。
downloadLinkEnabled
boolean
ライブラリがdownloadLinkQualifier プロパティに基づいて、ダウンロードとして認定されるリンクを追跡するかどうかを指定します。
externalLinkEnabled
boolean
外部ドメインへのリンクが自動的に追跡されるかどうかを指定します。 例えば、https://example.comからhttps://example.netは外部リンクと見なされます。
eventGroupingEnabled
boolean

ライブラリが次の「ページビュー」イベントを待ってリンクトラッキングデータを送信するかどうかを指定します。 ライブラリは、次の要素がペイロードに含まれている場合、イベントを「ページビュー」と見なします。

  • xdm.web.webPageDetails.nameには文字列値が含まれています
  • xdm.web.webPageDetails.pageViews.value0より大きい

「ページビュー」イベントが読み込まれると、ライブラリは、保存されたリンク追跡データとそのイベント内の残りのデータを組み合わせます。 このオプションを有効にすると、Adobeに送信するイベントの合計数が減少します。 internalLinkEnabledが無効になっている場合、この変数は何もしません。

sessionStorageEnabled
boolean
リンクトラッキングデータがローカル変数ではなくセッションストレージに保存されるかどうかを指定します。 internalLinkEnabledまたはeventGroupingEnabledが無効になっている場合、この変数は何も実行しません。
Adobeでは、シングルページアプリケーション以外でeventGroupingEnabledを使用する場合は、この変数を有効にすることを強くお勧めします。 eventGroupingEnabledが有効になっている間にsessionStorageEnabledが無効になっている場合、新しいページをクリックすると、セッションストレージに保存されないため、リンク追跡データが失われます。 シングルページアプリケーションは通常、新しいページに移動しないため、SPA ページにセッションストレージは必要ありません。
filterClickDetails
function
収集したリンクトラッキングデータを完全に制御できるコールバック関数。 このコールバック関数を使用すると、リンク追跡データの送信を変更、難読化、または中止できます。 このコールバックは、リンク内の個人情報などの特定の情報を省略する場合に便利です。

このオブジェクトをconfigure コマンドで設定しない場合、このオブジェクトのデフォルト設定はclickCollectionEnabledの値によって異なります。

  • internalLinkEnabled: clickCollectionEnabledと一致
  • downloadLinkEnabled: clickCollectionEnabledと一致
  • externalLinkEnabled: clickCollectionEnabledと一致
  • eventGroupingEnabled: デフォルトはfalseです。明示的に有効にする必要があります
  • sessionStorageEnabled: デフォルトはfalseです。明示的に有効にする必要があります
  • filterClickDetails:関数が含まれていません。明示的に登録する必要があります
TIP
Adobeでは、internalLinkEnabledが有効になっている場合にeventGroupingEnabledを有効にすることをお勧めします。これは、契約上の使用にカウントされるイベントの数を減らすためです。
alloy("configure", {
  datastreamId: "ebebf826-a01f-4458-8cec-ef61de241c93",
  orgId: "ADB3LETTERSANDNUMBERS@AdobeOrg",
  clickCollectionEnabled: true,
  clickCollection: {
    internalLinkEnabled: true,
    downloadLinkEnabled: true,
    externalLinkEnabled: true,
    eventGroupingEnabled: true,
    sessionStorageEnabled: true,
    filterClickDetails: function(content) {
      // If the link is a clickable telephone number, anonymize it
      if(content.linkUrl?.includes("tel:")) {
        content.linkName = content.linkUrl = "Phone number";
      }
      // If the link is an email address, anonymize it
      if(content.linkUrl?.includes("mailto:")) {
        content.linkName = content.linkUrl = "Email address";
      }
    }
  }
});

Web SDK タグ拡張機能のクリックコレクションの設定

これらの設定は、Data collection configuration settingsを使用してWeb SDK タグ拡張機能で設定できます。

recommendation-more-help
experience-platform-help-collection