---
title: "パージ連絡先のAPIタスクを登録する"
slug: "register-a-purge-contacts-api-task"
abstract: "xConnectのパージツールWeb APIで連絡先パージタスクを登録する方法。"
---
# パージ連絡先のAPIタスクを登録する

[xConnect Web API](https://doc.sitecore.com/xp/ja/developers/105/sitecore-experience-platform/web-api-for-xconnect-data-tools.html "Web API for xConnect Data Tools")を使って連絡先から不要なデータを除去できます。これを行うには、[パージ](https://doc.sitecore.com/xp/ja/developers/105/sitecore-experience-platform/xconnect-purging-tool.html "xConnect purging tool")タスクを登録する必要があります。

タスク登録:

-   以下のAPIをご利用ください:
    
    <instance>/sitecore/api/datatools/purge/tasks/contacts
    
    タスク登録リクエストが成功すると、ステータス監視に使用されるタスクIDが返されます。例えば:
    
    {
        "TaskId": "049cd8b3-b120-4949-a42f-cdc2fe4f3086"
    }
    

## パラメータ

以下は、パージタスクを登録するためにWeb APIに送信できるPOSTパラメータについて説明します。

パラメータ

オプション

デフォルト

種類

概要

BatchSize

はい

100

整数

データ抽出のバッチサイズは接触点です。  
  
BatchSizeシステムパラメータは、各カーソル読み取りごとにコレクションデータベースから抽出されるデータ量を制御します。  
  
\>\[!重要\]  
\> システムの過負荷を抑えるため、パージプロセスには小さなバッチサイズを使い、タスクのキャンセルを影響を抑えることができます。タスクキャンセルは即時のプロセスではなく、進行中のバッチをキャンセルするものではありません。

DefaultSplitItemCount

はい

100

整数

接触データ抽出カーソル分割カウント。  
  
DefaultSplitItemCountシステムパラメータは、接触データ抽出の分割プロセスを制御します。

ExpiresAfterHours

はい

24

整数

最終的な状態での課題の期限切れ。  
  
最終タスクの状態は成功または失敗となり、期限切れ後にシステムから削除されます。

CutoffDays

いいえ

\-

ヌル可能な整数

最後の接触活動は指定された日数以上でなければなりません。範囲制限は0の int.MaxValueです。  
  
CutoffDaysパラメータは、その接触がブランドと接触しない日数を指定します。  
  
データ抽出プロセスでは、このパラメータを用いて LastModified 値に基づいて接点をフィルタリングします。 LastModified の日付時刻は、接点の最後の相互作用を反映しています。

StartPercentile

はい

ヌル

無効化ダブル

開始サンプリングの範囲値。範囲制限は0から1です。  
  
パーセンタイルの範囲は抽出すべきデータの部分セットを指定します。このパラメータを使って少量のバッチでパージを行い、システムに過度な負荷をかけないようにしてください。  
  
データ抽出プロセスは、パーセンタイル範囲と CutOffDays パラメータに基づいて接点をフィルタリングします。

EndPercentile

はい

ヌル

無効化ダブル

終端サンプリングの範囲値。範囲制限は0から1です。  
  
パーセンタイルの範囲は抽出すべきデータの部分セットを指定します。このパラメータを使って少量のバッチでパージを行い、システムに過度な負荷をかけないようにしてください。  
  
データ抽出プロセスは、パーセンタイル範囲と CutOffDays パラメータに基づいて接点をフィルタリングします。

Conditions

はい

""

ストリング

条件名の一覧。複数の条件はAND論理演算子で実行されます。  
  
Conditionsパラメータは、パージ用の接触を特定するためのカスタム条件キーを指定できます。Cortex Processing Engineでカスタム条件を登録する必要があります。  
  
ConditionsIDはカンマで区切っています。  
  
パラメータの総長は2019文字未満でなければなりません。  
  
条件のフィルタリングはデータベースレベルでではなくメモリ内で行われます。コンタクトがすべての条件をクリアすれば、パージツールはパージ可能です。