Algolia Insightsコネクター構成ガイド

API情報

このコネクターでは、次のベンダーAPIを使用します。

API名：Algolia Insights API
APIバージョン：v1
APIエンドポイント：https://insights.algolia.io/1/events
ドキュメント：Algolia Insights API

バッチ処理の上限

このコネクターでは、ベンダーへの大容量データ転送に対応するため、リクエストをバッチ処理します。詳細については、バッチアクションを参照してください。次のいずれかのしきい値に達するか、プロファイルがパブリッシュされるまで、リクエストはキューに保持されます。

リクエストの最大数：1000
最も古いリクエストからの最大経過時間：5分
リクエストの最大サイズ：2 MB

コネクターアクション

アクション名	訪問プロファイル	イベントデータ
イベントを送信（リアルタイム）	✗	✓
イベントを送信（バッチ）	✗	✓

構成

コネクターマーケットプレイスに移動し、新しいコネクターを追加します。詳細については、コネクタについてを参照してください。

コネクターを追加したら、次の項目を構成します。

APIキー
（必須）検索のアクセス制御リスト権限を持つAPIキー。
アプリケーションID
（必須）AlgoliaのアプリケーションID。

アクション

アクションの名前を入力し、ドロップダウンメニューからアクションタイプを選択します。

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

イベントを送信（リアルタイム）

パラメーター

パラメーター	説明
イベントタイプ	イベントタイプ：`click`、`conversion`、または`view`。

イベントパラメーター

イベントには1つ以上のオブジェクトIDまたは1つ以上のフィルターを含める必要があります。1つのイベントにオブジェクトIDとフィルターの両方を含めることはできません。

パラメーター	説明
イベント名	（必須）特定のイベントの名前。制御文字を除く1～64文字のASCII文字列で指定する必要があります。イベントの効果を最大限に高めるには、一貫したイベント名と書式を使用してください。
値	通貨単位で示したイベントの金額。たとえば、購入総額です。
通貨	`objectData`パラメーターに価格情報を含めるか、値を指定する場合は、`USD`や`EUR`など、ISO 4217通貨コードで通貨も指定する必要があります。
インデックス	（必須）インデックス名。イベントはAlgoliaインデックス内のアイテムに関連付けられます。検索エンジンで使用されるインデックス名と同じ形式にする必要があります。
ユーザートークン	（必須）仮名化または匿名化されたユーザー識別子。ユーザートークンには、個人を特定できる情報を含めないでください。
タイムスタンプ	Unixエポック時間をミリ秒で表したイベント発生時刻。デフォルトでは、Algolia Insights APIはイベントを受信した時刻をタイムスタンプとして使用します。このフィールドがマッピングされていない場合、現在のタイムスタンプで初期化されます。Algolia Insights APIは、過去4日以内のイベントを受け付けます。リアルタイムではないイベント（バックエンド検索など）を送信する場合は、正しいタイムスタンプを構成してください。バッチイベントでタイムスタンプを指定しない場合、すべてのイベントに同じタイムスタンプが構成されます。クリックイベントとコンバージョンイベントのタイムスタンプは、対応する検索リクエストまたは閲覧リクエストから1時間以内である必要があります。
クエリID	検索クエリの一意の識別子。検索リクエストまたは閲覧リクエストに関連するイベントには、`queryID`が必要です。
オブジェクトID	Algoliaインデックス内のアイテムのオブジェクト識別子を格納する配列。最大20個のオブジェクトIDを含めることができます。
フィルター	`${attribute}:${value}`形式のファセットフィルターの配列。例：`brand:apple`。最大10個のフィルターを含めることができます。
位置	検索結果内でクリックされたオブジェクトの位置。このプロパティは、クエリIDを持つクリックイベントでは必須です。各オブジェクトIDに対して位置を1つ指定する必要があります。Algoliaはこのパラメーターを使用して、平均クリック位置を計算します。位置は絶対位置であり、結果ページを基準とした相対位置ではありません。
イベントサブタイプ	イベントのサブタイプ。コンバージョンイベントの場合、値は`addToCart`または`purchase`です。それ以外のイベントでは、この値を省略します。

オブジェクトデータ

パラメーター	説明
クエリID	この特定のレコードに関連付けられたクエリのID。異なる検索から取得された複数のアイテムを含む購入イベントを追跡するために使用します。
価格	アイテムの価格。有効な割引をすべて適用した後の最終価格を指定します。
割引	このオブジェクトに適用される割引額の絶対値。通貨単位で指定します。
数量	購入された、またはカートに追加されたアイテムの数量。購入総額は、購入された各アイテムの数量に価格を乗じた値の合計です。

イベントを送信（バッチ）

パラメーター

パラメーター	説明
イベントタイプ	イベントタイプ：`click`、`conversion`、または`view`。

イベントパラメーター

パラメーター	説明
イベント名	（必須）特定のイベントの名前。制御文字を除く1～64文字のASCII文字列で指定する必要があります。イベントの効果を最大限に高めるには、一貫したイベント名と書式を使用してください。
値	通貨単位で示したイベントの金額。たとえば、購入総額です。
通貨	`objectData`パラメーターに価格情報を含めるか、値を指定する場合は、`USD`や`EUR`など、ISO 4217通貨コードで通貨も指定する必要があります。
インデックス	（必須）インデックス名。イベントはAlgoliaインデックス内のアイテムに関連付けられます。検索エンジンで使用されるインデックス名と同じ形式にする必要があります。
ユーザートークン	（必須）仮名化または匿名化されたユーザー識別子。ユーザートークンには、個人を特定できる情報を含めないでください。
タイムスタンプ	Unixエポック時間をミリ秒で表したイベント発生時刻。デフォルトでは、Algolia Insights APIはイベントを受信した時刻をタイムスタンプとして使用します。このフィールドがマッピングされていない場合、現在のタイムスタンプで初期化されます。Algolia Insights APIは、過去4日以内のイベントを受け付けます。リアルタイムではないイベント（バックエンド検索など）を送信する場合は、正しいタイムスタンプを構成してください。バッチイベントでタイムスタンプを指定しない場合、すべてのイベントに同じタイムスタンプが構成されます。クリックイベントとコンバージョンイベントのタイムスタンプは、対応する検索リクエストまたは閲覧リクエストから1時間以内である必要があります。
クエリID	検索クエリの一意の識別子。検索リクエストまたは閲覧リクエストに関連するイベントには、`queryID`が必要です。
オブジェクトID	Algoliaインデックス内のアイテムのオブジェクト識別子を格納する配列。最大20個のオブジェクトIDを含めることができます。
フィルター	`${attribute}:${value}`形式のファセットフィルターの配列。例：`brand:apple`。最大10個のフィルターを含めることができます。
位置	検索結果内でクリックされたオブジェクトの位置。このプロパティは、クエリIDを持つクリックイベントでは必須です。各オブジェクトIDに対して位置を1つ指定する必要があります。Algoliaはこのパラメーターを使用して、平均クリック位置を計算します。位置は絶対位置であり、結果ページを基準とした相対位置ではありません。
イベントサブタイプ	イベントのサブタイプ。コンバージョンイベントの場合、値は`addToCart`または`purchase`です。それ以外のイベントでは、この値を省略します。

オブジェクトデータ

パラメーター	説明
クエリ ID	この特定のレコードに関連付けられるクエリの ID。異なる検索から生じた複数の商品を含む購入イベントを追跡するために使用されます。
価格	商品の価格。有効な割引をすべて適用した最終価格を指定します。
割引	このオブジェクトに適用されている割引の絶対額。通貨単位で指定します。
数量	購入またはカートに追加された商品の数量。購入の合計金額は、購入した各商品の数量に価格を掛けた値の合計です。