1. xConnectデータ ツール用のWeb API

パージインタラクションAPIタスクの登録

Version:
日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

xConnect Web APIを使用して、インタラクションから不要なデータを削除できます。これを行うには、データ消去タスクを登録する必要があります。

タスクを登録するには:

  • 次のAPIを使用します。

    <instance>/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

いいえ

-

Null許容整数

インタラクションが開始されてからの日数を指定します。このパラメータは、StartDateTime値に基づいてインタラクションをフィルタリングします。 StartDateTimeは、インタラクションの開始DateTimeを反映しています。

StartDateTime値は、データ消去ワーカーの最小日数の構成設定値に違反してはなりません。使用可能な最小値はデフォルトで180日です (タスク登録のためのCortexプロセッシング エンジンの設定を参照)。

StartPercentile

はい

ヌル

null許容double

サンプリング範囲の開始値。範囲の制限は0から1です。

パーセンタイル範囲は、抽出するデータのサブセットを指定します。このパラメータを使用して、システムに過度のストレスがかからないように、パージを小さなバッチで実行します。

データ抽出プロセスでは、パーセンタイル範囲とStartedDaysCutoffパラメーターに基づいてインタラクションがフィルタリングされます。

EndPercentile

はい

ヌル

null許容double

終了サンプリング範囲の値。範囲の制限は0から1です。

パーセンタイル範囲は、抽出するデータのサブセットを指定します。このパラメータを使用して、システムに過度のストレスがかからないように、パージを小さなバッチで実行します。

データ抽出プロセスでは、パーセンタイル範囲とStartedDaysCutoffパラメーターに基づいてインタラクションがフィルタリングされます。

Conditions

はい

""

条件名のリスト。複数の条件はAND論理演算子で実行されます。

Conditionsパラメーターを使用すると、パージのインタラクションを識別するために使用されるカスタム条件キーを指定できます。カスタム条件はCortex Processing Engineに登録する必要があります。

Conditions IDはカンマで区切ります。

パラメーターの合計長は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文字です。

この記事を改善するための提案がある場合は、 お知らせください!