Data Catalog API methods that are related to Data Catalog search and metadata are deprecated and will be discontinued on January 30, 2026. See Transition from Data Catalog to Dataplex Universal Catalog. Methods that are related to policy tags and policy tag taxonomies are not deprecated.
A tag template defines a tag that can have one or more typed fields.
The template is used to create tags that are attached to Google Cloud resources. Tag template roles provide permissions to create, edit, and use the template. For example, see the TagTemplate User role that includes a permission to use the tag template to tag resources.
Identifier. The resource name of the tag template in URL format.
Note: The tag template itself and its child resources might not be stored in the location specified in its name.
displayName
string
Display name for this template. Defaults to an empty string.
The name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and can't start or end with spaces. The maximum length is 200 characters.
isPubliclyReadable
boolean
Indicates whether tags created with this template are public. Public tags do not require tag template access to appear in ListTags API response.
Additionally, you can search for a public tag by value with a simple search query in addition to using a tag: predicate.
Required. Map of tag template field IDs to the settings for the field. This map is an exhaustive list of the allowed fields. The map must contain at least one field and at most 500 fields.
The keys to this map are tag template field IDs. The IDs have the following limitations:
Can contain uppercase and lowercase letters, numbers (0-9) and underscores (_).
Must be at least 1 character and at most 64 characters long.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-17 UTC."],[[["\u003cp\u003eA TagTemplate defines a tag with one or more typed fields, used to create tags for Google Cloud resources, and permissions to manage these tags are provided by tag template roles.\u003c/p\u003e\n"],["\u003cp\u003eThe JSON representation of a TagTemplate includes properties like \u003ccode\u003ename\u003c/code\u003e, \u003ccode\u003edisplayName\u003c/code\u003e, \u003ccode\u003eisPubliclyReadable\u003c/code\u003e, \u003ccode\u003efields\u003c/code\u003e, and \u003ccode\u003edataplexTransferStatus\u003c/code\u003e, each with specific data types and requirements.\u003c/p\u003e\n"],["\u003cp\u003eTagTemplate fields can be configured with specific IDs and the fields can include a variety of settings for each field, and it must include at least 1 field, and a max of 500.\u003c/p\u003e\n"],["\u003cp\u003eSeveral deprecated methods exist for interacting with TagTemplates, including \u003ccode\u003ecreate\u003c/code\u003e, \u003ccode\u003edelete\u003c/code\u003e, \u003ccode\u003eget\u003c/code\u003e, \u003ccode\u003egetIamPolicy\u003c/code\u003e, \u003ccode\u003epatch\u003c/code\u003e, \u003ccode\u003esetIamPolicy\u003c/code\u003e, and \u003ccode\u003etestIamPermissions\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# REST Resource: projects.locations.tagTemplates\n\n- [Resource: TagTemplate](#TagTemplate)\n - [JSON representation](#TagTemplate.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: TagTemplate\n---------------------\n\nA tag template defines a tag that can have one or more typed fields.\n\nThe template is used to create tags that are attached to Google Cloud resources. [Tag template roles](https://cloud.google.com/iam/docs/understanding-roles#data-catalog-roles) provide permissions to create, edit, and use the template. For example, see the [TagTemplate User](https://cloud.google.com/data-catalog/docs/how-to/template-user) role that includes a permission to use the tag template to tag resources."]]
