Class Tenant (2.13.2)

Tenant(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A Tenant resource represents a tenant in the service. A tenant is a group or entity that shares common access with specific privileges for resources like profiles. Customer may create multiple tenants to provide data isolation for different groups.


name str
Required during tenant update. The resource name for a tenant. This is generated by the service when a tenant is created. The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenants/bar".
external_id str
Required. Client side tenant identifier, used to uniquely identify the tenant. The maximum number of allowed characters is 255.
Indicates whether data owned by this tenant may be used to provide product improvements across other tenants. Defaults behavior is DataUsageType.ISOLATED if it's unset.
keyword_searchable_profile_custom_attributes MutableSequence[str]
A list of keys of filterable Profile.custom_attributes, whose corresponding string_values are used in keyword searches. Profiles with string_values under these specified field keys are returned if any of the values match the search keyword. Custom field values with parenthesis, brackets and special symbols are not searchable as-is, and must be surrounded by quotes.




Enum that represents how user data owned by the tenant is used.

Values: DATA_USAGE_TYPE_UNSPECIFIED (0): Default value. AGGREGATED (1): Data owned by this tenant is used to improve search/recommendation quality across tenants. ISOLATED (2): Data owned by this tenant is used to improve search/recommendation quality for this tenant only.