REST Resource: projects.tenants

资源：租户

租户资源代表服务中的租户。租户是一个群组或实体，对个人资料等资源拥有共同的访问权限，并具有特定权限。客户可以创建多个租户，为不同的群组提供数据隔离。

JSON 表示法 
{
  "name": string,
  "externalId": string,
  "usageType": enum (DataUsageType),
  "keywordSearchableProfileCustomAttributes": [
    string
  ]
}
字段
name

string

更新租户期间需要执行此操作。

租户的资源名称。此名称由服务在创建租户时生成。

格式为“projects/{projectId}/tenants/{tenantId}”，例如“projects/foo/tenants/bar”。
externalId

string

必需。客户端租户标识符，用于唯一标识租户。

允许的最大字符数为 255。
usageType

enum (DataUsageType)

指明此租户所拥有的数据是否可以用于为其他租户提供产品改进。

如果未设置，则默认行为为 DataUsageType.ISOLATED。
keywordSearchableProfileCustomAttributes[]

string

可过滤 Profile.custom_attributes 的键列表，其对应的 stringValues 用于关键字搜索。如果有任何值与搜索关键字匹配，则返回这些指定字段键下包含 stringValues 的个人资料。带圆括号、方括号和特殊符号的自定义字段值不能按原样搜索，必须用引号括起来。

DataUsageType

表示如何使用租户所拥有的用户数据的枚举。

枚举
DATA_USAGE_TYPE_UNSPECIFIED 默认值。
AGGREGATED 此租户所拥有的数据用于提高跨租户的搜索/推荐质量。
ISOLATED 此租户拥有的数据仅用于提高此租户的搜索/推荐质量。

方法

complete

 使用关键字建议补全指定的前缀。

create

 创建新的租户实体。

delete

 删除指定的租户。

get

 检索指定的租户。

list

 列出与项目关联的所有租户。

patch

 更新指定的租户。