Method: projects.locations.requirements.checkRequirement

Consultar un requisito concreto.

Solicitud HTTP

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

La URL utiliza la sintaxis de transcodificación a gRPC.

Parámetros de ruta

Parámetros
location

string

Obligatorio. Nombre completo del recurso de la ubicación. Formato projects/{project_number_or_id}/locations/{location}

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos que presentan la siguiente estructura:

Representación JSON 
{
  "requirementType": string,
  "resources": [
    {
      object (MonitoredResource)
    }
  ]
}
Campos
requirementType

string

El tipo que especifica el requisito que se debe comprobar. Los tipos admitidos son los siguientes:

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

Los recursos que se deben comprobar para cumplir este requisito. El tipo necesario para los recursos monitorizados:

  • discoveryengine.googleapis.com/Branch.

    • Las etiquetas necesarias para este recurso:
      • project_number
      • location_id
      • collection_id
      • datastore_id
      • branch_id

  • discoveryengine.googleapis.com/DataStore

    • Las etiquetas necesarias para este recurso:
      • project_number
      • location_id
      • collection_id
      • datastore_id

Cuerpo de la respuesta

Respuesta del método requirements.checkRequirement.

Si la solicitud se realiza correctamente, el cuerpo de la respuesta proporciona datos con la siguiente estructura:

Representación JSON 
{
  "requirement": {
    object (Requirement)
  },
  "requirementCondition": {
    object (Expr)
  },
  "metricResults": [
    {
      object (MetricQueryResult)
    }
  ],
  "oldestMetricTimestamp": string,
  "result": string
}
Campos
requirement

object (Requirement)

Definición de requisitos.
requirementCondition

object (Expr)

Condición para evaluar el resultado del requisito.
metricResults[]

object (MetricQueryResult)

Resultados de las métricas.
oldestMetricTimestamp

string (Timestamp format)

Marca de tiempo de la métrica calculada más antigua (es decir, la métrica más obsoleta). Indica que es posible que la result no refleje con precisión las actualizaciones de eventos y catálogos de productos realizadas después de esta hora.

Usa RFC 3339, donde la salida generada siempre se normaliza con Z y usa 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otros desplazamientos distintos de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
result

string

El resultado del requisito. Debe ser uno de los campos severity de la definición del requisito. Si se produce algún error durante la evaluación, será UNKNOWN.

Permisos de autorización

Debes disponer de uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta el Authentication Overview.

Requisito

Un requisito de datos.

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

string

El tipo de requisito, que se usa como identificador. Debe ser único.

El tipo debe tener como prefijo el nombre del servicio para evitar posibles conflictos. Te recomendamos que uses una agrupación jerárquica natural para requisitos similares.

Ejemplos:

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

string

Nombre del requisito.
description

string

La descripción del requisito.
condition

object (Expr)

Condición para evaluar el resultado del requisito.

Las variables de la expresión deben proporcionarse mediante metrics_bindings o thresholdBindings. Donde metrics_bindings se usa para las métricas calculadas y thresholdBindings se usa para definir los umbrales de los metricBindings correspondientes.
metricBindings[]

object (MetricBinding)

Lista de las vinculaciones de métricas que se van a usar en condition.
thresholdBindings[]

object (ThresholdBinding)

Lista de enlaces de umbral que se van a usar en condition.
violationSamplesBindings[]

object (ViolationSamplesBinding)

Lista de las vinculaciones de métricas que se van a usar en condition.
severity[]

string

La gravedad de los errores si no se cumple el requisito. Deben ordenarse de la más estricta a la menos estricta. Ejemplos:

  • BLOCKING
  • CRITICAL
  • WARNING

Todos los umbrales del requisito deben tener toda la gravedad aquí.

MetricBinding

Especifica una consulta de métricas y vincula su resultado a una variable que se usará en condition.

Representación JSON 
{
  "variableId": string,
  "resourceType": string,
  "metricFilter": string,
  "description": string,
  "category": string
}
Campos
variableId

string

ID de la variable a la que se hace referencia en condition.
resourceType

string

El recurso que se monitoriza para la métrica.
metricFilter

string

La cadena de filtro usada para la consulta de métricas.

Ejemplo:

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

string

Descripción legible de la métrica correspondiente.
category

string

Categoría del recurso de destino de la métrica. Ejemplo: "Eventos"

ThresholdBinding

Especifica un umbral multinivel que se aplicará a un metricBindings en la expresión CEL condition.

Representación JSON 
{
  "variableId": string,
  "description": string,
  "thresholdValues": [
    {
      object (ThresholdValue)
    }
  ]
}
Campos
variableId

string

ID de la variable a la que se hace referencia en condition. Debe ser único en todos los metricBindings y thresholdBindings.
description

string

Descripción legible por humanos del umbral y el subrequisito correspondientes.
thresholdValues[]

object (ThresholdValue)

Los valores del umbral. Los valores deben ordenarse de más estricto a menos estricto.

ThresholdValue

Especifica un valor de umbral para una gravedad determinada.

Representación JSON 
{
  "severity": string,
  "value": number
}
Campos
severity

string

La gravedad de los errores si no se alcanza el umbral. Debe ser uno de los campos severity del requisito.
value

number

Valor del umbral.

ViolationSamplesBinding

Especifica una consulta de ejemplos y vincula su resultado a una variable que se usará en condition.

Representación JSON 
{
  "variableId": string,
  "sampleFilter": string,
  "description": string
}
Campos
variableId

string

ID de la variable a la que se hace referencia en condition.
sampleFilter

string

La cadena de filtro utilizada para la consulta de ejemplos.

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

string

Descripción de este enlace de ejemplo. Usada por la interfaz de usuario para renderizar descripciones intuitivas de cada condición de requisito.

Debe tener menos de 128 caracteres.

MetricQueryResult

Resultado de la métrica. Las métricas se encuentran en requirementCondition.

Representación JSON 
{
  "name": string,
  "value": {
    object (TypedValue)
  },
  "timestamp": string,
  "unit": string,
  "metricType": string
}
Campos
name

string

Este nombre de consulta de métrica se asigna a variables de requirementCondition.
value

object (TypedValue)

Valor de la consulta de métricas.
timestamp

string (Timestamp format)

Hora en la que se calculó este valor de métrica.

Usa RFC 3339, donde la salida generada siempre se normaliza con Z y usa 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otros desplazamientos distintos de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
unit

string

Unidad en la que se registra esta métrica. Seguidores

Estándar Unified Code for Units of Measure.
metricType

string

Identificador de tipo de la métrica correspondiente a este resultado de consulta.