Updates a GTM Tag. Try it now.
Request
HTTP request
PUT https://www.googleapis.com/tagmanager/v2/path
Parameters
Parameter name | Value | Description |
---|---|---|
Path parameters | ||
path |
string |
GTM Tag's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/tags/{tag_id} |
Optional query parameters | ||
fingerprint |
string |
When provided, this fingerprint must match the fingerprint of the tag in storage. |
Authorization
This request requires authorization with the following scope:
Scope |
---|
https://www.googleapis.com/auth/tagmanager.edit.containers |
For more information, see the authentication and authorization page.
Request body
In the request body, supply a Tags resource with the following properties:
Property name | Value | Description | Notes |
---|---|---|---|
Required Properties | |||
consentSettings.consentType.type |
string |
The parameter type. Valid values are:
Acceptable values are:
|
writable |
monitoringMetadata.type |
string |
The parameter type. Valid values are:
Acceptable values are:
|
writable |
name |
string |
Tag display name. | writable |
parameter[].type |
string |
The parameter type. Valid values are:
Acceptable values are:
|
writable |
priority.type |
string |
The parameter type. Valid values are:
Acceptable values are:
|
writable |
type |
string |
GTM Tag Type. | writable |
Optional Properties | |||
blockingRuleId[] |
list |
Blocking rule IDs. If any of the listed rules evaluate to true, the tag will not fire. | writable |
blockingTriggerId[] |
list |
Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag will not fire. | writable |
consentSettings |
nested object |
Consent settings of a tag. | writable |
consentSettings.consentType.key |
string |
The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. | writable |
consentSettings.consentType.list[] |
list |
This list parameter's parameters (keys will be ignored). | writable |
consentSettings.consentType.map[] |
list |
This map parameter's parameters (must have keys; keys must be unique). | writable |
consentSettings.consentType.value |
string |
A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. | writable |
firingRuleId[] |
list |
Firing rule IDs. A tag will fire when any of the listed rules are true and all of its blockingRuleIds (if any specified) are false. |
writable |
firingTriggerId[] |
list |
Firing trigger IDs. A tag will fire when any of the listed triggers are true and all of its blockingTriggerIds (if any specified) are false. |
writable |
liveOnly |
boolean |
If set to true, this tag will only fire in the live environment (e.g. not in preview or debug mode). | writable |
monitoringMetadata |
nested object |
A map of key-value pairs of tag metadata to be included in the event data for tag monitoring. Notes:
|
writable |
monitoringMetadata.key |
string |
The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. | writable |
monitoringMetadata.list[] |
list |
This list parameter's parameters (keys will be ignored). | writable |
monitoringMetadata.map[] |
list |
This map parameter's parameters (must have keys; keys must be unique). | writable |
monitoringMetadata.value |
string |
A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. | writable |
monitoringMetadataTagNameKey |
string |
If non-empty, then the tag display name will be included in the monitoring metadata map using the key specified. | writable |
notes |
string |
User notes on how to apply this tag in the container. | writable |
parameter[] |
list |
The tag's parameters. | writable |
parameter[].key |
string |
The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. | writable |
parameter[].list[] |
list |
This list parameter's parameters (keys will be ignored). | writable |
parameter[].map[] |
list |
This map parameter's parameters (must have keys; keys must be unique). | writable |
parameter[].value |
string |
A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. | writable |
paused |
boolean |
Indicates whether the tag is paused, which prevents the tag from firing. | writable |
priority |
nested object |
User defined numeric priority of the tag. Tags are fired asynchronously in order of priority. Tags with higher numeric value fire first. A tag's priority can be a positive or negative value. The default value is 0. | writable |
priority.key |
string |
The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. | writable |
priority.list[] |
list |
This list parameter's parameters (keys will be ignored). | writable |
priority.map[] |
list |
This map parameter's parameters (must have keys; keys must be unique). | writable |
priority.value |
string |
A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. | writable |
scheduleEndMs |
long |
The end timestamp in milliseconds to schedule a tag. | writable |
scheduleStartMs |
long |
The start timestamp in milliseconds to schedule a tag. | writable |
Response
If successful, this method returns a Tags resource in the response body.
Try it!
Use the APIs Explorer below to call this method on live data and see the response.