Method: projects.locations.requirements.checkRequirement

Verificar un requisito en particular

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
location

string

Obligatorio. Es el 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 con la siguiente estructura:

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

string

Es el tipo que especifica el requisito que se debe verificar. 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)

Son los recursos que se verificarán para este requisito. El tipo necesario para los recursos supervisados:

  • 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

Es la respuesta del método requirements.checkRequirement.

Si se ejecuta correctamente, el cuerpo de la respuesta contiene 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)

Es la condición para evaluar el resultado del requisito.
metricResults[]

object (MetricQueryResult)

Son los resultados de las métricas.
oldestMetricTimestamp

string (Timestamp format)

Es la marca de tiempo de la métrica calculada más antigua (es decir, la métrica más desactualizada). Indica que es posible que result no refleje con precisión las actualizaciones del Catálogo de productos y eventos que se realizaron después de este momento.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
result

string

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

Permisos de autorización

Se necesita 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 Authentication Overview.

Requisito

Es 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

Es 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 colisiones. Se recomienda usar agrupaciones jerárquicas naturales para requisitos similares.

Ejemplos:

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

string

Es el nombre del requisito.
description

string

Es la descripción del requisito.
condition

object (Expr)

Es la condición para evaluar el resultado del requisito.

metrics_bindings o thresholdBindings deben proporcionar las variables de la expresión. Aquí, metrics_bindings se usa para las métricas calculadas y thresholdBindings se usa para definir los umbrales de los metricBindings correspondientes.
metricBindings[]

object (MetricBinding)

Es una lista de las vinculaciones de métricas que se usarán en condition.
thresholdBindings[]

object (ThresholdBinding)

Es una lista de vinculaciones de umbral que se usarán en condition.
violationSamplesBindings[]

object (ViolationSamplesBinding)

Es una lista de las vinculaciones de métricas que se usarán en condition.
severity[]

string

Es la gravedad de los errores si no se cumple el requisito. Debe 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

Es el ID de la variable al que se hará referencia en condition.
resourceType

string

Es el recurso que se supervisa para la métrica.
metricFilter

string

Es la cadena de filtro que se usa para la consulta de métricas.

Ejemplo:

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

string

Es la descripción legible del filtro de métricas correspondiente.
category

string

Es la categoría del recurso objetivo de la métrica. Ejemplo: "Eventos"

ThresholdBinding

Especifica un umbral de varios niveles para aplicar a un metricBindings en la expresión CEL condition.

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

string

Es el ID de la variable al que se hará referencia en condition. Debe ser único en todos los metricBindings y thresholdBindings.
description

string

Es una descripción legible del umbral y el subrequisito correspondientes.
thresholdValues[]

object (ThresholdValue)

Son los valores del umbral. Los valores deben ordenarse del más estricto al menos estricto.

ThresholdValue

Especifica un valor de umbral para una gravedad determinada.

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

string

Es la gravedad de los errores si no se cumple el umbral. Debe ser uno de los campos severity del requisito.
value

number

Es el valor del umbral.

ViolationSamplesBinding

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

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

string

Es el ID de la variable al que se hará referencia en condition.
sampleFilter

string

Es la cadena de filtro que se usa para la consulta de muestras.

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

string

Es la descripción de esta vinculación de muestra. La IU lo usa para renderizar descripciones fáciles de entender para cada condición de requisito.

Debe tener menos de 128 caracteres.

MetricQueryResult

Es el 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

El nombre de esta consulta de métricas se asigna a variables en requirementCondition.
value

object (TypedValue)

Es el valor de la consulta de métricas.
timestamp

string (Timestamp format)

Es la fecha y hora en que se calculó este valor de la métrica.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “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 informa esta métrica. Sigue a

Estándar The Unified Code for Units of Measure
metricType

string

Es el identificador de tipo de la métrica correspondiente a este resultado de la búsqueda.