REST Resource: projects.locations.dataStores.controls

Ressource : Control

Définit un comportement conditionnel à utiliser lors de la diffusion. Doit être associé à un ServingConfig pour être pris en compte au moment de la diffusion. Actions autorisées en fonction de SolutionType.

Représentation JSON 
{
  "name": string,
  "displayName": string,
  "associatedServingConfigIds": [
    string
  ],
  "solutionType": enum (SolutionType),
  "useCases": [
    enum (SearchUseCase)
  ],
  "conditions": [
    {
      object (Condition)
    }
  ],

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "boostAction": {
    object (BoostAction)
  },
  "filterAction": {
    object (FilterAction)
  },
  "redirectAction": {
    object (RedirectAction)
  },
  "synonymsAction": {
    object (SynonymsAction)
  },
  "promoteAction": {
    object (PromoteAction)
  }
  // End of mutually exclusive fields.
}
Champs
name

string

Immuable. Nom complet projects/*/locations/global/dataStore/*/controls/*
displayName

string

Obligatoire. Nom lisible. Identifiant utilisé dans les vues de l'interface utilisateur.

Doit être une chaîne encodée au format UTF-8. La longueur maximale est de 128 caractères. Dans le cas contraire, une erreur INVALID ARGUMENT est renvoyée.
associatedServingConfigIds[]

string

Uniquement en sortie. Liste de tous les ID ServingConfig auxquels cette commande est associée. La mise à jour peut prendre jusqu'à 10 minutes après les modifications.
solutionType

enum (SolutionType)

Obligatoire. Immuable. Solution à laquelle appartient la commande.

Doit être compatible avec le secteur vertical de la ressource. Dans le cas contraire, une erreur INVALID ARGUMENT est renvoyée.
useCases[]

enum (SearchUseCase)

Spécifie le cas d'utilisation de la commande. Affecte les champs de condition qui peuvent être définis. S'applique uniquement à SOLUTION_TYPE_SEARCH. Actuellement, un seul cas d'utilisation est autorisé par commande. Doit être défini lorsque solutionType est SolutionType.SOLUTION_TYPE_SEARCH.
conditions[]

object (Condition)

Détermine le moment où l'action associée sera déclenchée.

Omettez cette option pour toujours appliquer l'action. Actuellement, une seule condition peut être spécifiée. Dans le cas contraire, une erreur INVALID ARGUMENT est renvoyée.
Voici une liste de champs mutuellement exclusifs. Au maximum, un seul de ces champs sera défini dans une réponse :
boostAction

object (BoostAction)

Définit une commande de type "boost".
filterAction

object (FilterAction)

Définit une commande de type "filtre". N'est actuellement pas compatible avec Recommendation.
redirectAction

object (RedirectAction)

Définit une commande de type "redirection".
synonymsAction

object (SynonymsAction)

Traite un groupe de termes comme des synonymes.
promoteAction

object (PromoteAction)

Met en avant certains liens en fonction de requêtes de déclenchement prédéfinies.
Fin des champs mutuellement exclusifs.

Méthodes

create

 Crée une commande.

delete

 Supprime une commande.

get

 Récupère une commande.

list

 Liste toutes les commandes par leur DataStore parent.

patch

 Met à jour une commande.