Salesforce Interaction Studio コネクタ構成ガイド | サーバーサイドコネクター

API 情報

このコネクタは以下のベンダー API を使用します：

API 名: Personalization Event API
API バージョン: v2
ドキュメント: Personalization Event API

コネクタアクション

アクション名	AudienceStream	EventStream
信頼できるチャネル経由でイベントデータを送信 (SalesforceInteractions 名前空間)	✗	✓
信頼できるチャネル経由でイベントデータを送信 (Evergage 名前空間)	✗	✓

構成の構成

コネクタマーケットプレイスに移動して新しいコネクタを追加します。コネクタを追加する一般的な手順については、コネクタについての記事を参照してください。

コネクタを追加した後、以下の構成を構成します：

アカウント名
必須。 あなたのInteraction Studioアカウント名。
アカウント名は、Salesforce内の Interaction Studio UI から Gears にアクセスし、URLを確認することで取得できます。例えば、あなたのGears URLが https://demo.us-1.evergage.com/ の場合、アカウント名は demo です。
インスタンス識別子
必須。 あなたのInteraction Studioインスタンス識別子。
インスタンス識別子は、Salesforce内の Interaction Studio UI から Gears にアクセスし、URLを確認することで取得できます。例えば、あなたのGears URLが https://demo.us-1.evergage.com/ の場合、インスタンス識別子は us-1 です。
データセット識別子
必須。 あなたがデータを送信しているInteraction Studioデータセットの名前/識別子。
APIキーID
必須。 APIトークンを生成するために使用されるAPIキーID。
APIトークンについての詳細は、Salesforce Personalization Knowledge Baseの APIトークンドキュメントを参照してください。
APIキーシークレット
必須。 APIトークンを生成するために使用されるAPIキーシークレット。
APIトークンについての詳細は、Salesforce Personalization Knowledge Baseの APIトークンドキュメントを参照してください。

コネクタの構成が完了したら、完了をクリックします。

アクション構成 — パラメータとオプション

コネクタアクションの構成を続けるために続行をクリックします。アクションの名前を入力し、ドロップダウンメニューからアクションタイプを選択します。

次のセクションでは、各アクションのパラメータとオプションの構成方法について説明します。

アクション — 信頼できるチャネル経由でイベントデータを送信 (SalesforceInteractions 名前空間)

パラメータ

パラメータ	説明
Explain	`true`の場合、キャンペーンが表示されたか表示されなかったかの理由についての追加情報をレスポンスで返します。
Page View	`true`の場合、ページロードからイベントがトリガーされたことを示します。
Time	イベントの日時（UNIXエポックからの経過ミリ秒）。このフィールドはオプションで、nullの場合は現在の時間で自動的に入力されます。
Interaction Type	インタラクションタイプを選択します。 Catalog Object Interaction - カタログオブジェクトに関するエンゲージメントデータをキャプチャするために使用されます。 Cart Interaction - ユーザーのカートの内容に関するエンゲージメントデータをキャプチャするために使用されます。 Order Interaction - ユーザーの注文内のアイテムに関するエンゲージメントデータをキャプチャするために使用されます。パーソナライゼーションでは、PurchaseOrderInteractionのみがユーザーの現在の注文を影響し更新します。
Interaction Name	インタラクション名を選択します。選択されたInteraction Typeに応じて名前が表示されます。
ID	カタログオブジェクトを表す一意のIDです。
Type	カタログオブジェクトを表すタイプ名です。
カタログオブジェクト属性	このセクションは、インタラクションタイプセクションで選択されたタイプがカタログオブジェクトインタラクションでない場合は無視されます。カタログオブジェクト属性は、カタログオブジェクトにメタデータとして保存されるキーバリューペアです。これらの属性はプラットフォームで定義する必要があります。使用例については、Salesforce Interaction Studio Event APIのドキュメントを参照してください。ネストされたオブジェクトのサポートが必要な場合は、テンプレートセクションでテンプレートを定義できます。テンプレートは、一致する二重中括弧で参照される名前にマッピングする必要があります：`{{template_name}}`。
関連カタログオブジェクト	このセクションは、インタラクションタイプセクションで選択されたタイプがカタログオブジェクトインタラクションでない場合は無視されます。関連カタログオブジェクトのキーバリューペア。これらの関連カタログオブジェクトはプラットフォームで定義する必要があります。使用例については、Salesforce Interaction Studio Event APIのドキュメントを参照してください。
カートデータ	このセクションは、インタラクションタイプセクションで選択されたタイプがカートインタラクションでない場合は無視されます。このタイプのインタラクションは、ユーザーのカートの内容に関するエンゲージメントデータをキャプチャするために使用されます。使用例については、Salesforce Interaction Studio Event APIのドキュメントを参照してください。ネストされたオブジェクトのサポートが必要な場合は、テンプレートセクションでテンプレートを定義できます。テンプレートは、一致する二重中括弧で参照される名前にマッピングする必要があります：`{{template_name}}`。
カタログオブジェクトID	カタログオブジェクトを表す一意のID。
カタログオブジェクトタイプ	カタログオブジェクトを表すタイプ。
通貨	購入のオプション通貨コード。nullの場合はデータセットで構成された通貨がデフォルトになります。
価格	ラインアイテムのカタログオブジェクトの価格。
数量	ラインアイテムのカタログオブジェクトの数。
カートラインアイテム属性	このセクションは、インタラクションタイプセクションで選択されたタイプがカートインタラクションでない場合は無視されます。カートラインアイテム属性は、ラインアイテムオブジェクトにメタデータとして保存されるキーバリューペアです。これらの属性はプラットフォームで定義する必要があります。オブジェクト構造については、Salesforce Interaction Studio Event APIのドキュメントを参照してください。複数のアイテムを追加するために配列タイプの属性を提供します。配列タイプの属性は同じ長さでなければなりません。カートラインアイテム属性の配列とカートラインアイテムの配列は同じ長さでなければなりません。単一値の属性を使用することができ、各アイテムに適用されます。
カートラインアイテムテンプレート変数	カートラインアイテムテンプレートのデータ入力用テンプレート変数を提供します。詳細と使用例については、コネクターテンプレート変数を参照してください。例えば `items.name` のようにドット記法でネストされたテンプレート変数を命名します。ネストされたテンプレート変数は通常、データレイヤーのリスト属性から構築されます。
カートラインアイテムテンプレート	インタラクションタイプセクションで選択されたタイプがカートインタラクションでない場合、このセクションは無視されます。ネストされたオブジェクトのサポートが必要な場合、このセクションを使用してテンプレートを定義します。インタラクション名セクションでカートに追加またはカートから削除が選択された場合、テンプレートはJSONオブジェクト形式を期待します。それ以外の場合は、JSON配列形式を期待します。テンプレートが定義されると、カートラインアイテムおよびカートラインアイテム属性セクションからの構成は無視されます。カートラインアイテムテンプレート変数セクションでマッピングされたテンプレート変数を使用できます。詳細については、コネクターテンプレートについてを参照してください。
注文ID	購入された注文のIDです。
通貨	購入の通貨コードです。
合計価値	購入の合計価値です。
注文属性	インタラクションタイプセクションで選択されたタイプが注文インタラクションでない場合、このセクションは無視されます。注文属性は注文オブジェクトにメタデータとして保存されるキーと値のペアです。これらの属性はプラットフォームで定義する必要があります。使用例については、Salesforce Interaction Studio Event APIのドキュメントを参照してください。ネストされたオブジェクトのサポートが必要な場合、テンプレートセクションを使用してテンプレートを定義できます。テンプレートは、一致する二重中括弧で参照される名前でマッピングする必要があります：`{{template_name}}`。
カタログオブジェクトID	カタログオブジェクトを表す一意のIDです。
カタログオブジェクトタイプ	カタログオブジェクトを表すタイプです。
通貨	購入のオプション通貨コードです。nullの場合は、構成されたデータセットの通貨がデフォルトになります。

| 価格 | ラインアイテムのカタログオブジェクトの価格。 | | 数量 | ラインアイテムのカタログオブジェクトの数。 | | 注文ラインアイテム属性 | インタラクションタイプセクションで選択されたタイプが注文インタラクションでない場合、このセクションは無視されます。
注文ラインアイテム属性は、ラインアイテムオブジェクトにメタデータとして保存されるキーバリューペアです。これらの属性はプラットフォームで定義する必要があります。オブジェクト構造については、Salesforce Interaction Studio Event APIのドキュメントを参照してください。
複数のアイテムを追加するために配列タイプの属性を提供します。配列タイプの属性は同じ長さでなければなりません。
注文ラインアイテム属性の配列と注文ラインアイテムの配列は同じ長さでなければなりません。
単一値の属性を使用でき、各アイテムに適用されます。 | | 注文ラインアイテムテンプレート変数 | 注文ラインアイテムテンプレートのデータ入力としてテンプレート変数を提供します。
詳細と使用例については、コネクターテンプレート変数を参照してください。
ドット表記を使用してネストされたテンプレート変数を名付けます。例えば、items.name。
ネストされたテンプレート変数は通常、データレイヤーリスト属性から構築されます。 | | 注文ラインアイテムテンプレート | インタラクションタイプセクションで選択されたタイプが注文インタラクションでない場合、このセクションは無視されます。
ネストされたオブジェクトのサポートが必要な場合、このセクションを使用してテンプレートを定義します。
テンプレートはJSON配列形式を期待しています。
テンプレートが定義されると、注文ラインアイテムおよび注文ラインアイテム属性セクションの構成は無視されます。
注文ラインアイテムテンプレート変数セクションでマッピングされたテンプレート変数を使用できます。
詳細については、コネクターテンプレートについてを参照してください。 | | 提供者 | 同意提供者。 | | 目的 | 同意の目的。例えば、パーソナライゼーション。 | | 状態 | 同意の状態。例えば、OptInまたはOptOut。 | | テストメッセージ | キャンペーンが返されるべきでないルールを無視してイベントで強制的に返されるキャンペーン体験IDのコンマ区切りリスト。または、すべてのキャンペーンをテストモードで返すために真の文字列値を使用することもできますが、すべてのルールが尊重されます。 | | キャンペーンなし | trueの場合、レスポンスにキャンペーンを返さない。 | | 非インタラクティブ | trueの場合、指定されたユーザーのイベントに訪問は作成（または更新）されず、ユーザーに対して訪問リファラーや起源リファラーも作成されない。 | | アプリケーション | イベントの発生源となるアプリケーションレベルのソース。例えば、ReactApp、3rdParty、ReactNative。 | | チャネル | イベントの発生源。例えば、Web、MobileApp、CallCenter。 | | クライアントIP | イベントを送信するIPアドレス。clientIpは自動的に構成されるが、必要に応じて上書きすることができる。 | | コンフィグバージョン | SDKの構成のバージョン番号。 | | コンテンツゾーン | 現在のページのコンテンツゾーンの配列。 | | デバイス | モバイルイベントにのみ適用される。 | | ロケール | 現在のページのロケール。ISO 639のアルファ2言語コードとISO 3166のアルファ2国コードによって定義される。例えば、en_US と de_DE。 | | オペレーティングシステム | モバイルイベントにのみ適用されます。 | | オペレーティングシステムのバージョン | モバイルイベントにのみ適用されます。 | | ページタイプ | イベントを送信するページのタイプです。例えば、PDP、ブログ、プライシングなどです。 | | サーベイID | 提出されるサーベイのIDです。Survey Gearを通じて送信されるイベントに対して自動的に構成されます。 | | サーベイ開始時間 | 提出されるサーベイの開始時間です。Survey Gearを通じて送信されるイベントに対して自動的に構成されます。 | | URL | イベントを送信するページのURLです。 | | URLリファラー | ユーザーが訪れた前のURLです。urlReferrerはデフォルトでウェブ上のdocument.referrerから取得されますが、必要に応じてサイトマップで他の値に上書きすることができます。 | | ユーザーエージェント | イベントのユーザーエージェントです。userAgentは自動的に取得されますが、必要に応じて上書きすることができます。 | | 匿名ID | 匿名ユーザーのIDです。 | | 暗号化ID | IDフィールドを含むイベントから返される暗号化ID。暗号化IDは、IDを提供するイベントへの応答で返されます。 | | ユーザーID | ユーザーIDは、ユーザーのID情報として保存されるキーと値のペアです。
使用例については、Salesforce Interaction Studio Event API のドキュメントを参照してください。 | | ユーザー属性 | ユーザー属性は、ユーザーに関するメタデータとして保存されるキーと値のペアです。これらの属性はプラットフォームで定義する必要があります。
使用例については、Salesforce Interaction Studio Event API のドキュメントを参照してください。
ネストされたオブジェクトのサポートが必要な場合は、テンプレートセクションでテンプレートを定義できます。テンプレートは、一致する二重中括弧で名前を参照してマッピングする必要があります：{{template_name}}。 | | プロファイルオブジェクトテンプレート変数 | プロファイルオブジェクトテンプレートのデータ入力としてテンプレート変数を提供します。
詳細と使用例については、コネクターテンプレート変数を参照してください。
ドット表記を使用してネストされたテンプレート変数に名前を付けます。例えば、items.name。
ネストされたテンプレート変数は通常、データレイヤーリスト属性から構築されます。 | | プロファイルオブジェクトテンプレート | ユーザーに関するメタデータとして保存されるプロファイルオブジェクトのキーと値のペアを送信するためのテンプレートを提供します。
プロファイルオブジェクト、その属性、および関連するカタログオブジェクトはプラットフォームで定義する必要があります。使用例については、Salesforce Interaction Studio Event API のドキュメントを参照してください。
テンプレートは有効なJSONオブジェクト形式を期待しています。
プロファイルオブジェクトテンプレート変数セクションでマッピングされたテンプレート変数を使用できます。
詳細については、コネクターテンプレートについてを参照してください。 | | ID | アカウントのIDです。 | | アカウント属性 | アカウント属性は、アカウントに関するメタデータとして保存されるキーと値のペアです。これらの属性はプラットフォームで定義する必要があります。
使用例については、Salesforce Interaction Studio Event API のドキュメントを参照してください。
ネストされたオブジェクトのサポートが必要な場合は、テンプレートセクションでテンプレートを定義できます。テンプレートは、一致する二重中括弧で名前を参照してマッピングする必要があります：{{template_name}}。 | | ネットワーク時間 | 前回のリクエストが返されるまでの時間（ミリ秒）。 | | ページ読み込み時間 | DOMが読み込まれるまでの時間（ミリ秒）。 | | SDK 読み込み時間 | Web SDKを読み込むのにかかる時間（ミリ秒）。 | | SDK 解析時間 | ページ読み込み中にビーコンが解析される時間（ミリ秒）。 | | CampaignStat 配列テンプレート変数 | CampaignStat 配列テンプレート用のテンプレート変数をデータ入力として提供します。
CampaignStat 配列テンプレート用のテンプレート変数をデータ入力として提供します。
詳細と使用例については、コネクターテンプレート変数を参照してください。
ドット表記を使用してネストされたテンプレート変数を命名します。例えば、items.name。
ネストされたテンプレート変数は通常、データレイヤーリスト属性から構築されます。 | | CampaignStat 配列テンプレート | 関連イベントのキャンペーン統計を追跡するために使用される campaignStats 配列を送信するテンプレートを提供します。Salesforce Interaction Studio Event API のドキュメントを参照して使用例を確認してください。
このテンプレートは有効なJSON配列形式を期待しています。
CampaignStat 配列テンプレート変数セクションでマップされたテンプレート変数を使用できます。
テンプレートについての詳細は、テンプレートガイドのドキュメントを参照してください。 | | テンプレート変数 | テンプレート用のテンプレート変数をデータ入力として提供します。
テンプレート変数ガイドのドキュメントを参照して使用例を確認してください。
ドット表記を使用してネストされたテンプレート変数を命名します。例えば、items.name。
ネストされたテンプレート変数は通常、データレイヤーリスト属性から構築されます。 | | テンプレート | イベントデータ、カタログオブジェクトデータ、カタログオブジェクト属性、カートデータ、注文データ、注文属性、デバッグ、フラグ、ソース、ユーザーデータ、ユーザー属性、アカウントデータ、アカウント属性、パフォーマンスメトリクスセクションで参照されるテンプレートを提供します。
このテンプレートは有効なJSONオブジェクト形式を期待しています。
詳細については、コネクターテンプレートについてを参照してください。
テンプレートは、サポートされるフィールドに名前で二重中括弧を使用して注入されます。例えば、{{SomeTemplateName}}。 |

アクション — 信頼できるチャネルを通じてイベントデータを送信する (Evergage 名前空間)

パラメータ

パラメータ	説明
アイテムアクション	カタログアイテムに対して行われたアクションを選択します。サポートされているアイテムアクションについては、Salesforce Interaction StudioのEvent API Item Actionsドキュメントを参照してください。
アクション	イベントの名前。セグメンテーション、ターゲティング、レポーティングに使用されます。
アイテムタイプ	必須。`catalog`オブジェクトを送信するアイテムのタイプを指定してください。
アイテムタイプ	必須。`order`オブジェクトを送信するアイテムのタイプを指定してください。
オーダーID	購入されたオーダーのIDです。
通貨	購入の通貨コード。nullの場合はデータセットで構成された通貨がデフォルトです。
合計値	購入の合計値。デフォルトでは、ラインアイテムの数量 * 価格の合計です。
ID	アイテムのIDです。
価格	商品の価格。
数量	商品の数。
アイテムタイプ	必須。`cart`オブジェクトに送信するアイテムのタイプを指定してください。
ID	アイテムのID。
価格	商品の価格。
数量	商品の数。
プロバイダ	同意プロバイダ。
目的	同意の目的。例えば、パーソナライゼーション。
ステータス	同意のステータス。例えば、オプトインまたはオプトアウト。
説明	`true`の場合、キャンペーンが表示されたか表示されなかったかの理由について、応答で追加情報を返します。
テストメッセージ	キャンペーンが返されるのを通常防ぐルールを無視して、イベントで強制的に返すキャンペーン体験IDのカンマ区切りリスト。または、すべてのキャンペーンをテストモードで返すために真の文字列値を使用することもできますが、すべてのルールが尊重されます。
トラッキング禁止	`true`の場合、イベントがサーバーに送信された後、処理しない。
キャンペーンなし	`true`の場合、レスポンスでキャンペーンを返さない。
非インタラクティブ	`true`の場合、指定されたユーザーの訪問は作成（または更新）されず、ユーザーに対して訪問リファラーや起源リファラーも作成されません。
ページビュー	`true`の場合、イベントがページロードからトリガーされたことを示します。
アプリケーション	イベントの発生源となるアプリケーションレベルのソース。例えば、ReactApp、3rdParty、ReactNative。
チャネル	イベントの発生源。例えば、Web、MobileApp、CallCenter。
クライアントIP	イベントを送信するIPアドレス。`clientIp`は自動的に入力されますが、必要に応じて上書きすることができます。
構成バージョン	SDKの構成のバージョン番号。
コンテンツゾーン	現在のページのコンテンツゾーンの配列。
デバイス	モバイルイベントにのみ適用されます。
ロケール	現在のページのロケールは、ISO 639 アルファ-2 言語コードと ISO 3166 アルファ-2 国コードによって定義されます。例えば、en_US や de_DE などです。
オペレーティングシステム	モバイルイベントにのみ適用されます。
オペレーティングシステムバージョン	モバイルイベントにのみ適用されます。
ページタイプ	イベントを送信するページのタイプです。例えば、PDP、Blog、Pricing などです。
サーベイID	提出されるサーベイのIDです。Survey Gearを通じて送信されるイベントに自動的に構成されます。
サーベイ開始時間	提出されるサーベイの開始時間です。Survey Gearを通じて送信されるイベントに自動的に構成されます。
時間	イベントの日時で、UNIXエポックから経過したミリ秒で表されます。このフィールドはオプションで、nullの場合は現在の時間で自動的に入力されます。
URL	イベントを送信するページのURLです。
URLリファラー	ユーザーが訪れた前のURLです。`urlReferrer`はデフォルトでウェブ上の`document.referrer`から取得されます。必要に応じてサイトマップで他の値に上書きすることができます。
User Agent	イベントのユーザーエージェント。`userAgent`は自動的に構成されますが、必要に応じて上書きすることができます。
Encrypted ID	IDフィールドを含むイベントから返される暗号化されたID。暗号化されたIDは、`user.id`を提供するイベントへの応答で返されます。
ID	既知のユーザーのID。
User Attributes	ユーザー属性は、ユーザーにメタデータとして保存されるキーバリューペアです。これらの属性はプラットフォームで定義する必要があります。使用例については、Salesforce Interaction Studio Event API のドキュメントを参照してください。ネストされたオブジェクトのサポートが必要な場合は、テンプレートセクションでテンプレートを定義できます。テンプレートは、一致する二重中括弧で名前を参照してマッピングする必要があります：`{{template_name}}`。
Profile Objects Template Variables	プロファイルオブジェクトテンプレートのデータ入力としてテンプレート変数を提供します。詳細と使用例については、コネクターテンプレート変数を参照してください。ドット表記を使用してネストされたテンプレート変数に名前を付けます。例えば、`items.name`。ネストされたテンプレート変数は通常、データレイヤーリスト属性から構築されます。
Profile Objects Template	ユーザーにメタデータとして保存されるプロファイルオブジェクトのキーバリューペアのテンプレートを提供します。プロファイルオブジェクト、その属性、および関連するカタログオブジェクトはプラットフォームで定義する必要があります。使用例については、Salesforce Interaction Studio Event API のドキュメントを参照してください。テンプレートは有効なJSONオブジェクト形式を期待しています。プロファイルオブジェクトテンプレート変数セクションでマッピングされたテンプレート変数を使用できます。詳細については、コネクターテンプレートについてを参照してください。
ID	アカウントのID。
Account Attributes	アカウント属性は、アカウントにメタデータとして保存されるキーバリューペアです。これらの属性はプラットフォームで定義する必要があります。使用例については、Salesforce Interaction Studio Event API のドキュメントを参照してください。ネストされたオブジェクトのサポートが必要な場合は、テンプレートセクションでテンプレートを定義できます。テンプレートは、一致する二重中括弧で名前を参照してマッピングする必要があります：`{{template_name}}`。
DOM Load Time	DOMが完全にロードされるまでの時間（ミリ秒）。
Event DNS Time	アカウント固有のドメインを解決するまでの時間（ミリ秒）。
Network Time	前のリクエストが返されるまでの時間（ミリ秒）。
ページ読み込み時間	DOMが読み込まれるまでの時間（ミリ秒）。
SDK DNS 時間	SDKのCDNドメインの解決にかかる時間（ミリ秒）。
SDK 読み込み時間	Web SDKをネットワークが読み込むまでの時間（ミリ秒）。
SDK 解析時間	ページ読み込み中にビーコンが解析されるまでの時間（ミリ秒）。
CampaignStat 配列テンプレート変数	CampaignStat 配列テンプレートにデータ入力としてテンプレート変数を提供します。詳細と使用例については、コネクターテンプレート変数を参照してください。例えば、`items.name`のようにドット表記でネストされたテンプレート変数を命名します。ネストされたテンプレート変数は通常、データレイヤーリスト属性から構築されます。
CampaignStat 配列テンプレート	関連イベントのキャンペーン統計を追跡するために使用されるcampaignStats配列を送信するテンプレートを提供します。Salesforce Interaction Studio Event APIのドキュメントで使用例を参照してください。テンプレートは有効なJSON配列形式を期待しています。 CampaignStat 配列テンプレート変数セクションでマッピングされたテンプレート変数を使用できます。テンプレートについての詳細は、テンプレートガイドのドキュメントを参照してください。
テンプレート変数	テンプレートにデータ入力としてテンプレート変数を提供します。使用例については、テンプレート変数ガイドのドキュメントを参照してください。例えば、`items.name`のようにドット表記でネストされたテンプレート変数を命名します。ネストされたテンプレート変数は通常、データレイヤーリスト属性から構築されます。
テンプレート	イベントデータ、カタログデータ、注文データ、カートデータ、デバッグ、フラグ、ソース、ユーザーデータ、ユーザー属性、アカウントデータ、アカウント属性、およびパフォーマンスセクションで参照されるテンプレートを提供します。テンプレートは有効なJSONオブジェクト形式を期待しています。詳細については、コネクターテンプレートについてを参照してください。テンプレートは、例えば`{{SomeTemplateName}}`のように、サポートされるフィールドに名前で注入されます。