REST Resource: projects.tenants

Ressource: Locataire

Une ressource de locataire représente un locataire dans le service. Un locataire est un groupe ou une entité qui partage un accès commun à des ressources telles que des profils avec des droits spécifiques. Le Client peut créer plusieurs locataires afin d'isoler les données de différents groupes.

Représentation JSON 
{
  "name": string,
  "externalId": string,
  "usageType": enum (DataUsageType),
  "keywordSearchableProfileCustomAttributes": [
    string
  ]
}
Champs
name

string

Obligatoire pendant la mise à jour du locataire.

Nom de ressource d'un locataire. Il est généré par le service lors de la création d'un locataire.

Le format est "projects/{projectId}/tenants/{tenantId}". Par exemple, "projects/foo/tenants/bar".
externalId

string

Obligatoire. Identifiant du locataire côté client, permettant d'identifier le locataire de manière unique.

Le nombre maximal de caractères autorisés est de 255.
usageType

enum (DataUsageType)

Indique si les données appartenant à ce locataire peuvent être utilisées pour améliorer le produit pour d'autres locataires.

Si la règle n'est pas configurée, le comportement par défaut est DataUsageType.ISOLATED.
keywordSearchableProfileCustomAttributes[]

string

Liste de clés de Profile.custom_attributes filtrables, dont les stringValues correspondantes sont utilisées dans les recherches par mots clés. Les profils avec stringValues sous ces clés de champ spécifiées sont renvoyés si l'une des valeurs correspond au mot clé de recherche. Les valeurs des champs personnalisés comportant des parenthèses, des crochets et des symboles spéciaux ne peuvent pas faire l'objet d'une recherche en l'état et doivent être entourées de guillemets.

DataUsageType

Énumération représentant la manière dont les données utilisateur appartenant au locataire sont utilisées.

Enums
DATA_USAGE_TYPE_UNSPECIFIED Valeur par défaut.
AGGREGATED Les données appartenant à ce locataire sont utilisées pour améliorer la qualité de la recherche/recommandation entre les locataires.
ISOLATED Les données appartenant à ce locataire sont utilisées pour améliorer la qualité de la recherche/recommandation pour ce locataire uniquement.

Méthodes

complete

 Complète le préfixe spécifié par des suggestions de mots clés.

create

 Crée une entité locataire.

delete

 Supprime le locataire spécifié.

get

 Récupère le locataire spécifié.

list

 Répertorie tous les locataires associés au projet.

patch

 Met à jour le locataire spécifié.