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

連絡先データのエクスポート タスクの登録

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

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

xConnect Web APIを使用して、コンタクト データをエクスポートできます。これを行うには、データエクスポートタスクを登録する必要があります。

連絡先データのエクスポート タスクを登録するには:

  • 次のAPIを使用します。

    <instance>/sitecore/api/datatools/export/tasks/contacts

    タスク登録要求が成功すると、ステータス監視に使用されるタスクIDが返されます。

    {
        "TaskId": "049cd8b3-b120-4949-a42f-cdc2fe4f3086"
    }

パラメーター

次に、データ エクスポート タスクを登録するためにWeb APIに送信できるPOSTパラメーターについて説明します。

パラメーター

随意

既定値

種類

形容

BatchSize

はい

100

整数

連絡先のデータ抽出バッチサイズ

BatchSizeシステム・パラメータは、カーソルの読み取りごとにコレクション・データベースから抽出されるデータ量を制御します。

DefaultSplitItemCount

はい

100

整数

連絡先データ抽出カーソルの分割カウント。

DefaultSplitItemCountシステムパラメータは、連絡先データ抽出の分割プロセスを制御します。

ExpiresAfterHours

はい

24

整数

最終状態でのタスクの有効期限。

最終的なタスクの状況は、成功または失敗のいずれかであり、有効期限が切れるとシステムから削除されます。

StorageProfile

いいえ

-

定義済みのストレージ プロバイダー設定を持つプロファイルの名前 (ネットワーク フォルダーの場所やストレージ アカウントの接続文字列など)。ストレージプロファイルはCortex Processing Engineに登録する必要があり、登録しないとSitecoreタスクが登録されず、ModelValidationExceptionエラーがスローされます。

CutoffDays

はい

ヌル

許容

整数

最後のコンタクト・アクティビティは、指定した日数以上である必要があります。範囲制限は0からint.MaxValueです。

CutoffDaysパラメータは、コンタクトがブランドとやり取りしていない日数を指定します。

データ抽出プロセスでは、このパラメーターを使用して、LastModified値に基づいて連絡先をフィルタリングします。 LastModified日時は、連絡先の最後のインタラクションを反映しています。

StartPercentile

はい

ヌル

null許容double

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

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

データ抽出プロセスでは、パーセンタイル範囲とCutOffDaysパラメーターに基づいて連絡先をフィルタリングします。

EndPercentile

はい

ヌル

null許容double

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

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

データ抽出プロセスでは、パーセンタイル範囲とCutOffDaysパラメーターに基づいて連絡先をフィルタリングします。

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