指標をクエリする

プレビュー版

この機能は、 サービス固有の規約の対象となります。 pre-GA の機能は「現状のまま」で提供されるものであり、サポートが制限されることがあります。 詳細については、リリース ステージの説明をご覧ください。

CX Insights にある会話データに関する指標をクエリします。これらの指標には、会話の合計数、平均無音率、平均会話時間などがあります。

前提条件

プロジェクトでこの機能を有効にするには、Google の担当者にお問い合わせください。

指標をクエリする

次のコードサンプルは、指標をクエリする方法を示しています。会話の作成時間フィルタは常に必要です。このフィルタの詳細については、会話を一覧表示するをご覧ください。

すべての指標

すべての指標を取得します。

REST

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

• PROJECT_ID: プロジェクト ID。
• MIN_TIMESTAMP: 最小タイムスタンプ フィルタ。例: YYYY-MM-DDT00:00:00+00
• MAX_TIMESTAMP: 最大タイムスタンプ フィルタ。例: YYYY-MM-DDT00:00:00+00
注: すべての例で、グローバルな Customer Experience Insights インスタンスを使用しています。リージョン インスタンスの使用方法については、リージョン化をご覧ください。

HTTP メソッドと URL:

GET https://contactcenterinsights.googleapis.com/v1/projects/PROJECT_ID/locations/us-central1:queryMetrics

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

{
  "filter": "create_time>='MIN_TIMESTAMP' create_time<'MAX_TIMESTAMP'"
}

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

curl（Linux、macOS、Cloud Shell）

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

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

curl -X GET \
     -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:queryMetrics"

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 GET `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://contactcenterinsights.googleapis.com/v1/projects/PROJECT_ID/locations/us-central1:queryMetrics" | Select-Object -Expand Content

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

{
  "name": "projects/PROJECT_ID/locations/us-central1/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.contactcenterinsights.v1.QueryMetricsMetadata"
  }
}

トピック別にグループ化されたすべての指標

トピック別にグループ化されたすべての指標を取得します。トピックについては、トピックのモデリングの概要をご覧ください。

REST

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

• PROJECT_ID: プロジェクト ID。
• MIN_TIMESTAMP: 最小タイムスタンプ フィルタ。例: YYYY-MM-DDT00:00:00+00
• MAX_TIMESTAMP: 最大タイムスタンプ フィルタ。例: YYYY-MM-DDT00:00:00+00
注: すべての例で、グローバルな Customer Experience Insights インスタンスを使用しています。リージョン インスタンスの使用方法については、リージョン化をご覧ください。

HTTP メソッドと URL:

GET https://contactcenterinsights.googleapis.com/v1/projects/PROJECT_ID/locations/us-central1:queryMetrics

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

{
  "filter": "create_time>='MIN_TIMESTAMP' create_time<'MAX_TIMESTAMP'",
  "dimensions": [{ "dimensionKey": "ISSUE" }]
}

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

curl（Linux、macOS、Cloud Shell）

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

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

curl -X GET \
     -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:queryMetrics"

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 GET `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://contactcenterinsights.googleapis.com/v1/projects/PROJECT_ID/locations/us-central1:queryMetrics" | Select-Object -Expand Content

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

{
  "name": "projects/PROJECT_ID/locations/us-central1/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.contactcenterinsights.v1.QueryMetricsMetadata"
  }
}

日次時系列のすべての指標

日単位の時系列で全指標を取得します。時系列の各データポイントは、1 日分の指標を表します。

REST

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

• PROJECT_ID: プロジェクト ID。
• MIN_TIMESTAMP: 最小タイムスタンプ フィルタ。例: YYYY-MM-DDT00:00:00+00
• MAX_TIMESTAMP: 最大タイムスタンプ フィルタ。例: YYYY-MM-DDT00:00:00+00

HTTP メソッドと URL:

GET https://contactcenterinsights.googleapis.com/v1/projects/PROJECT_ID/locations/us-central1:queryMetrics

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

{
  "filter": "create_time>='MIN_TIMESTAMP' create_time<'MAX_TIMESTAMP'",
  "timeGranularity": "DAILY"
}

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

curl（Linux、macOS、Cloud Shell）

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

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

curl -X GET \
     -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:queryMetrics"

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 GET `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://contactcenterinsights.googleapis.com/v1/projects/PROJECT_ID/locations/us-central1:queryMetrics" | Select-Object -Expand Content

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

{
  "name": "projects/PROJECT_ID/locations/us-central1/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.contactcenterinsights.v1.QueryMetricsMetadata"
  }
}

トピック別にグループ化されたすべての指標の日次時系列

トピック別にグループ化されたすべての指標を日単位の時系列で取得します。時系列の各データポイントは、1 日分の指標を表します。トピックについては、トピックのモデリングの概要をご覧ください。

REST

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

• PROJECT_ID: プロジェクト ID。
• MIN_TIMESTAMP: 最小タイムスタンプ フィルタ。例: YYYY-MM-DDT00:00:00+00
• MAX_TIMESTAMP: 最大タイムスタンプ フィルタ。例: YYYY-MM-DDT00:00:00+00
注: すべての例で、グローバルな Customer Experience Insights インスタンスを使用しています。リージョン インスタンスの使用方法については、リージョン化をご覧ください。

HTTP メソッドと URL:

GET https://contactcenterinsights.googleapis.com/v1/projects/PROJECT_ID/locations/us-central1:queryMetrics

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

{
  "filter": "create_time>='MIN_TIMESTAMP' create_time<'MAX_TIMESTAMP'",
  "dimensions": [{ "dimensionKey": "ISSUE" }],
  "timeGranularity": "DAILY"
}

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

curl（Linux、macOS、Cloud Shell）

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

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

curl -X GET \
     -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:queryMetrics"

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 GET `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://contactcenterinsights.googleapis.com/v1/projects/PROJECT_ID/locations/us-central1:queryMetrics" | Select-Object -Expand Content

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

{
  "name": "projects/PROJECT_ID/locations/us-central1/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.contactcenterinsights.v1.QueryMetricsMetadata"
  }
}