Method: projects.locations.requirements.checkRequirement

Vérifiez une exigence particulière.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
location

string

Obligatoire. Nom complet de la ressource de l'emplacement. Format : projects/{project_number_or_id}/locations/{location}

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "requirementType": string,
  "resources": [
    {
      object (MonitoredResource)
    }
  ]
}
Champs
requirementType

string

Type spécifiant l'exigence à vérifier. Voici les types acceptés :

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

Ressources à vérifier pour cette exigence. Type requis pour les ressources surveillées :

  • discoveryengine.googleapis.com/Branch.

    • Libellés nécessaires pour cette ressource :
      • project_number
      • location_id
      • collection_id
      • datastore_id
      • branch_id

  • discoveryengine.googleapis.com/DataStore

    • Libellés nécessaires pour cette ressource :
      • project_number
      • location_id
      • collection_id
      • datastore_id

Corps de la réponse

Réponse pour la méthode requirements.checkRequirement.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "requirement": {
    object (Requirement)
  },
  "requirementCondition": {
    object (Expr)
  },
  "metricResults": [
    {
      object (MetricQueryResult)
    }
  ],
  "oldestMetricTimestamp": string,
  "result": string
}
Champs
requirement

object (Requirement)

Définition des exigences.
requirementCondition

object (Expr)

Condition pour évaluer le résultat de l'exigence.
metricResults[]

object (MetricQueryResult)

Résultats des métriques.
oldestMetricTimestamp

string (Timestamp format)

Code temporel de la métrique calculée la plus ancienne (c'est-à-dire la plus obsolète). Indique que result peut ne pas refléter précisément les mises à jour des catalogues d'événements et de produits effectuées après cette heure.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
result

string

Résultat de l'exigence. Il doit s'agir de l'un des champs severity de la définition des exigences. Si une erreur se produit lors de l'évaluation, la valeur sera UNKNOWN.

Niveaux d'accès des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour plus d'informations, consultez la Authentication Overview.

Exigence

Exigence de données.

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

string

Type d'exigence, utilisé comme identifiant. Il doit être unique.

Le type doit être précédé du nom du service pour éviter toute collision. Il est recommandé d'utiliser un regroupement hiérarchique naturel pour les exigences similaires.

Exemples :

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

string

Nom de l'exigence.
description

string

Description de l'exigence.
condition

object (Expr)

Condition pour évaluer le résultat de l'exigence.

Les variables de l'expression doivent être fournies par metrics_bindings ou thresholdBindings. metrics_bindings est utilisé pour les métriques calculées et thresholdBindings pour définir les seuils des metricBindings correspondants.
metricBindings[]

object (MetricBinding)

Liste des liaisons de métriques à utiliser dans condition.
thresholdBindings[]

object (ThresholdBinding)

Liste des liaisons de seuil à utiliser dans condition.
violationSamplesBindings[]

object (ViolationSamplesBinding)

Liste des liaisons de métriques à utiliser dans condition.
severity[]

string

Gravité des erreurs si l'exigence n'est pas respectée. Ils doivent être classés du plus strict au moins strict. Exemples :

  • BLOCKING
  • CRITICAL
  • WARNING

Tous les seuils de l'exigence doivent avoir le même niveau de gravité.

MetricBinding

Spécifie une requête de métriques et lie son résultat à une variable qui sera utilisée dans condition.

Représentation JSON 
{
  "variableId": string,
  "resourceType": string,
  "metricFilter": string,
  "description": string,
  "category": string
}
Champs
variableId

string

ID de la variable à référencer dans condition.
resourceType

string

Ressource surveillée pour la métrique.
metricFilter

string

Chaîne de filtre utilisée pour la requête de métriques.

Exemple :

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

string

Description lisible du filtre de métrique correspondant.
category

string

Catégorie de la ressource cible de la métrique. Exemple : "Événements"

ThresholdBinding

Spécifie un seuil à plusieurs niveaux à appliquer à un metricBindings dans l'expression CEL condition.

Représentation JSON 
{
  "variableId": string,
  "description": string,
  "thresholdValues": [
    {
      object (ThresholdValue)
    }
  ]
}
Champs
variableId

string

ID de la variable à référencer dans condition. Doit être unique dans tous les metricBindings et thresholdBindings.
description

string

Description lisible du seuil et de la sous-exigence correspondants.
thresholdValues[]

object (ThresholdValue)

Valeurs du seuil. Les valeurs doivent être classées de la plus stricte à la moins stricte.

ThresholdValue

Spécifie une valeur seuil pour une gravité donnée.

Représentation JSON 
{
  "severity": string,
  "value": number
}
Champs
severity

string

Gravité des erreurs si le seuil n'est pas atteint. Il doit s'agir de l'un des champs severity de l'exigence.
value

number

Valeur du seuil.

ViolationSamplesBinding

Spécifie une requête d'échantillons et lie son résultat à une variable qui sera utilisée dans condition.

Représentation JSON 
{
  "variableId": string,
  "sampleFilter": string,
  "description": string
}
Champs
variableId

string

ID de la variable à référencer dans condition.
sampleFilter

string

Chaîne de filtre utilisée pour la requête d'échantillons.

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

string

Description de cet exemple de liaison. Utilisé par l'UI pour afficher des descriptions conviviales pour chaque condition requise.

ne doit pas dépasser 128 caractères ;

MetricQueryResult

Résultat de la métrique. Les métriques se trouvent dans requirementCondition.

Représentation JSON 
{
  "name": string,
  "value": {
    object (TypedValue)
  },
  "timestamp": string,
  "unit": string,
  "metricType": string
}
Champs
name

string

Le nom de cette requête de métrique correspond aux variables de requirementCondition.
value

object (TypedValue)

Valeur de la requête de métrique.
timestamp

string (Timestamp format)

Heure à laquelle la valeur de cette métrique a été calculée.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
unit

string

Unité dans laquelle cette métrique est exprimée. Abonnés

Norme Code unifié des unités de mesure.
metricType

string

Identifiant de type de la métrique correspondant à ce résultat de requête.