---
title: "CLIのパージコンタクトコマンド"
slug: "the-cli-purge-contacts-command"
abstract: "xConnect DevEx CLIのパージコンタクトコマンドの参照で、パージタスクを登録します。"
---
# CLIのパージコンタクトコマンド

[xConnect DevEx CLIプラグイン](https://doc.sitecore.com/xp/ja/developers/103/sitecore-experience-platform/xconnect-devex-cli-plugin.html "xConnect DevEx CLI plugin")にはpurgeコマンドとcontactsサブコマンドが含まれています。このコマンドは、提供されたCutoffDaysと条件に基づいてパージプロセスを開始します。

## 使用例

コマンドの使い方は以下の通りです:

sitecore xconnect purge contacts subcommand options

## サブコマンド

以下のサブコマンドを使用できます:

副司令部

概要

start

パージコンタクトタスクを登録してください。

## オプション

以下のコマンドで以下のオプションを使用できます:

オプション

必須ですか?

概要

\-c, --config

はい

sitecore.json設定ファイルへのパス(デフォルト:cwd)。DevEx CLI標準オプションです。

\-n, --environment-name

はい

Sitecore環境。デフォルト: default。DevEx CLI標準的な選択肢。

\-d, --cutoffdays

はい

連絡先がブランドと接触していない日数。例えば、 \-d 190。  
  
\> \[!注\]  
\> このオプションはデフォルト値を持たない唯一の条件です。  
  
cutoffdaysオプションには制限事項のリストがあります:  
  

-   最低利用可能な値はデフォルトで180日です( [タスク登録については「Cortex処理エンジンの設定](https://doc.sitecore.com/xp/en/developers/104/sitecore-experience-platform/configure-the-cortex-processing-engine-for-task-registration.html)」を参照)。
-   値は正の整数でなければなりません。

\--sp, --start-percentile

いいえ

データ抽出のための範囲制限開始パーセンタイル。例えば、 \--sp 0。  
  
start-percentileオプションには制限事項のリストがあります:  
  

-   開始パーセンタイルと終了パーセンタイルの両方を指定するか、どちらでも指定しなければなりません。
-   両者の範囲制限は0から1の間です。
-   start-percentileは end-percentileより低くなければなりません。

\--ep, --end-percentile

いいえ

データ抽出のための範囲制限付き末パーセンタイル。例えば、 \--ep 1。  
  
end-percentileオプションには制限事項のリストがあります:  
  

-   開始パーセンタイルと終了パーセンタイルの両方を指定するか、どちらでも指定しなければなりません。
-   両者の範囲制限は0から1の間です。
-   end-percentileはstart-percentileより高くなければなりません。

\--cds, --conditions

いいえ

コンタクトのパージに関する追加のフィルター条件のカンマ区切られたリスト。条件はカスタマイズ可能で、さらなるデータフィルタリングのために登録可能です。例えば、 \--cds AnonymousCondition。  
  
タスク登録は、存在しない条件が指定されている場合に失敗します。未発見条件のリストはCLI出力に含まれています。  
  
\> \[!注\]  
\> [Walkthrough: Customizing Contact Purge Conditions(コンタクトパージ条件のカスタマイズ](https://doc.sitecore.com/xp/ja/developers/103/sitecore-experience-platform/walkthrough--customizing-contact-purge-conditions.html) )については、制限やカスタム条件の作成方法について詳しくご覧ください。

\-b, --batch-size

はい

パージタスクが使用する接触データ抽出のバッチサイズ。例えば、 \-b 200。

\-v, --verbose

いいえ

追加の診断およびパフォーマンスデータを報告してください。

\-t, --trace

いいえ

追加の診断およびパフォーマンスデータを報告してください。

\--confirm

いいえ

すべてのプロンプトを自動的に確認してください。

\-?, -h, --help

いいえ

コマンドの助けを。

## 例

以下はpurge contactsコマンドの使用例です。

sitecore xconnect purge contacts start -d 180

sitecore xconnect purge contacts start -d 180 --sp 0 --ep 1 -b 200 --cds AnonymousCondition --trace --verbose

## タスク登録の確認またはキャンセル

purge contacts startコマンドは、このコマンドがデータ削除を引き起こすことをエンドユーザーに確認します。

ユーザーはYまたはyを入力してタスク登録を確認できます:

タスク登録に成功すると、タスクの [ステータス](https://doc.sitecore.com/xp/ja/developers/103/sitecore-experience-platform/the-cli-purge-status-command.html "The CLI purge status command") 取得や [タスクのキャンセル](https://doc.sitecore.com/xp/ja/developers/103/sitecore-experience-platform/the-cli-purge-cancel-command.html "The CLI purge cancel command") など、今後の操作に利用できるタスクIDが返されます。

ユーザーはNまたはnでタスク登録をキャンセルすることも可能です。他の文字入力があれば、確認応答が無効であることを通知し、タスク登録がキャンセルされます。

タスク登録の無言確認にはオプション \--confirmを使うことができます。その場合、プロンプトは一切表示されません。

タスク登録が成功した結果として、タスクIDとパージタスクのキャンセルおよび状況取得のためのサンプルコマンドが得られます。