Method: projects.locations.requirements.checkRequirement

特定の要件を確認します。

HTTP リクエスト

POST https://discoveryengine.googleapis.com/v1alpha/{location=projects/*/locations/*}/requirements:checkRequirement

この URL では gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
location

string

必須。ロケーションの完全なリソース名。projects/{project_number_or_id}/locations/{location} の形式を設定

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "requirementType": string,
  "resources": [
    {
      object (MonitoredResource)
    }
  ]
}
フィールド
requirementType

string

チェックする要件を指定するタイプ。サポートされるタイプは次のとおりです。

  • discoveryengine.googleapis.com/media_recs/general/all/warning
  • discoveryengine.googleapis.com/media_recs/oyml/cvr/warning
  • discoveryengine.googleapis.com/media_recs/rfy/cvr/warning
  • discoveryengine.googleapis.com/media_recs/mlt/cvr/warning
  • discoveryengine.googleapis.com/media_recs/mp/cvr/warning
  • discoveryengine.googleapis.com/media_recs/oyml/wdps/warning
  • discoveryengine.googleapis.com/media_recs/rfy/wdps/warning
  • discoveryengine.googleapis.com/media_recs/mlt/wdps/warning
resources[]

object (MonitoredResource)

この要件の確認対象となるリソース。モニタリング対象リソースに必要なタイプ:

  • discoveryengine.googleapis.com/Branch。

    • このリソースに必要なラベル:
      • project_number
      • location_id
      • collection_id
      • datastore_id
      • branch_id

  • discoveryengine.googleapis.com/DataStore

    • このリソースに必要なラベル:
      • project_number
      • location_id
      • collection_id
      • datastore_id

レスポンスの本文

requirements.checkRequirement メソッドに対するレスポンス。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "requirement": {
    object (Requirement)
  },
  "requirementCondition": {
    object (Expr)
  },
  "metricResults": [
    {
      object (MetricQueryResult)
    }
  ],
  "oldestMetricTimestamp": string,
  "result": string
}
フィールド
requirement

object (Requirement)

要件の定義。
requirementCondition

object (Expr)

要件の結果を評価するための条件。
metricResults[]

object (MetricQueryResult)

指標の結果。
oldestMetricTimestamp

string (Timestamp format)

最も古い計算指標（最も古い指標）のタイムスタンプ。この時刻以降に実行されたイベントと商品カタログの更新が result に正確に反映されない可能性があることを示します。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
result

string

要件の結果。要件定義の severity フィールドのいずれかである必要があります。評価中にエラーが発生した場合、UNKNOWN になります。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

詳細については、Authentication Overview をご覧ください。

要件

データ要件。

JSON 表現 
{
  "type": string,
  "displayName": string,
  "description": string,
  "condition": {
    object (Expr)
  },
  "metricBindings": [
    {
      object (MetricBinding)
    }
  ],
  "thresholdBindings": [
    {
      object (ThresholdBinding)
    }
  ],
  "violationSamplesBindings": [
    {
      object (ViolationSamplesBinding)
    }
  ],
  "severity": [
    string
  ]
}
フィールド
type

string

識別子として使用される要件タイプ。一意である必要があります。

競合を避けるため、タイプにはサービス名の接頭辞を付ける必要があります。同様の要件には、自然な階層型グループ化を使用することをおすすめします。

例:

  • library.googleapis.com/books/min_available_books
  • discoveryengine.googleapis.com/media_rec/recommended_for_you/conversion_rate
displayName

string

要件の名前。
description

string

要件の説明。
condition

object (Expr)

要件の結果を評価するための条件。

式内の変数は、metrics_bindings または thresholdBindings によって提供される必要があります。ここで、metrics_bindings は計算された指標に使用され、thresholdBindings は対応する metricBindings のしきい値を定義するために使用されます。
metricBindings[]

object (MetricBinding)

condition で使用される指標バインディングのリスト。
thresholdBindings[]

object (ThresholdBinding)

condition で使用するしきい値バインディングのリスト。
violationSamplesBindings[]

object (ViolationSamplesBinding)

condition で使用される指標バインディングのリスト。
severity[]

string

要件が満たされていない場合のエラーの重大度。最も厳格なものから最も厳格でないものまで順に並べる必要があります。例:

  • BLOCKING
  • CRITICAL
  • WARNING

要件のすべてのしきい値に、ここで重大度を設定する必要があります。

MetricBinding

指標クエリを指定し、その結果を condition で使用される変数にバインドします。

JSON 表現 
{
  "variableId": string,
  "resourceType": string,
  "metricFilter": string,
  "description": string,
  "category": string
}
フィールド
variableId

string

condition で参照される変数 ID。
resourceType

string

指標のモニタリング対象リソース。
metricFilter

string

指標クエリに使用されるフィルタ文字列。

例:

"metric.type = "discoveryengine.googleapis.com/events/day_count" AND " "metric.conditions.time_range = "NINETY_DAYS""
description

string

対応する指標フィルタの説明（人が読める形式）。
category

string

指標のターゲット リソースのカテゴリ。例: 「イベント」

ThresholdBinding

condition CEL 式の metricBindings に適用するマルチレベルのしきい値を指定します。

JSON 表現 
{
  "variableId": string,
  "description": string,
  "thresholdValues": [
    {
      object (ThresholdValue)
    }
  ]
}
フィールド
variableId

string

condition で参照される変数 ID。すべての metricBindings と thresholdBindings で一意である必要があります。
description

string

対応するしきい値とサブ要件の説明（人が読める形式）。
thresholdValues[]

object (ThresholdValue)

しきい値の値。値は、最も厳格なものから最も厳格でないものの順に並べる必要があります。

ThresholdValue

指定された重大度のしきい値を指定します。

JSON 表現 
{
  "severity": string,
  "value": number
}
フィールド
severity

string

しきい値が満たされていない場合のエラーの重大度。要件の severity フィールドのいずれかである必要があります。
value

number

しきい値。

ViolationSamplesBinding

サンプルクエリを指定し、その結果を condition で使用される変数にバインドします。

JSON 表現 
{
  "variableId": string,
  "sampleFilter": string,
  "description": string
}
フィールド
variableId

string

condition で参照される変数 ID。
sampleFilter

string

サンプルクエリに使用されるフィルタ文字列。

例: 「sample.type = "retail.googleapis.com/userEvent" AND " "sample.labels.event_type = "PURCHASE" "」
description

string

このサンプル バインディングの説明。UI で各要件条件のわかりやすい説明をレンダリングするために使用されます。

128 文字未満にしてください。

MetricQueryResult

指標の結果。指標は requirementCondition にあります。

JSON 表現 
{
  "name": string,
  "value": {
    object (TypedValue)
  },
  "timestamp": string,
  "unit": string,
  "metricType": string
}
フィールド
name

string

この指標クエリ名は、requirementCondition の変数にマッピングされます。
value

object (TypedValue)

指標クエリの値。
timestamp

string (Timestamp format)

この指標値が計算された時刻。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
unit

string

この指標が報告される単位。フォロー数

測定単位の統一コード標準。
metricType

string

このクエリ結果に対応する指標の型識別子。