REST Resource: projects.tenants

Recurso: locatário

Um recurso de locatário representa um locatário no serviço. Um locatário é um grupo ou uma entidade que compartilha o acesso comum com privilégios específicos para recursos como perfis. O cliente pode criar vários locatários para fornecer isolamento de dados para grupos diferentes.

Representação JSON 
{
  "name": string,
  "externalId": string,
  "usageType": enum (DataUsageType),
  "keywordSearchableProfileCustomAttributes": [
    string
  ]
}
Campos
name

string

Obrigatório durante a atualização do locatário.

O nome do recurso para um locatário. Ele é gerado pelo serviço quando um locatário é criado.

O formato é "projects/{projectId}/tenants/{tenantId}", por exemplo, "projects/foo/tenants/bar".
externalId

string

Obrigatório. Identificador de locatário do lado do cliente, usado para identificar exclusivamente o locatário.

O número máximo de caracteres permitido é 255.
usageType

enum (DataUsageType)

Indica se os dados de propriedade deste locatário podem ser usados para fornecer melhorias de produtos em outros locatários.

Se não for definido, o comportamento padrão será DataUsageType.ISOLATED.
keywordSearchableProfileCustomAttributes[]

string

Uma lista de chaves de Profile.custom_attributes filtrável, com stringValues correspondente usada em pesquisas por palavra-chave. Os perfis com stringValues nessas chaves de campo especificadas serão retornados se algum dos valores corresponder à palavra-chave de pesquisa. Os valores de campo personalizados com parênteses, colchetes e símbolos especiais não são pesquisáveis no estado em que se encontram e precisam estar entre aspas.

DataUsageType

Enumeração que representa como os dados do usuário pertencentes ao locatário são usados.

Enums
DATA_USAGE_TYPE_UNSPECIFIED Valor padrão.
AGGREGATED Os dados de propriedade deste locatário são usados para melhorar a qualidade da pesquisa/recomendação entre locatários.
ISOLATED Os dados de propriedade deste locatário são usados para melhorar a qualidade da pesquisa/recomendação apenas para este locatário.

Métodos

complete

 Completa o prefixo especificado com sugestões de palavras-chave.

create

 Cria uma nova entidade de locatário.

delete

 Exclui o locatário especificado.

get

 Recupera o locatário especificado.

list

 Lista todos os locatários associados ao projeto.

patch

 Atualiza o locatário especificado.