この記事では、Coveoコネクタの構成方法について説明します。
API情報
このコネクタは、次のベンダーAPIを使用します。
- API名:Coveo API
- APIバージョン:v15
- APIエンドポイント:
https://analytics.cloud.coveo.com - ドキュメント:Coveo API
コネクタアクション
| アクション名 | 訪問プロファイル | イベントデータ |
|---|---|---|
| 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 が結果を返すまでの時間(ミリ秒)。0 より大きい値である必要があります。 |
| 検索クエリ UID | (必須)検索インターフェイスが検索イベントを記録する原因となったイベントの一意の識別子。Search API に対する対応する検索リクエストのレスポンスに含まれる 検索クエリ UID、または長さが 36 文字以下の任意の UUID v4 を使用することをお勧めします。36 文字を超える UUID は、サービスによって切り詰められます。 |
| 高度なクエリ | |
| 匿名 | 検索インターフェイスがイベントを記録する原因となったインタラクションが、匿名ユーザーによってトリガーされたかどうか。使用可能な値は true と false です。 |
| クライアント ID | |
| コンテキスト依存 | クエリがコンテキストフィルターによって変更されているかどうかを示します。たとえば、類似する項目を検索するクエリなどです。使用可能な値は true と false です。 |
| インデックス ID | |
| 結果数 | 検索インターフェイスが検索イベントを記録する原因となったクエリによって返された結果の数。0 以上である必要があります。 |
| オリジンコンテキスト | イベントの発生元。この値は、ユーザーが実行したアクションの元のコンテキストを指定するために使用されます。推奨値は 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 Usage Analytics に渡されるとき、値は文字列データ型に変換されます。 カスタムデータを追加する前に、カスタムディメンションを作成することを強くお勧めします。 |
| カスタムデータテンプレート変数 | データ入力としてテンプレート変数を指定します。詳細については、コネクターテンプレート変数を参照してください。 ネストされたテンプレート変数にはドット表記で名前を付けます。たとえば、 items.name です。ネストされたテンプレート変数は通常、データレイヤーのリスト属性から構築されます。 |
| カスタムデータテンプレート | カスタムデータ内で参照するテンプレートを指定します。詳細については、コネクタテンプレートについてを参照してください。 テンプレートは、二重波括弧を使用して名前でサポート対象フィールドに挿入されます。たとえば、 {{SomeTemplateName}} です。 |
アクション — POST によるカスタムイベントの記録
パラメーター
| パラメーター | 説明 |
|---|---|
| イベントタイプ | (必須)カスタムイベントのタイプ。 |
| イベント値 | (必須)カスタムイベントの値。 |
| 言語 | (必須)エンドユーザーの言語。有効な ISO 639-1 言語コードである必要があります。 |
| 匿名 | 検索インターフェイスがイベントを記録する原因となったインタラクションが、匿名ユーザーによってトリガーされたかどうか。使用可能な値は true と false です。 |
| クライアント ID | |
| 直前の検索クエリ UID | |
| オリジンコンテキスト | |
| オリジンレベル 1 | |
| オリジンレベル 2 | |
| オリジンレベル 3 | |
| 結果 | イベントの品質を示します。値 -5 は考えられる最悪の結果、値は中立的な結果、値 5 は考えられる最良の結果に対応します。 |
| 分割テスト実行名 | |
| 分割テスト実行バージョン | |
| ユーザーエージェント | |
| ユーザー表示名 | |
| ユーザー名 | |
| カスタムデータ | ユーザー定義のディメンションとその値。 キーに使用できるのは、英数字またはアンダースコアのみです。キー内の空白はアンダースコアに変換されます。キー内の大文字は小文字に変換されます。 値には任意の有効な JSON を使用できます。Coveo Usage Analytics に渡されるとき、値は文字列データ型に変換されます。 カスタムデータを追加する前に、カスタムディメンションを作成することを強くお勧めします。 |
| カスタムデータテンプレート変数 | データ入力としてテンプレート変数を指定します。詳細については、コネクターテンプレート変数を参照してください。 ネストされたテンプレート変数にはドット表記で名前を付けます。たとえば、 items.name です。ネストされたテンプレート変数は通常、データレイヤーのリスト属性から構築されます。 |
| カスタムデータテンプレート | カスタムデータ内で参照するテンプレートを指定します。詳細については、コネクタテンプレートについてを参照してください。 テンプレートは、二重波括弧を使用して名前でサポート対象フィールドに挿入されます。たとえば、 {{SomeTemplateName}} です。 |
アクション — POST によるクリックイベントの記録
パラメーター
| パラメーター | 説明 |
|---|---|
| アクションの原因 | (必須)このイベントをトリガーした操作の種類。 |
| ドキュメントの位置 | (必須)結果リスト内でクリックされた項目の、1から始まるインデックス位置。この数値では、ページネーション構成を考慮する必要があります。各ページに10件の結果が含まれる場合、2ページ目の3番目の項目の位置は23です。 |
| ドキュメントURI | (必須)クリックされた項目の @uri。 |
| ドキュメントURIハッシュ | (必須)クリックされた項目の @urihash。 |
| 言語 | (必須)エンドユーザーの言語。有効なISO 639-1言語コードである必要があります。 |
| 検索クエリUID | (必須)検索インターフェースが検索イベントを記録するきっかけとなったイベントの一意の識別子。Search APIへの対応する検索リクエストのレスポンスに含まれる検索クエリUID、または長さが36文字以下の任意のUUID v4を使用することを推奨します。36文字を超えるUUIDは、サービスによって切り詰められます。 |
| ソース名 | (必須)クリックされた項目の @source。 |
| 匿名 | 検索インターフェースがイベントを記録する原因となったインタラクションが、匿名ユーザーによってトリガーされたかどうか。使用可能な値は true と false です。 |
| クライアントID | |
| コレクション名 | |
| ドキュメントの作成者 | |
| ドキュメントのカテゴリー | |
| ドキュメントのタイトル | |
| ドキュメントURL | |
| オリジンコンテキスト | |
| オリジンレベル1 | |
| オリジンレベル2 | |
| オリジンレベル3 | |
| 結果 | イベントの品質を示す指標。値 -5 は考えられる最悪の結果に、値 は中立的な結果に、値 5 は考えられる最良の結果に対応します。 |
| クエリパイプライン | |
| ランキング修飾子 | |
| 分割テスト実行名 | |
| 分割テスト実行バージョン | |
| ユーザーエージェント | |
| ユーザー表示名 | |
| ユーザー名 | |
| カスタムデータ | ユーザーが定義したディメンションとその値。 キーには、英数字またはアンダースコアのみを使用できます。キー内の空白文字はアンダースコアに変換されます。キー内の大文字は小文字に変換されます。 値には、有効な任意のJSONを指定できます。Coveo使用状況分析に渡される際、値は文字列データ型に変換されます。 カスタムデータを追加する前に、カスタムディメンションを作成することを強く推奨します。 |
| カスタムデータのテンプレート変数 | データ入力としてテンプレート変数を指定します。詳細については、コネクターテンプレート変数を参照してください。 ネストされたテンプレート変数には、ドット表記で名前を付けます。例: items.name。ネストされたテンプレート変数は通常、データレイヤーのリスト属性から構築されます。 |
| カスタムデータテンプレート | カスタムデータで参照するテンプレートを指定します。詳細については、コネクタテンプレートについてを参照してください。 サポートされているフィールドには、二重中括弧を使用して名前でテンプレートを挿入します。例: {{SomeTemplateName}}。 |
最終更新日 :: 2022年September月26日