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)
    }
  ],

  // Union field action can be only one of the following:
  "boostAction": {
    object (BoostAction)
  },
  "filterAction": {
    object (FilterAction)
  },
  "redirectAction": {
    object (RedirectAction)
  },
  "synonymsAction": {
    object (SynonymsAction)
  },
  "promoteAction": {
    object (PromoteAction)
  }
  // End of list of possible types for union field action.
}
Champs
name

string

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

string

Obligatoire. Nom lisible par un humain. 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 ce contrôle est associé. La mise à jour peut prendre jusqu'à 10 minutes après les modifications.
solutionType

enum (SolutionType)

Obligatoire. Immuable. Solution à laquelle appartient le contrôle.

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

enum (SearchUseCase)

Spécifie le cas d'utilisation du contrôle. 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 contrôle. 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.

Champ d'union action. Les actions sont limitées par la verticale et la solution.

Obligatoire. action ne peut être qu'un des éléments suivants :
boostAction

object (BoostAction)

Définit un contrôle de type boost.
filterAction

object (FilterAction)

Définit un contrôle de type filtre. Actuellement non compatible avec Recommendation.
redirectAction

object (RedirectAction)

Définit un contrôle 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.

Méthodes

create

 Crée un contrôle.

delete

 Supprime un contrôle.

get

 Obtient un contrôle.

list

 Liste tous les contrôles par DataStore parent.

patch

 Met à jour un contrôle.