Coveoコネクタの構成ガイド | サーバーサイドコネクタ | Tealium開発者ドキュメントプレビュー

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`）の元の値。
レスポンス時間	（必須）検索インターフェースが検索イベントをログに記録するために検索APIに送信されたクエリと検索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`）の元の値。
レスポンス時間	（必須）検索インターフェースが検索イベントをログに記録するために検索APIに送信されたクエリと検索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経由でのカスタムイベントのログ記録

パラメータ

パラメータ	説明
イベントタイプ	（必須）カスタムイベントのタイプ。
イベント値	（必須）カスタムイベントの値。
言語	（必須）エンドユーザーの言語。有効な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	（必須）検索インターフェースが検索イベントをログに記録したイベントの一意の識別子。対応する検索リクエストの応答で使用することをお勧めします。または、36文字以下のUUID v4。36文字を超えるUUIDはサービスによって切り捨てられます。
ソース名	（必須）クリックされたアイテムの`@source`。
匿名	検索インターフェースがイベントのログ記録をトリガーした相互作用が匿名ユーザーによってトリガーされたかどうかを示します。使用可能な値は「true」と「false」です。
クライアントID
コレクション名
ドキュメント作成者
ドキュメントカテゴリ
ドキュメントタイトル
ドキュメントURL
オリジンコンテキスト
オリジンレベル1
オリジンレベル2
オリジンレベル3
アウトカム	イベントの品質を示す指標です。値「-5」は最悪の結果に対応し、値は中立的な結果に対応し、値「5」は最良の結果に対応します。
クエリパイプライン
ランキング修飾子
スプリットテスト実行名
スプリットテスト実行バージョン
ユーザーエージェント
ユーザーディスプレイ名
ユーザー名
カスタムデータ	ユーザー定義のディメンションとその値。キーには英数字またはアンダースコアのみを含めることができます。キー内の空白はアンダースコアに変換されます。キー内の大文字は小文字に変換されます。値は有効なJSONである場合があります。値はCoveoの使用分析に渡される際に文字列データ型に変換されます。カスタムデータを追加する前に、カスタムディメンションを作成することを強くお勧めします。
カスタムデータテンプレート変数	データ入力としてテンプレート変数を提供します（参照：テンプレート変数ガイド）。ネストされたテンプレート変数はドット表記法で命名します。例：`items.name`。ネストされたテンプレート変数は通常、データレイヤーリスト属性から構築されます。
カスタムデータテンプレート	カスタムデータで参照するテンプレートを提供します（参照：テンプレートガイド）。テンプレートは、サポートされるフィールドに二重の中括弧で名前を挿入することで参照されます。例：`{{SomeTemplateName}}`。