API を使用して会話を一括削除する

Customer Experience Insights では、フィルタされた会話のサブセットまたはすべての会話を 1 つのリクエストで削除できます。削除した会話は復元できないため、削除する会話の数とフィルタが正しいことを確認してください。

まず、MAX_DELETE_COUNT を 0 に設定してコマンドを実行することを強くおすすめします。次に、削除される会話の数を確認し、正しい MAX_DELETE_COUNT を使用して API 呼び出しを実行します。

前提条件

1. 会話データが Customer Experience Insights にアップロードされていることを確認します。

サンプル コマンド

すべての会話を削除する

REST

詳細については、conversations:bulkDelete API エンドポイントをご覧ください。

リクエストのデータを使用する前に、次のように置き換えます。

• PROJECT_ID: Google Cloud Platform プロジェクト ID。
• FORCE: true の場合、会話とリンクされた分析が削除されます。それ以外の場合は、分析されていない会話のみが削除されます。
• MAX_DELETE_COUNT: 削除する会話の最大数。プロジェクト内の会話数よりも小さい場合、API 呼び出しはエラーを返します。

注: すべての例で、グローバル Customer Experience Insights インスタンスを使用しています。リージョン インスタンスの使用方法については、リージョン化をご覧ください。

HTTP メソッドと URL:

POST https://contactcenterinsights.googleapis.com/v1/projects/PROJECT_ID/locations/us-central1/conversations:bulkDelete

リクエストの本文（JSON）:

{
  "force": FORCE,
  "maxDeleteCount": MAX_DELETE_COUNT,
}

リクエストを送信するには、次のいずれかのオプションを展開します。

curl（Linux、macOS、Cloud Shell）

注: 次のコマンドは、gcloud init または gcloud auth login を実行して、ユーザー アカウントで gcloud CLI にログインしているか、Cloud Shell を使用して自動的に gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

リクエスト本文を request.json という名前のファイルに保存して、次のコマンドを実行します。

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://contactcenterinsights.googleapis.com/v1/projects/PROJECT_ID/locations/us-central1/conversations:bulkDelete"

PowerShell（Windows）

注: 次のコマンドは、gcloud init または gcloud auth login を実行して、ご自分のユーザー アカウントで gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

リクエスト本文を request.json という名前のファイルに保存して、次のコマンドを実行します。

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://contactcenterinsights.googleapis.com/v1/projects/PROJECT_ID/locations/us-central1/conversations:bulkDelete" | Select-Object -Expand Content

次のような JSON レスポンスが返されます。

{
  "name": "projects/PROJECT_ID/locations/us-central1/operations/OPERATION_ID",
}

（省略可）フィルタを使用して会話を削除する

フィルタの全一覧は、[会話のフィルタリング] ページで確認できます。

REST

リクエストのデータを使用する前に、次のように置き換えます。

• PROJECT_ID: Google Cloud Platform プロジェクト ID。
• FORCE: true の場合、会話とリンクされた分析が削除されます。それ以外の場合は、分析されていない会話のみが削除されます。
• MAX_DELETE_COUNT: 削除する会話の最大数。これがプロジェクト内の会話数よりも少ない場合、API 呼び出しはエラーを返します。
• FILTER: 利用可能なフィルタ オプションについては、スレッドのリストを取得するをご覧ください。

注: すべての例で、グローバル Customer Experience Insights インスタンスを使用しています。リージョン インスタンスの使用方法については、リージョン化をご覧ください。

HTTP メソッドと URL:

POST https://contactcenterinsights.googleapis.com/v1/projects/PROJECT_ID/locations/us-central1/conversations:bulkAnalyze

リクエストの本文（JSON）:

{
  "force": FORCE,
  "maxDeleteCount": MAX_DELETE_COUNT,
  "filter": 'FILTER'
}

リクエストを送信するには、次のいずれかのオプションを展開します。

curl（Linux、macOS、Cloud Shell）

注: 次のコマンドは、gcloud init または gcloud auth login を実行して、ユーザー アカウントで gcloud CLI にログインしているか、Cloud Shell を使用して自動的に gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

リクエスト本文を request.json という名前のファイルに保存して、次のコマンドを実行します。

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://contactcenterinsights.googleapis.com/v1/projects/PROJECT_ID/locations/us-central1/conversations:bulkAnalyze"

PowerShell（Windows）

注: 次のコマンドは、gcloud init または gcloud auth login を実行して、ご自分のユーザー アカウントで gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

リクエスト本文を request.json という名前のファイルに保存して、次のコマンドを実行します。

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://contactcenterinsights.googleapis.com/v1/projects/PROJECT_ID/locations/us-central1/conversations:bulkAnalyze" | Select-Object -Expand Content

次のような JSON レスポンスが返されます。

{
  "name": "projects/PROJECT_ID/locations/us-central1/operations/OPERATION_ID",
}

オペレーションをポーリングする

会話を削除すると、長時間実行オペレーションが返されます。長時間実行メソッドは非同期で、メソッドがレスポンスを返すときにオペレーションがまだ完了していない場合があります。オペレーションをポーリングして、そのステータスを確認できます。詳細とコードサンプルについては、長時間実行オペレーションのページをご覧ください。

オペレーションをキャンセルする

REST

リクエストのデータを使用する前に、次のように置き換えます。

• PROJECT_ID: Google Cloud Platform プロジェクト ID。
• OPERATION_ID: 分析する会話の ID。この値は、オペレーションの作成時に返されました。

注: すべての例で、グローバル Customer Experience Insights インスタンスを使用しています。リージョン インスタンスの使用方法については、リージョン化をご覧ください。

HTTP メソッドと URL:

POST https://contactcenterinsights.googleapis.com/v1/projects/PROJECT_ID/locations/us-central1/operations/OPERATION_ID:cancel

リクエストを送信するには、次のいずれかのオプションを展開します。

curl（Linux、macOS、Cloud Shell）

注: 次のコマンドは、gcloud init または gcloud auth login を実行して、ユーザー アカウントで gcloud CLI にログインしているか、Cloud Shell を使用して自動的に gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

次のコマンドを実行します。

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d "" \
     "https://contactcenterinsights.googleapis.com/v1/projects/PROJECT_ID/locations/us-central1/operations/OPERATION_ID:cancel"

PowerShell（Windows）

注: 次のコマンドは、gcloud init または gcloud auth login を実行して、ご自分のユーザー アカウントで gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

次のコマンドを実行します。

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -Uri "https://contactcenterinsights.googleapis.com/v1/projects/PROJECT_ID/locations/us-central1/operations/OPERATION_ID:cancel" | Select-Object -Expand Content

次のような JSON レスポンスが返されます。

{}