Data Catalog API methods that are related to Data Catalog search and metadata are deprecated and will be discontinued on June 1, 2026. See Transition from Data Catalog to Knowledge Catalog. Methods that are related to policy tags and policy tag taxonomies are not deprecated.

Method: projects.locations.tagTemplates.fields.delete

Deletes a field in a tag template and all uses of this field from the tags based on this template.

You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project.

HTTP request

DELETE https://datacatalog.googleapis.com/v1/{name}

Path parameters

Parameters

Parameters
`name`	`string` Required. The name of the tag template field to delete. It takes the form `projects/{project}/locations/{location}/tagTemplates/{tagtemplate}/fields/{field}`.

name

string

Required. The name of the tag template field to delete. It takes the form projects/{project}/locations/{location}/tagTemplates/{tagtemplate}/fields/{field}.

Query parameters

Parameters

Parameters
`force`	`boolean` Required. If true, deletes this field from any tags that use it. Currently, `true` is the only supported value.

force

boolean

Required. If true, deletes this field from any tags that use it.

Currently, true is the only supported value.

Request body

The request body must be empty.

Response body

If successful, the response body is an empty JSON object.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.