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

API情報

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

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

バッチ制限

このコネクタは、ベンダーへの大量のデータ転送をサポートするためにバッチリクエストを使用します。詳細については、バッチアクションを参照してください。リクエストは、以下のいずれかの閾値が達成されるか、プロファイルが公開されるまでキューに入れられます：

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

コネクタアクション

アクション名	AudienceStream	EventStream
イベントの送信（リアルタイム）	✗	✓
イベントの送信（バッチ）	✗	✓

構成の構成

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

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

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

アクション

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

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

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

パラメータ

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

イベントパラメータ

イベントは、1つ以上のオブジェクトIDまたは1つ以上のフィルターを含む必要があります。また、単一のイベントにはオブジェクトIDとフィルターの両方を含めないでください。

パラメータ	説明
イベント名	（必須）特定のイベントの名前。フォーマットは1-64のASCII文字で、制御文字を除きます。イベントの影響を最大化するためには、一貫したイベント名と一貫したフォーマットを使用する必要があります。
値	イベントの金額、通貨で測定します。例えば、購入の合計金額。
通貨	`objectData`パラメータに価格情報を含めるか、値を提供する場合、ISO 4217通貨コード（`USD`や`EUR`など）で通貨を指定する必要があります。
インデックス	（必須）インデックス名。イベントは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`パラメータに価格情報を含めるか、値を提供する場合、ISO 4217通貨コード（`USD`や`EUR`など）で通貨を指定する必要があります。
インデックス	（必須）インデックス名。イベントは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。異なる検索から来る複数のアイテムの購入イベントを追跡するために使用されます。
価格	アイテムの価格。これは最終価格であり、適用される任意の割引を含むべきです。
割引	このオブジェクトに対して適用される割引の絶対値、通貨で測定します。
数量	購入されたアイテムまたはカートに追加されたアイテムの数量。購入の合計値は、各購入アイテムの価格と数量の積の合計です。
価格	商品の価格。これは、適用されるすべての割引を含む最終価格であるべきです。
割引	このオブジェクトに適用される割引の絶対値、通貨で測定。
数量	購入されたまたはカートに追加された商品の数量。購入の総額は、購入された各商品の価格と数量を掛けた合計です。