パージインタラクションAPIタスクを登録する
このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。
xConnect Web APIを使って、やり取りから不要なデータを除去できます。これを行うには、データパージタスクを登録する必要があります。
タスク登録:
-
以下のAPIをご利用ください:
/sitecore/api/datatools/purge/tasks/interactions タスク登録リクエストが成功すると、ステータス監視に使用されるタスクIDが返されます。例えば:
{ "TaskId": "1af9fddd-e7dd-49f1-b5a2-dae757f59fd4" }
パラメータ
以下の表は、パージタスクを登録するためにWeb APIに送信できるPOSTパラメータを示しています:
!重要結合パラメータは、AND条件として機能します。つまり、APIに送られるすべてのパラメータがデータをフィルタリングしてパージします。
パラメータ
オプション
デフォルト
種類
概要
BatchSize
はい
100
整数
データ抽出のバッチサイズは相互作用です。
BatchSizeシステムパラメータは、各カーソル読み取りごとにコレクションデータベースから抽出されるデータ量を制御します。
>[!重要]
> システムの過負荷を抑えるため、パージプロセスには小さなバッチサイズを使い、タスクのキャンセルを影響を抑えることができます。タスクキャンセルは即時のプロセスではなく、進行中のバッチをキャンセルするものではありません。
DefaultSplitItemCount
はい
100
整数
インタラクションのデータ抽出カーソル分割カウント。
DefaultSplitItemCountシステムパラメータは相互作用データ抽出の分割プロセスを制御します。
ExpiresAfterHours
はい
24
整数
最終的な状態での課題の期限切れ。
最終タスクの状態は成功または失敗となり、期限切れ後にシステムから削除されます。
StartedDaysCutoff
いいえ
-
ヌル可能な整数
相互作用開始から何日経過したかを指定します。このパラメータは相互作用の StartDateTime 値に基づいてフィルタリングします。 StartDateTime は相互作用の開始 DateTimeを反映しています。
StartDateTime値は、データパージワーカーの最小日数の設定設定値に違反してはなりません。最低利用可能な値はデフォルトで180日です(タスク登録については「Cortex処理エンジンの設定」を参照)。
StartPercentile
はい
ヌル
無効化ダブル
開始サンプリングの範囲値。範囲制限は0から1です。
パーセンタイルの範囲は抽出すべきデータの部分セットを指定します。このパラメータを使って少量のバッチでパージを行い、システムに過度な負荷をかけないようにしてください。
データ抽出プロセスは、パーセンタイル範囲と StartedDaysCutoff パラメータに基づいて相互作用をフィルタリングします。
EndPercentile
はい
ヌル
無効化ダブル
終端サンプリングの範囲値。範囲制限は0から1です。
パーセンタイルの範囲は抽出すべきデータの部分セットを指定します。このパラメータを使って少量のバッチでパージを行い、システムに過度な負荷をかけないようにしてください。
データ抽出プロセスは、パーセンタイル範囲と StartedDaysCutoff パラメータに基づいて相互作用をフィルタリングします。
Conditions
はい
""
ストリング
条件名の一覧。複数の条件はAND論理演算子で実行されます。
Conditionsパラメータでは、パージ用のインタラクションを特定するためのカスタム条件キーを指定できます。カスタム条件はCortex Processing Engineで登録する必要があります。
ConditionsIDはカンマで区切っています。
パラメータの総長は2019文字未満でなければなりません。
条件付きのフィルタリングはデータベースレベルでではなくメモリ上で行われます。もしインタラクションがすべての条件をクリアすれば、パージツールはインタラクションをパーリングできます。
DeleteIfHasEvents
はい
{string0}
文字列の配列
既存のイベント名またはGUIDの一覧。
このパラメータは、パージング用のインタラクションを特定するために使われるイベントリストを指定します。データ抽出プロセスは、少なくとも1つのイベントが存在するインタラクションをフィルタリングします。
イベントをコンマやスペース記号で区切るだけです。
最大20個のイベントを指定できます。各イベントは最大100文字まで設定可能です。
SkipIfHasEvents
はい
{string0}
文字列の配列
既存のイベント名またはGUIDの一覧。
このパラメータは、削除をスキップするインタラクションを特定するために使われるイベントリストを指定します。インタラクションは、提供されたイベントのうち少なくとも1つ含まれていれば残ります。
イベントをコンマやスペース記号で区切るだけです。
最大20個のイベントを指定できます。各イベントは最大100文字まで設定可能です。
DeleteIfHasChannels
はい
{string0}
文字列の配列
既存のチャンネル名またはGUIDの一覧。
このパラメータは、パージング用のインタラクションを特定するためのチャネルリストを指定します。データ抽出プロセスは、少なくとも1つのチャネルを持つインタラクションをフィルタリングします。
チャネルはコンマやスペース記号で区切っています。
最大20チャンネルまで指定できます。各チャンネルは最大100文字まで可能です。
SkipIfHasChannels
はい
{string0}
文字列の配列
既存のチャンネル名またはGUIDの一覧。
このパラメータは、削除をスキップするインタラクションを特定するためのチャネルリストを指定します。インタラクションは、提供されたチャネルのうち少なくとも1つ存在すれば残ります。
チャネルはコンマやスペース記号で区切っています。
最大20チャンネルまで指定できます。各チャンネルは最大100文字まで可能です。