Method: projects.locations.requirements.checkRequirement

Controllare un requisito specifico.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
location

string

Obbligatorio. Nome completo della risorsa della località. Formato projects/{project_number_or_id}/locations/{location}

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "requirementType": string,
  "resources": [
    {
      object (MonitoredResource)
    }
  ]
}
Campi
requirementType

string

Il tipo che specifica il requisito da controllare. I tipi supportati sono:

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

Le risorse da controllare per questo requisito. Il tipo necessario per le risorse monitorate:

  • discoveryengine.googleapis.com/Branch.

    • Le etichette necessarie per questa risorsa:
      • project_number
      • location_id
      • collection_id
      • datastore_id
      • branch_id

  • discoveryengine.googleapis.com/DataStore

    • Le etichette necessarie per questa risorsa:
      • project_number
      • location_id
      • collection_id
      • datastore_id

Corpo della risposta

Risposta per il metodo requirements.checkRequirement.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

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

object (Requirement)

Definizione dei requisiti.
requirementCondition

object (Expr)

La condizione per valutare il risultato del requisito.
metricResults[]

object (MetricQueryResult)

Risultati delle metriche.
oldestMetricTimestamp

string (Timestamp format)

Timestamp della metrica calcolata meno recente (ovvero la metrica meno aggiornata). Indica che l'result potrebbe non riflettere con precisione gli aggiornamenti del catalogo eventi e prodotti eseguiti dopo questo orario.

Utilizza RFC 3339, in cui l'output generato è sempre normalizzato in base al fuso orario UTC e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
result

string

Il risultato del requisito. Deve essere uno dei campi severity nella definizione del requisito. Se si verifica un errore durante la valutazione, il valore sarà UNKNOWN.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, consulta Authentication Overview.

Requisito

Un requisito di dati.

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

string

Il tipo di requisito, utilizzato come identificatore. Deve essere un codice univoco.

Il tipo deve avere come prefisso il nome del servizio per evitare possibili conflitti. È consigliabile utilizzare il raggruppamento gerarchico naturale per requisiti simili.

Esempi:

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

string

Il nome del requisito.
description

string

La descrizione del requisito.
condition

object (Expr)

La condizione per valutare il risultato del requisito.

Le variabili nell'espressione devono essere fornite da metrics_bindings o thresholdBindings. Dove metrics_bindings vengono utilizzati per le metriche calcolate e thresholdBindings vengono utilizzati per definire le soglie per i metricBindings corrispondenti.
metricBindings[]

object (MetricBinding)

Un elenco delle associazioni di metriche da utilizzare in condition.
thresholdBindings[]

object (ThresholdBinding)

Un elenco di associazioni di soglie da utilizzare in condition.
violationSamplesBindings[]

object (ViolationSamplesBinding)

Un elenco delle associazioni di metriche da utilizzare in condition.
severity[]

string

La gravità degli errori se il requisito non viene soddisfatto. Devono essere ordinate dalla più restrittiva alla meno restrittiva. Esempi:

  • BLOCKING
  • CRITICAL
  • WARNING

Tutte le soglie nel requisito devono avere tutta la gravità qui.

MetricBinding

Specifica una query sulle metriche e associa il relativo risultato a una variabile che verrà utilizzata in condition.

Rappresentazione JSON 
{
  "variableId": string,
  "resourceType": string,
  "metricFilter": string,
  "description": string,
  "category": string
}
Campi
variableId

string

L'ID variabile a cui fare riferimento in condition.
resourceType

string

La risorsa monitorata per la metrica.
metricFilter

string

La stringa di filtro utilizzata per la query delle metriche.

Esempio:

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

string

Descrizione leggibile del filtro delle metriche corrispondente.
category

string

La categoria della risorsa target della metrica. Esempio: "Eventi"

ThresholdBinding

Specifica una soglia multilivello da applicare a un metricBindings nell'espressione CEL condition.

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

string

L'ID variabile a cui fare riferimento in condition. Deve essere univoco in tutti i metricBindings e thresholdBindings.
description

string

Descrizione leggibile della soglia e del requisito secondario corrispondenti.
thresholdValues[]

object (ThresholdValue)

I valori della soglia. I valori devono essere ordinati dal più rigoroso al meno rigoroso.

ThresholdValue

Specifica un valore di soglia per una determinata gravità.

Rappresentazione JSON 
{
  "severity": string,
  "value": number
}
Campi
severity

string

La gravità degli errori se la soglia non viene raggiunta. Deve essere uno dei campi severity del requisito.
value

number

Il valore della soglia.

ViolationSamplesBinding

Specifica una query di esempio e associa il risultato a una variabile che verrà utilizzata in condition.

Rappresentazione JSON 
{
  "variableId": string,
  "sampleFilter": string,
  "description": string
}
Campi
variableId

string

L'ID variabile a cui fare riferimento in condition.
sampleFilter

string

La stringa di filtro utilizzata per la query dei campioni.

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

string

Descrizione di questo binding di esempio. Utilizzato dalla UI per eseguire il rendering di descrizioni intuitive per ogni condizione di requisito.

Deve contenere meno di 128 caratteri.

MetricQueryResult

Risultato della metrica. La metrica si trova in requirementCondition.

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

string

Il nome di questa query della metrica viene mappato alle variabili in requirementCondition.
value

object (TypedValue)

Valore della query della metrica.
timestamp

string (Timestamp format)

L'ora corrispondente al momento in cui è stato calcolato il valore di questa metrica.

Utilizza RFC 3339, in cui l'output generato è sempre normalizzato in base al fuso orario UTC e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
unit

string

L'unità in cui viene riportata questa metrica. Nuovi follower

standard Unified Code for Units of Measure.
metricType

string

Identificatore del tipo di metrica corrispondente a questo risultato della query.