Method: projects.locations.requirements.checkRequirement

Periksa persyaratan tertentu.

Permintaan HTTP

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

URL menggunakan sintaks gRPC Transcoding.

Parameter jalur

Parameter
location

string

Wajib. Nama lengkap resource lokasi. Format projects/{project_number_or_id}/locations/{location}

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "requirementType": string,
  "resources": [
    {
      object (MonitoredResource)
    }
  ]
}
Kolom
requirementType

string

Jenis yang menentukan persyaratan yang akan diperiksa. Jenis yang didukung adalah:

  • 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)

Resource yang akan diperiksa untuk persyaratan ini. Jenis yang diperlukan untuk resource yang dipantau:

  • discoveryengine.googleapis.com/Branch.

    • Label yang diperlukan untuk resource ini:
      • project_number
      • location_id
      • collection_id
      • datastore_id
      • branch_id

  • discoveryengine.googleapis.com/DataStore

    • Label yang diperlukan untuk resource ini:
      • project_number
      • location_id
      • collection_id
      • datastore_id

Isi respons

Respons untuk metode requirements.checkRequirement.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "requirement": {
    object (Requirement)
  },
  "requirementCondition": {
    object (Expr)
  },
  "metricResults": [
    {
      object (MetricQueryResult)
    }
  ],
  "oldestMetricTimestamp": string,
  "result": string
}
Kolom
requirement

object (Requirement)

Definisi persyaratan.
requirementCondition

object (Expr)

Kondisi untuk mengevaluasi hasil persyaratan.
metricResults[]

object (MetricQueryResult)

Hasil metrik.
oldestMetricTimestamp

string (Timestamp format)

Stempel waktu metrik yang dihitung paling lama (yaitu metrik yang paling tidak relevan). Menunjukkan bahwa result mungkin tidak secara akurat mencerminkan pembaruan Acara dan Katalog Produk yang dilakukan setelah waktu ini.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
result

string

Hasil persyaratan. Nilai ini harus berupa salah satu kolom severity dalam definisi persyaratan. Jika terjadi error selama evaluasi, error tersebut akan menjadi UNKNOWN.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.

Persyaratan

Persyaratan data.

Representasi JSON 
{
  "type": string,
  "displayName": string,
  "description": string,
  "condition": {
    object (Expr)
  },
  "metricBindings": [
    {
      object (MetricBinding)
    }
  ],
  "thresholdBindings": [
    {
      object (ThresholdBinding)
    }
  ],
  "violationSamplesBindings": [
    {
      object (ViolationSamplesBinding)
    }
  ],
  "severity": [
    string
  ]
}
Kolom
type

string

Jenis persyaratan, digunakan sebagai ID. Harus unik.

Jenis harus diawali dengan nama layanan untuk menghindari kemungkinan konflik. Sebaiknya gunakan pengelompokan hierarkis alami untuk persyaratan serupa.

Contoh:

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

string

Nama persyaratan.
description

string

Deskripsi persyaratan.
condition

object (Expr)

Kondisi untuk mengevaluasi hasil persyaratan.

Variabel dalam ekspresi harus disediakan oleh metrics_bindings atau thresholdBindings. Dengan metrics_bindings digunakan untuk metrik yang dihitung dan thresholdBindings digunakan untuk menentukan nilai minimum untuk metricBindings yang sesuai.
metricBindings[]

object (MetricBinding)

Daftar binding metrik yang akan digunakan di condition.
thresholdBindings[]

object (ThresholdBinding)

Daftar binding nilai minimum yang akan digunakan di condition.
violationSamplesBindings[]

object (ViolationSamplesBinding)

Daftar binding metrik yang akan digunakan di condition.
severity[]

string

Tingkat keparahan error jika persyaratan tidak terpenuhi. Harus diurutkan dari yang paling ketat hingga yang paling longgar. Contoh:

  • BLOCKING
  • CRITICAL
  • WARNING

Semua nilai minimum dalam persyaratan harus memiliki semua tingkat keparahan di sini.

MetricBinding

Menentukan kueri metrik dan mengikat hasilnya ke variabel yang akan digunakan di condition.

Representasi JSON 
{
  "variableId": string,
  "resourceType": string,
  "metricFilter": string,
  "description": string,
  "category": string
}
Kolom
variableId

string

ID variabel yang akan dirujuk di condition.
resourceType

string

Resource yang dipantau untuk metrik.
metricFilter

string

String filter yang digunakan untuk kueri metrik.

Contoh:

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

string

Deskripsi filter metrik yang sesuai dan dapat dibaca manusia.
category

string

Kategori resource target metrik. Contoh: "Acara"

ThresholdBinding

Menentukan nilai minimum bertingkat yang akan diterapkan pada metricBindings dalam ekspresi CEL condition.

Representasi JSON 
{
  "variableId": string,
  "description": string,
  "thresholdValues": [
    {
      object (ThresholdValue)
    }
  ]
}
Kolom
variableId

string

ID variabel yang akan dirujuk di condition. Harus unik di seluruh metricBindings dan thresholdBindings.
description

string

Deskripsi yang dapat dibaca manusia tentang nilai minimum dan sub-persyaratan yang sesuai.
thresholdValues[]

object (ThresholdValue)

Nilai minimum. Nilai harus diurutkan dari yang paling ketat hingga yang paling longgar.

ThresholdValue

Menentukan nilai minimum untuk tingkat keparahan tertentu.

Representasi JSON 
{
  "severity": string,
  "value": number
}
Kolom
severity

string

Tingkat keparahan error jika nilai minimum tidak terpenuhi. Nilai ini harus berupa salah satu kolom severity dalam persyaratan.
value

number

Nilai minimum.

ViolationSamplesBinding

Menentukan kueri sampel dan mengikat hasilnya ke variabel yang akan digunakan di condition.

Representasi JSON 
{
  "variableId": string,
  "sampleFilter": string,
  "description": string
}
Kolom
variableId

string

ID variabel yang akan dirujuk di condition.
sampleFilter

string

String filter yang digunakan untuk kueri sampel.

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

string

Deskripsi binding sampel ini. Digunakan oleh UI untuk merender deskripsi yang mudah dipahami pengguna untuk setiap kondisi persyaratan.

Panjangnya harus kurang dari 128 karakter.

MetricQueryResult

Hasil metrik. Metrik ada di requirementCondition.

Representasi JSON 
{
  "name": string,
  "value": {
    object (TypedValue)
  },
  "timestamp": string,
  "unit": string,
  "metricType": string
}
Kolom
name

string

Nama kueri metrik ini dipetakan ke variabel di requirementCondition.
value

object (TypedValue)

Nilai kueri metrik.
timestamp

string (Timestamp format)

Waktu yang sesuai dengan saat nilai metrik ini dihitung.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
unit

string

Satuan yang digunakan untuk melaporkan metrik ini. Mengikuti

Standar Kode Terpadu untuk Satuan Ukur.
metricType

string

ID jenis metrik yang sesuai dengan hasil kueri ini.