エンドツーエンドでのデータ収集の概要

Adobe Experience Platformは、データを収集して、他のAdobe製品やサードパーティの宛先に転送します。 アプリケーションから Experience Platform Edge Network にイベントデータを送信するには、これらのコアテクノロジーと、必要なときに必要な宛先へとデータを配信するように設定する方法を理解することが重要です。

このガイドでは、Platform のデータ収集機能を使用して Edge ネットワークを通じてイベントを送信する方法に関する概要なチュートリアルを提供します。 具体的には、チュートリアルでは、データ収集 UI(旧 Adobe Experience Platform Launch)内で Adobe Experience Platform Web SDK タグ拡張機能をインストールおよび設定する手順について説明します。

メモ

タグを使用しない場合は、SDK を手動でインストールして設定することもできますが、以下に示すように、その前後の手順は完了しておく必要があります。

前提条件

このチュートリアルでは、データ収集 UI を使用して、スキーマの作成、データストリームの設定および Web SDK のインストールを行います。UI でこれらのアクションを実行するには、少なくとも 1 つの web プロパティに対するアクセス権と、次のプロパティ権限が付与されている必要があります。

  • 開発
  • 拡張機能の管理

詳しくは、 データ収集に関する権限の管理 を参照してください。

このガイドに記載されている様々なデータ収集製品を使用するには、データストリームにアクセスし、スキーマを作成および管理する機能も必要です。 これらの機能のいずれかにアクセスする必要がある場合は、CSM に問い合わせて、必要なアクセス権を取得してください。 Adobe Experience Platform を購入していない場合、アドビでは、SDK を使用するために必要なアクセス権を追加料金なしで提供します。

既に Platform へのアクセス権を持っている場合は、次のカテゴリですべての権限が有効になっていることを確認する必要があります。

  • データモデリング
  • ID

ユーザーに Platform 機能の権限を付与する方法については、アクセス制御 UI の概要を参照してください。

プロセスの概要

Web サイトのデータ収集を設定するプロセスは、要約すると次のようになります。

  1. スキーマを作成し、Edge ネットワークに送信する際にデータをどのように構造化するかを決定します。
  2. データストリームを作成し、データの送信先を設定します。
  3. Web SDK をインストールし、web サイトで特定のイベントが発生した場合にデータストリームへとデータを送信するように設定します。

Edge ネットワークにデータを送信できるようになったら、組織がライセンスを保有している場合は、オプションでイベント転送を設定することもできます。

スキーマの作成

エクスペリエンスデータモデル(XDM)は、スキーマの形式でデータの共通の構造と定義を提供するオープンソース仕様です。つまり、XDM は、Edge ネットワークや他の Adobe Experience Cloud アプリケーションで実行可能な方法でデータを構造化およびフォーマットする方法です。

データ収集操作を設定する最初の手順は、データを表す XDM スキーマを作成することです。 このチュートリアルの後の手順では、送信するデータをこのスキーマの構造にマッピングします。

メモ

XDM スキーマはカスタマイズ可能です。 以下に概説する手順は、過度に規範的なものではなく、特に web SDK のスキーマ要件に焦点を当てています。これらのパラメーター以外では、データの残りの構造を自由に定義できます。

データ収集 UI で、左側のナビゲーションから「スキーマ」を選択します。ここから、組織に属する以前に作成したスキーマのリストを表示できます。続行するには、「スキーマを作成」を選択し、ドロップダウンメニューから「XDM ExperienceEvent」を選択します。

スキーマワークスペース

フィールドグループのスキーマへの追加を開始するよう求めるダイアログが表示されます。Web SDK を使用してイベントを送信するには、フィールドグループ AEP Web SDK ExperienceEvent Mixin を追加する必要があります。このフィールドグループには、Web SDK ライブラリによって自動的に収集されるデータ属性の定義が含まれています。

検索バーを使用してリストを絞り込むと、このフィールドグループを見つけやすくなります。見つかったら、リストから選択して、「フィールドグループを追加」を選択します。

スキーマワークスペース

スキーマキャンバスが表示され、Web SDK フィールドグループが提供するフィールドを含む XDM スキーマのツリー構造が示されます。

スキーマの構造

ツリーのルートフィールドを選択して、右パネルで​スキーマのプロパティ​を開きます。ここで、スキーマの名前と説明(オプション)を指定できます。

スキーマに名前を付ける

スキーマにさらにフィールドを追加する場合は、左パネルの「フィールドグループ」セクションで「追加」を選択します。

フィールドグループの追加

メモ

ユースケースに合う様々なフィールドグループを検索する方法について詳しくは、XDM ドキュメントのフィールドグループの追加に関するガイドを参照してください。

ベストプラクティスは、Edge ネットワークを介して送信する予定のデータのフィールドのみを追加することです。フィールドをスキーマに追加して保存すると、それ以降はスキーマに追加の変更を加えることのみ可能です。詳しくは、スキーマ進化のルールの節を参照してください。

必要なフィールドを追加したら、「保存」を選択してスキーマを保存します。

スキーマの保存

データストリームの作成

データストリームとは、データの送信先を Edge ネットワークに伝える設定のことです。具体的には、データストリームは、データの送信先のExperience Cloud 製品と、各製品でデータを処理および保存する方法を指定します。

メモ

イベント転送を使用する場合(組織が機能のライセンスを取得している場合)、アドビ製品を有効にするのと同じ方法でデータストリームに対してイベント転送を有効にする必要があります。このプロセスについて詳しくは、後の節で説明します。

データ収集 UI で、「データストリーム」を選択します。ここから、編集する既存のデータストリームをリストから選択したり、「新規データストリーム」を選択して新しい設定を作成したりできます。

データストリーム

データストリームの設定要件は、データの送信先の製品と機能によって異なります。 各製品の設定オプションについて詳しくは、データストリームの概要を参照してください。

Web SDK のインストールと設定

スキーマとデータストリームを作成したら、次の手順として、Platform Web SDK をインストールして、Edge ネットワークへのデータ送信を開始するように設定します。

メモ

この節では、データ収集 UI を使用して web SDK タグ拡張機能を設定しますが、代わりに生のコードを使用してインストールおよび設定することもできます。詳しくは、次のガイドを参照してください。

また、イベント転送のみを使用する場合でも、後の手順でイベント転送を設定する前に、説明に従って SDK をインストールして設定する必要があります。

プロセスの概要は次のとおりです。

  1. Adobe Experience Platform Web SDK をタグプロパティにインストールして、その機能にアクセスできるようにします。
  2. XDM オブジェクトデータ要素を作成して、web サイト上の変数を、以前作成した XDM スキーマの構造にマッピングします。
  3. Edgeネットワークへのデータ送信のタイミングを SDK に通知するルールを作成します。
  4. ライブラリを構築してイ ンストールし、web サイトにルールを実装します。

タグプロパティに SDK をインストールする

左側のナビゲーションで「タグ」を選択して、タグプロパティのリストを表示します。必要に応じて、既存のプロパティを選択して編集することも、代わりに「新しいプロパティ」を選択することもできます。

プロパティ

新しいプロパティを作成する場合は、わかりやすい名前を指定し、Platform を Web に設定します。Web プロパティの完全なドメインを指定し、「保存」を選択します。

プロパティの作成

プロパティの概要ページが表示されます。ここから、左側のナビゲーションで「拡張機能」を選択し、「カタログ」を選択します。Platform Web SDK のリストを見つけ(オプションとして検索バーを使用して結果を絞り込む)、「インストール」を選択します。

Web SDK のインストール

SDK の設定ページが表示されます。必要な値のほとんどはデフォルトで自動入力されますが、必要に応じて変更できます。

Web SDK の設定

ただし、SDK をインストールする前に、データストリームを選択して、データの送信先がわかるようにする必要があります。「データストリーム」の下で、ドロップダウンメニューを使用して、前の手順で設定したデータストリームを選択します。データストリームを設定したら、「保存」を選択して、SDK のプロパティへのインストールを完了します。

データストリームの設定と保存

XDM データ要素の作成

SDK が Edge ネットワークにデータを送信するには、そのデータを前の手順で作成した XDM スキーマにマッピングする必要があります。このマッピングは、データ要素を使用して実行されます。

UI で「データ要素」を選択し、「新しいデータ要素の作成」を選択します。

新しいデータ要素の作成

次の画面で、「拡張機能」ドロップダウンの下の「Adobe Experience Platform Web SDK」を選択し、データ要素タイプとして「XDM オブジェクト」を選択します。

XDM オブジェクトタイプ

XDM オブジェクトタイプの設定ダイアログが表示されます。ダイアログは自動的に Platform サンドボックスを選択し、ここから、そのサンドボックスで作成されたすべてのスキーマを表示できます。前に作成した XDM スキーマをリストから選択します。

XDM オブジェクトタイプ

スキーマの構造が表示されます。アスタリスク(*)が付いているすべてのフィールドは、イベントの発生時に自動的に入力されるフィールドを示します。他のすべてのフィールドについては、スキーマの構造を調べて、残りのデータを入力できます。

XDM フィールドへのデータのマッピング

メモ

上のスクリーンショットは、パーセント記号(%)で囲まれた「値」フィールドでその名前を参照することにより、web サイトのクライアント側(cartAbandonsTotal)からグローバルにアクセス可能な変数を XDM フィールドにマップする方法を示しています。

また、以前に作成した他のデータ要素を使用して、これらのフィールドに値を入力することもできます。詳しくは、タグのドキュメントのデータ要素のリファレンスを参照してください。

データのスキーマへのマッピングが完了したら、「保存」を選択する前にデータ要素の名前を指定します。

データ要素に名前を付けて保存

ルールの作成

データ要素を保存した後、次の手順では、web サイトで特定のイベントが発生した場合(顧客が買い物かごに商品を追加した場合など)は常に Edge ネットワークにデータ要素を送信するルールを作成します。

Web サイト上で発生する可能性のあるほぼすべてのイベントに対してルールを設定できます。例として、この節では、顧客がフォームを送信したときにトリガーするルールを作成する方法を示します。 次の HTML は、ルールの対象となる「買い物かごに追加」フォームを含むシンプルな web ページを表しています。

<!DOCTYPE html>
<html>
<body>

  <form id="add-to-cart-form">
    <label for="item">Product:</label><br>
    <input type="text" id="item" name="item"><br>
    <label for="amount">Amount:</label><br>
    <input type="number" id="amount" name="amount" value="1"><br><br>
    <input type="submit" value="Add to Cart">
  </form>

</body>
</html>

データ収集 UI で、左側のナビゲーションで「ルール」を選択し、「新しいルールの作成」を選択します。

ルール

次の画面で、ルールの名前を指定します。ここから、次の手順は、ルールのイベント(つまり、ルールがいつ実行されるか)を決定することです。「イベント」の下の「追加」を選択します。

名前のルール

イベント設定ページが表示されます。イベントを設定するには、まずイベントタイプを選択する必要があります。イベントタイプは拡張機能で提供されます。例えば、「フォーム送信」イベントを設定するには、Core 拡張機能を選択してから、「フォーム」カテゴリで「送信」イベントタイプを選択します。

メモ

設定方法など、アドビの web 拡張機能で提供される様々なイベントタイプについて詳しくは、タグドキュメントのアドビ拡張機能のリファレンスを参照してください。

フォーム送信イベントでは、CSS セレクターを使用して、ルールを実行する特定の要素を参照できます。 以下の例では、ID add-to-cart-form が使用されているため、「買い物かごに追加」フォームに対してのみこのルールが実行されます。「変更を保持」を選択して、ルールにイベントを追加します。

イベント設定

ルール設定ページが再び表示され、イベントが追加されたことが示されます。ルールにさらに条件を追加することで、「If」を絞り込むことができます。

それ以外の場合、次の手順として、ルールが起動したときに実行するアクションを追加します。「アクション」の下の「追加」を選択して続行します。

アクションの追加

アクション設定ページが表示されます。Edge ネットワークへのデータ送信ルールを取得するには、拡張機能で「Adobe Experience Platform Web SDK」、アクションタイプで「イベントの送信」を選択します。

アクションタイプ

画面が更新され、イベント送信アクションを設定するための追加のオプションが表示されます。「タイプ」から、eventType XDM フィールドに入力するカスタムタイプの値を指定できます。「XDM データ」から、前に作成した XDM データタイプの名前(パーセント記号で囲まれています)を入力するか、データベースアイコン(データベースアイコン)をクリックしてリストから選択します。これは、最終的に Edge ネットワークに送信されるデータです。

終了したら「変更を保持」を選択します。

アクション設定

ルールの設定が完了したら、「保存」を選択してプロセスを終了します。

ルールの保存

ライブラリのビルドとインストール

ルールを設定したら、それをタグライブラリに追加し、そのライブラリを環境にビルドして、そのビルドを web サイトにインストールする準備が整います。

メモ

データ収集 UI の環境設定がまだの場合は、ビルドを作成する前に設定する必要があります。詳しくは、タグドキュメントのweb プロパティの環境の設定に関する節を参照してください。

ライブラリの作成、ライブラリへの拡張機能とルールの追加、環境へのライブラリのビルドの方法については、タグドキュメントのライブラリの管理に関するガイドを参照してください。ライブラリを作成する場合、Platform Web SDK 拡張機能と、以前に作成したデータ収集ルールが含まれていることを確認します。

ライブラリを作成し、そのビルドを環境に割り当てたら、その環境を web サイトのクライアント側にインストールできます。詳しくは、環境の設定の節を参照してください。

Web サイトに環境をインストールしたら、Adobe Experience Platform Debugger を使用して実装をテストできます。

イベント転送の設定(オプション)

メモ

イベント転送は、そのイベントのライセンスを取得している組織のみが使用できます。

Edge ネットワークにデータを送信するように SDK を設定したら、イベント転送を設定して、Edge ネットワークにそのデータを配信する場所を通知できます。

イベント転送を使用するには、まずイベント転送プロパティを作成する必要があります。左側のナビゲーションで「イベント転送」を選択し、「新しいプロパティ」を選択します。「保存」を選択する前に、プロパティの名前を指定します。

イベント転送プロパティを作成したら、次の手順でデータの送信先を決定するルールを作成します。 イベント転送プロパティのルールは、イベントを指定できないことを除いて、タグプロパティとほぼ同じ方法で構築されます(イベント転送は、データストリームから直接受信するイベントのみを扱うため)。ルールのアクションに対して、使用可能なイベント転送拡張機能の 1 つを使用するか、代わりにカスタムコードを使用してイベントを配信できます。

イベント転送ルール

先程と同様に、ルールを設定したら、ライブラリに追加して、そのライブラリを環境にビルドする必要があります。

ビルドが完了したら、最後の手順は、以前に設定したデータストリームを更新し、イベント転送を有効にすることです。開始するには、データストリーム​に移動し、リストから該当するデータストリームを選択します。ここから、イベント転送の切り替えを有効にし、設定したプロパティと環境の名前を指定します。

イベント転送データストリーム

次の手順

このガイドでは、Platform web SDK を使用して Edge ネットワークにデータを送信する方法について、エンドツーエンドの概要を説明しました。関連する様々なコンポーネントとサービスについて詳しくは、このガイド全体にリンクされているドキュメントを参照してください。

このページ