Algolia Insights コネクタ構成ガイド
この記事では、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 。 |
イベント名 | (必須)特定のイベントの名前。 |
インデックス | (必須)インデックス名。イベントはAlgoliaインデックスのアイテムに関連しています。 |
ユーザートークン | (必須)擬似的または匿名のユーザー識別子。 |
タイムスタンプ | イベントの時間をUnixエポック時間のミリ秒で表します。デフォルトでは、Algolia Insights APIはイベントを受け取った時間をタイムスタンプとして使用します。このフィールドがマッピングされていない場合、現在のタイムスタンプで初期化されます。Algolia Insights APIは、過去4日間のイベントを受け付けます。
|
クエリID | 検索クエリの一意の識別子。queryID は、検索またはブラウズリクエストに関連するイベントに必要です。 |
オブジェクトID | Algoliaインデックスのアイテムのオブジェクト識別子の配列。最大20のオブジェクトIDを含めることができます。 |
フィルター | 次の形式のファセットフィルターの配列:${attribute}:${value} 。例:brand:apple 。最大10のフィルターを含めることができます。 |
ポジション | 検索結果でクリックされたオブジェクトの位置。このプロパティは、クエリIDを持つクリックイベントに必要です。オブジェクトIDごとに1つの位置を提供する必要があります。Algoliaはこのパラメータを使用して平均クリック位置を計算します。位置は絶対的であり、結果ページに対して相対的ではありません。 |
イベントの送信(バッチ)
パラメータ
パラメータ | 説明 |
---|---|
イベントタイプ | イベントタイプ:click 、conversion 、またはview 。 |
イベント名 | (必須)特定のイベントの名前。 |
インデックス | (必須)インデックス名。イベントはAlgoliaインデックスのアイテムに関連しています。 |
ユーザートークン | (必須)擬似的または匿名のユーザー識別子。 |
タイムスタンプ | イベントの時間をUnixエポック時間のミリ秒で表します。デフォルトでは、Algolia Insights APIはイベントを受け取った時間をタイムスタンプとして使用します。このフィールドがマッピングされていない場合、現在のタイムスタンプで初期化されます。Algolia Insights APIは、過去4日間のイベントを受け付けます。
|
クエリID | 検索クエリの一意の識別子。queryID は、検索またはブラウズリクエストに関連するイベントに必要です。 |
オブジェクトID | Algoliaインデックスのアイテムのオブジェクト識別子の配列。最大20のオブジェクトIDを含めることができます。 |
フィルター | 次の形式のファセットフィルターの配列:${attribute}:${value} 。例:brand:apple 。最大10のフィルターを含めることができます。 |
ポジション | 検索結果でクリックされたオブジェクトの位置。このプロパティは、クエリIDを持つクリックイベントに必要です。オブジェクトIDごとに1つの位置を提供する必要があります。Algoliaはこのパラメータを使用して平均クリック位置を計算します。位置は絶対的であり、結果ページに対して相対的ではありません。 |
最終更新日 :: 2024年March月29日