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

API情報

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

API名：Coveo API
APIバージョン：v15
APIエンドポイント：https://analytics.cloud.coveo.com
ドキュメント：Coveo API

コネクタアクション

アクション名	AudienceStream	EventStream
POST経由でビューイベントを記録	✗	✓
POST経由で検索イベントを記録	✗	✓
POST経由で検索イベントバッチを記録	✗	✓
POST経由でカスタムイベントを記録	✗	✓
POST経由でクリックイベントを記録	✗	✓

構成の構成

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

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

APIキー
必須：Coveo APIキー。

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

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

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

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

アクション — POST経由でビューイベントを記録

パラメータ

パラメータ	説明
言語	(必須) 最終ユーザーの言語。有効なISO 639-1言語コードである必要があります。
場所	(必須) 閲覧されたページまたはコンポーネントのURL。例えば、`document.location.href`。
匿名	検索インターフェースがイベントを記録するトリガーとなったインタラクションが匿名ユーザーによって引き起こされたかどうか。利用可能な値は：`true`および`false`。
クライアントID
コンテンツIDキー
コンテンツID値
コンテンツタイプ
起源コンテキスト
起源レベル1
起源レベル2
起源レベル3
結果	イベントの品質を示す指標。`-5`の値は最悪の結果に対応し、の値は中立的な結果に対応し、`5`の値は最良の結果に対応します。
リファラー
スプリットテスト実行名
スプリットテスト実行バージョン
タイトル
ユーザーエージェント
ユーザー表示名
ユーザー名
カスタムデータ	ユーザー定義の次元とその値。キーは英数字またはアンダースコアのみを含むことができます。キー内の空白はアンダースコアに変換されます。キー内の大文字は小文字に変換されます。値は有効なJSONであることができます。値はCoveo使用分析に渡される際に文字列データタイプに変換されます。カスタムデータを追加する前にカスタム次元を作成することを強くお勧めします。
カスタムデータテンプレート変数	データ入力としてテンプレート変数を提供します。詳細については、コネクターテンプレート変数を参照してください。例えば、`items.name`のようにドット表記でネストされたテンプレート変数を名前付けします。ネストされたテンプレート変数は通常、データレイヤーリスト属性から構築されます。
カスタムデータテンプレート	カスタムデータで参照されるテンプレートを提供します。詳細については、コネクターテンプレートについてを参照してください。テンプレートはサポートされているフィールドに名前で二重中括弧で注入されます。例えば、`{{SomeTemplateName}}`。

アクション — POST経由で検索イベントを記録

パラメータ

パラメータ	説明
アクション原因	(必須) このイベントをトリガーした操作のタイプ。
言語	(必須) 最終ユーザーの言語。有効なISO 639-1言語コードである必要があります。
クエリテキスト	(必須) 対応する検索リクエストでの元の基本クエリ式（`q`）。
応答時間	(必須) 検索インターフェースが検索イベントを記録する原因となったクエリがSearch APIに送信された瞬間からSearch APIが結果を返した瞬間までの時間（ミリ秒）。ゼロより大きい必要があります。
検索クエリUID	(必須) 検索インターフェースが検索イベントを記録する原因となったイベントの一意の識別子。対応する検索リクエストの応答でSearch APIから得られた検索クエリUIDを使用することをお勧めします。または、36文字以下の任意のUUID v4を使用します。36文字を超えるUUIDはサービスによって切り捨てられます。
高度なクエリ
匿名	検索インターフェースがイベントを記録するトリガーとなったインタラクションが匿名ユーザーによって引き起こされたかどうか。利用可能な値は：`true`および`false`。
クライアントID
文脈的	クエリが文脈的フィルターによって変更されるかどうかを示します。例えば、類似アイテムを見つけるためのクエリ。利用可能な値は`true`および`false`。
インデックスID
結果数	検索インターフェースが検索イベントを記録する原因となったクエリによって返された結果の数。ゼロ以上である必要があります。
起源コンテキスト	イベントの起源。ユーザーが実行したアクションの元のコンテキストを指定するために使用される値。提案される値：`Search`、`InternalSearch`、`CommunitySearch`、または`originLevel1`の値。
起源レベル1
起源レベル2
起源レベル3
結果	イベントの品質を示す指標。`-5`の値は最悪の結果に対応し、5の値は最良の結果に対応します。
クエリパイプライン
スプリットテスト実行名
スプリットテスト実行バージョン
ユーザーエージェント
ユーザー表示名
ユーザー名
ファセットタイプ	(必須) ファセットのデータタイプ。
フィールド	(必須) ファセットフィールド。
ID	(必須) 検索インターフェース内のファセットの一意の識別子。次の文字セットに一致する必要があります：`^[a-zA-Z0-9@-_]{1,60}$`。
状態	(必須) ファセットのアクションタイプ。利用可能な値は：`auto_selected`、`selected`、および`excluded`。
値	(必須) ファセット値の名前。
表示値	ファセット値の表示名。
ファセット位置	ファセットの1ベースの位置。
タイトル	ファセットのタイトル。
値の位置	ファセット内の値の1ベースの位置。
ユーザーグループ	イベントを実行する最終ユーザーが所属するグループ。リクエストが検索トークンで認証されている場合、サービスはまた、ログ検索イベントリクエストを認証したアクセストークンからuserGroups値を抽出し、それらのグループをログとして記録しようとします。
カスタムデータ	ユーザー定義の次元とその値。キーは英数字またはアンダースコアのみを含むことができます。キー内の空白はアンダースコアに変換されます。キー内の大文字は小文字に変換されます。値は有効なJSONであることができます。値はCoveo使用分析に渡される際に文字列データタイプに変換されます。カスタムデータを追加する前にカスタム次元を作成することを強くお勧めします。
カスタムデータテンプレート変数	データ入力としてテンプレート変数を提供します。詳細については、コネクターテンプレート変数を参照してください。例えば、`items.name`のようにドット表記でネストされたテンプレート変数を名前付けします。ネストされたテンプレート変数は通常、データレイヤーリスト属性から構築されます。
カスタムデータテンプレート	カスタムデータで参照されるテンプレートを提供します。詳細については、コネクターテンプレートについてを参照してください。テンプレートはサポートされているフィールドに名前で二重中括弧で注入されます。例えば、`{{SomeTemplateName}}`。

アクション — POST経由で検索イベントバッチを記録

バッチ制限

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

最大リクエスト数：10000
最古のリクエストからの最大時間：60分
リクエストの最大サイズ：100 MB

パラメータ

パラメータ	説明
アクション原因	(必須) このイベントをトリガーした操作のタイプ。
言語	(必須) エンドユーザーの言語。有効なISO 639-1言語コードである必要があります。
クエリテキスト	(必須) 対応する検索リクエストの基本的なクエリ式 (`q`)。
応答時間	(必須) 検索インターフェースが検索イベントを記録する原因となったクエリがSearch APIに送信されてから、Search APIが結果を返すまでの時間（ミリ秒）。ゼロより大きい必要があります。
検索クエリUID	(必須) 検索インターフェースが検索イベントを記録する原因となったイベントの一意識別子。対応する検索リクエストの応答で検索クエリUID を使用することをお勧めします。または、36文字以下の任意のUUID v4を使用します。36文字を超えるUUIDはサービスによって切り捨てられます。
高度なクエリ
匿名	検索インターフェースがイベントを記録する原因となったインタラクションが匿名ユーザーによってトリガーされたかどうか。利用可能な値は：`true` および `false`。
クライアントID
文脈的	クエリが文脈的フィルターによって変更されているかどうかを示します。例えば、類似アイテムを見つけるクエリなど。利用可能な値は：`true` および `false`。
インデックスID
結果数	検索インターフェースが検索イベントを記録する原因となったクエリによって返された結果の数。ゼロ以上である必要があります。
起源コンテキスト	イベントの起源。この値は、ユーザーが実行したアクションの元のコンテキストを指定するために使用されます。推奨される値：`Search`、`InternalSearch`、`CommunitySearch`、または `originLevel1` の値。
起源レベル1
起源レベル2
起源レベル3
結果	イベントの品質を示す指標。`-5` の値は最悪の結果に対応し、中立的な結果に対応し、`5` の値は最良の結果に対応します。
クエリパイプライン
スプリットテスト実行名
スプリットテスト実行バージョン
ユーザーエージェント
ユーザー表示名
ユーザー名
ファセットタイプ	(必須) ファセットのデータタイプ。
フィールド	(必須) ファセットフィールド。
ID	(必須) 検索インターフェースのファセットの一意識別子。文字セット `^[a-zA-Z0-9@-_]{1,60}$` に一致する必要があります。
状態	(必須) ファセットのアクションタイプ。利用可能な値は：`auto_selected`, `selected`, および `excluded`。
値	(必須) ファセット値の名前。
表示値	ファセット値の表示名。
ファセット位置	ファセットの1ベースの位置。
タイトル	ファセットのタイトル。
値の位置	ファセット内の値の1ベースの位置。
ユーザーグループ	イベントを実行するエンドユーザーが所属するグループ。リクエストが検索トークンで認証されている場合、サービスはログ検索イベントリクエストを認証したアクセストークンから userGroups の値を抽出し、それらのグループも記録します。
カスタムデータ	ユーザー定義の次元とその値。キーは英数字またはアンダースコアのみを含むことができます。キーの空白はアンダースコアに変換されます。キーの大文字は小文字に変換されます。値は有効なJSONである可能性があります。値はCoveo使用分析に渡される際に文字列データタイプに変換されます。カスタムデータを追加する前にカスタム次元を作成することを強くお勧めします。
カスタムデータテンプレート変数	データ入力としてテンプレート変数を提供します。詳細については、コネクターテンプレート変数を参照してください。ドット表記でネストされたテンプレート変数を名前付けします。例えば、`items.name`。ネストされたテンプレート変数は通常、データレイヤーリスト属性から構築されます。
カスタムデータテンプレート	カスタムデータで参照されるテンプレートを提供します。詳細については、コネクターテンプレートについてを参照してください。テンプレートはサポートされているフィールドに名前で二重中括弧で注入されます。例えば、`{{SomeTemplateName}}`。

アクション — POST経由でカスタムイベントを記録

パラメータ

パラメータ	説明
イベントタイプ	(必須) カスタムイベントのタイプ。
イベント値	(必須) カスタムイベントの値。
言語	(必須) エンドユーザーの言語。有効なISO 639-1言語コードである必要があります。
匿名	検索インターフェースがイベントを記録する原因となったインタラクションが匿名ユーザーによってトリガーされたかどうか。利用可能な値は：`true` および `false`。
クライアントID
最後の検索クエリUID
起源コンテキスト
起源レベル1
起源レベル2
起源レベル3
結果	イベントの品質を示す指標。`-5` の値は最悪の結果に対応し、中立的な結果に対応し、`5` の値は最良の結果に対応します。
スプリットテスト実行名
スプリットテスト実行バージョン
ユーザーエージェント
ユーザー表示名
ユーザー名
カスタムデータ	ユーザー定義の次元とその値。キーは英数字またはアンダースコアのみを含むことができます。キーの空白はアンダースコアに変換されます。キーの大文字は小文字に変換されます。値は有効なJSONである可能性があります。値はCoveo使用分析に渡される際に文字列データタイプに変換されます。カスタムデータを追加する前にカスタム次元を作成することを強くお勧めします。
カスタムデータテンプレート変数	データ入力としてテンプレート変数を提供します。詳細については、コネクターテンプレート変数を参照してください。ドット表記でネストされたテンプレート変数を名前付けします。例えば、`items.name`。ネストされたテンプレート変数は通常、データレイヤーリスト属性から構築されます。
カスタムデータテンプレート	カスタムデータで参照されるテンプレートを提供します。詳細については、コネクターテンプレートについてを参照してください。テンプレートはサポートされているフィールドに名前で二重中括弧で注入されます。例えば、`{{SomeTemplateName}}`。

アクション — POST経由でクリックイベントを記録

パラメータ

パラメータ	説明
アクション原因	(必須) このイベントをトリガーした操作のタイプ。
ドキュメント位置	(必須) 結果リストでクリックされたアイテムの1ベースのインデックス位置。この番号はページネーション構成を考慮する必要があります。各ページに10個の結果が含まれている場合、2ページ目の3番目のアイテムは位置23にあります。
ドキュメントURI	(必須) クリックされたアイテムの `@uri`。
ドキュメントURIハッシュ	(必須) クリックされたアイテムの `@urihash`。
言語	(必須) エンドユーザーの言語。有効なISO 639-1言語コードである必要があります。
検索クエリUID	(必須) 検索インターフェースが検索イベントを記録するために導いたイベントの一意の識別子。対応する検索リクエストの応答で検索クエリUID を使用することをお勧めします。または、36文字以下の任意のUUID v4を使用します。36文字を超えるUUIDはサービスによって切り捨てられます。
ソース名	(必須) クリックされたアイテムの `@source`。
匿名	検索インターフェースがイベントを記録した際にトリガーされたインタラクションが匿名ユーザーによるものかどうか。利用可能な値は：`true` と `false`。
クライアントID
コレクション名
ドキュメント著者
ドキュメントカテゴリ
ドキュメントタイトル
ドキュメントURL
起源コンテキスト
起源レベル1
起源レベル2
起源レベル3
結果	イベントの品質を示す指標。`-5` の値は最悪の結果に対応し、中立的な結果に対応する値、`5` の値は最良の結果に対応します。
クエリパイプライン
ランキング修正
スプリットテスト実行名
スプリットテスト実行バージョン
ユーザーエージェント
ユーザー表示名
ユーザー名
カスタムデータ	ユーザー定義の次元とその値。キーは英数字またはアンダースコアのみを含むことができます。キーの空白はアンダースコアに変換されます。キーの大文字は小文字に変換されます。値は有効なJSONであることができます。値はCoveo使用分析に渡される際に文字列データ型に変換されます。カスタムデータを追加する前にカスタム次元を作成することを強くお勧めします。
カスタムデータテンプレート変数	データ入力としてテンプレート変数を提供します。詳細については、コネクターテンプレート変数を参照してください。ドット表記でネストされたテンプレート変数に名前を付けます。例えば、`items.name`。ネストされたテンプレート変数は通常、データレイヤーリスト属性から構築されます。
カスタムデータテンプレート	カスタムデータで参照されるテンプレートを提供します。詳細については、コネクターテンプレートについてを参照してください。テンプレートは名前で二重中括弧によってサポートされるフィールドに注入されます。例えば、`{{SomeTemplateName}}`。