{ "discoveryVersion": "v1", "id": "tagmanager:v1", "ownerName": "Google", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/tagmanager.publish": { "description": "Publish your Google Tag Manager container versions" }, "https://www.googleapis.com/auth/tagmanager.readonly": { "description": "View your Google Tag Manager container and its subcomponents" }, "https://www.googleapis.com/auth/tagmanager.edit.containers": { "description": "Manage your Google Tag Manager container and its subcomponents, excluding versioning and publishing" }, "https://www.googleapis.com/auth/tagmanager.edit.containerversions": { "description": "Manage your Google Tag Manager container versions" }, "https://www.googleapis.com/auth/tagmanager.manage.users": { "description": "Manage user permissions of your Google Tag Manager account and container" }, "https://www.googleapis.com/auth/tagmanager.delete.containers": { "description": "Delete your Google Tag Manager containers" }, "https://www.googleapis.com/auth/tagmanager.manage.accounts": { "description": "View and manage your Google Tag Manager accounts" } } } }, "version": "v1", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "documentationLink": "https://developers.google.com/tag-manager", "resources": { "accounts": { "methods": { "update": { "flatPath": "tagmanager/v1/accounts/{accountId}", "request": { "$ref": "Account" }, "id": "tagmanager.accounts.update", "parameterOrder": [ "accountId" ], "httpMethod": "PUT", "parameters": { "accountId": { "description": "The GTM Account ID.", "required": true, "type": "string", "location": "path" }, "fingerprint": { "location": "query", "type": "string", "description": "When provided, this fingerprint must match the fingerprint of the account in storage." } }, "description": "Updates a GTM Account.", "path": "tagmanager/v1/accounts/{accountId}", "scopes": [ "https://www.googleapis.com/auth/tagmanager.manage.accounts" ], "response": { "$ref": "Account" } }, "get": { "path": "tagmanager/v1/accounts/{accountId}", "parameters": { "accountId": { "location": "path", "type": "string", "description": "The GTM Account ID.", "required": true } }, "description": "Gets a GTM Account.", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.manage.accounts", "https://www.googleapis.com/auth/tagmanager.readonly" ], "response": { "$ref": "Account" }, "flatPath": "tagmanager/v1/accounts/{accountId}", "id": "tagmanager.accounts.get", "httpMethod": "GET", "parameterOrder": [ "accountId" ] }, "list": { "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.manage.accounts", "https://www.googleapis.com/auth/tagmanager.readonly" ], "path": "tagmanager/v1/accounts", "parameters": {}, "description": "Lists all GTM Accounts that a user has access to.", "response": { "$ref": "ListAccountsResponse" }, "id": "tagmanager.accounts.list", "flatPath": "tagmanager/v1/accounts", "httpMethod": "GET", "parameterOrder": [] } }, "resources": { "containers": { "methods": { "list": { "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "path": "tagmanager/v1/accounts/{accountId}/containers", "parameters": { "accountId": { "type": "string", "description": "The GTM Account ID.", "required": true, "location": "path" } }, "description": "Lists all Containers that belongs to a GTM Account.", "response": { "$ref": "ListContainersResponse" }, "id": "tagmanager.accounts.containers.list", "flatPath": "tagmanager/v1/accounts/{accountId}/containers", "httpMethod": "GET", "parameterOrder": [ "accountId" ] }, "get": { "parameters": { "accountId": { "location": "path", "description": "The GTM Account ID.", "required": true, "type": "string" }, "containerId": { "description": "The GTM Container ID.", "required": true, "type": "string", "location": "path" } }, "description": "Gets a Container.", "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "response": { "$ref": "Container" }, "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}", "id": "tagmanager.accounts.containers.get", "parameterOrder": [ "accountId", "containerId" ], "httpMethod": "GET" }, "update": { "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "parameters": { "fingerprint": { "location": "query", "description": "When provided, this fingerprint must match the fingerprint of the container in storage.", "type": "string" }, "accountId": { "location": "path", "description": "The GTM Account ID.", "required": true, "type": "string" }, "containerId": { "description": "The GTM Container ID.", "required": true, "type": "string", "location": "path" } }, "description": "Updates a Container.", "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}", "response": { "$ref": "Container" }, "id": "tagmanager.accounts.containers.update", "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}", "request": { "$ref": "Container" }, "parameterOrder": [ "accountId", "containerId" ], "httpMethod": "PUT" }, "delete": { "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}", "parameters": { "accountId": { "location": "path", "type": "string", "description": "The GTM Account ID.", "required": true }, "containerId": { "type": "string", "description": "The GTM Container ID.", "required": true, "location": "path" } }, "description": "Deletes a Container.", "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}", "scopes": [ "https://www.googleapis.com/auth/tagmanager.delete.containers" ], "id": "tagmanager.accounts.containers.delete", "parameterOrder": [ "accountId", "containerId" ], "httpMethod": "DELETE" }, "create": { "id": "tagmanager.accounts.containers.create", "flatPath": "tagmanager/v1/accounts/{accountId}/containers", "request": { "$ref": "Container" }, "parameterOrder": [ "accountId" ], "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "parameters": { "accountId": { "description": "The GTM Account ID.", "required": true, "type": "string", "location": "path" } }, "description": "Creates a Container.", "path": "tagmanager/v1/accounts/{accountId}/containers", "response": { "$ref": "Container" } } }, "resources": { "reauthorize_environments": { "methods": { "update": { "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/reauthorize_environments/{environmentId}", "request": { "$ref": "Environment" }, "id": "tagmanager.accounts.containers.reauthorize_environments.update", "httpMethod": "PUT", "parameterOrder": [ "accountId", "containerId", "environmentId" ], "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/reauthorize_environments/{environmentId}", "parameters": { "accountId": { "location": "path", "description": "The GTM Account ID.", "required": true, "type": "string" }, "containerId": { "description": "The GTM Container ID.", "required": true, "type": "string", "location": "path" }, "environmentId": { "location": "path", "type": "string", "description": "The GTM Environment ID.", "required": true } }, "description": "Re-generates the authorization code for a GTM Environment.", "scopes": [ "https://www.googleapis.com/auth/tagmanager.publish" ], "response": { "$ref": "Environment" } } } }, "versions": { "methods": { "restore": { "response": { "$ref": "ContainerVersion" }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "parameters": { "accountId": { "location": "path", "description": "The GTM Account ID.", "required": true, "type": "string" }, "containerId": { "location": "path", "description": "The GTM Container ID.", "required": true, "type": "string" }, "containerVersionId": { "location": "path", "type": "string", "description": "The GTM Container Version ID.", "required": true } }, "description": "Restores a Container Version. This will overwrite the container's current configuration (including its variables, triggers and tags). The operation will not have any effect on the version that is being served (i.e. the published version).", "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/versions/{containerVersionId}/restore", "parameterOrder": [ "accountId", "containerId", "containerVersionId" ], "httpMethod": "POST", "id": "tagmanager.accounts.containers.versions.restore", "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/versions/{containerVersionId}/restore" }, "create": { "response": { "$ref": "CreateContainerVersionResponse" }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containerversions" ], "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/versions", "parameters": { "accountId": { "location": "path", "description": "The GTM Account ID.", "required": true, "type": "string" }, "containerId": { "location": "path", "description": "The GTM Container ID.", "required": true, "type": "string" } }, "description": "Creates a Container Version.", "httpMethod": "POST", "parameterOrder": [ "accountId", "containerId" ], "id": "tagmanager.accounts.containers.versions.create", "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/versions", "request": { "$ref": "CreateContainerVersionRequestVersionOptions" } }, "list": { "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/versions", "id": "tagmanager.accounts.containers.versions.list", "httpMethod": "GET", "parameterOrder": [ "accountId", "containerId" ], "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/versions", "parameters": { "accountId": { "description": "The GTM Account ID.", "required": true, "type": "string", "location": "path" }, "containerId": { "location": "path", "description": "The GTM Container ID.", "required": true, "type": "string" }, "headers": { "default": "false", "location": "query", "type": "boolean", "description": "Retrieve headers only when true." }, "includeDeleted": { "description": "Also retrieve deleted (archived) versions when true.", "type": "boolean", "default": "false", "location": "query" } }, "description": "Lists all Container Versions of a GTM Container.", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.edit.containerversions", "https://www.googleapis.com/auth/tagmanager.readonly" ], "response": { "$ref": "ListContainerVersionsResponse" } }, "get": { "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/versions/{containerVersionId}", "parameters": { "accountId": { "location": "path", "type": "string", "description": "The GTM Account ID.", "required": true }, "containerId": { "type": "string", "description": "The GTM Container ID.", "required": true, "location": "path" }, "containerVersionId": { "type": "string", "description": "The GTM Container Version ID. Specify published to retrieve the currently published version.", "required": true, "location": "path" } }, "description": "Gets a Container Version.", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.edit.containerversions", "https://www.googleapis.com/auth/tagmanager.readonly" ], "response": { "$ref": "ContainerVersion" }, "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/versions/{containerVersionId}", "id": "tagmanager.accounts.containers.versions.get", "httpMethod": "GET", "parameterOrder": [ "accountId", "containerId", "containerVersionId" ] }, "publish": { "id": "tagmanager.accounts.containers.versions.publish", "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/versions/{containerVersionId}/publish", "parameterOrder": [ "accountId", "containerId", "containerVersionId" ], "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/tagmanager.publish" ], "parameters": { "accountId": { "description": "The GTM Account ID.", "required": true, "type": "string", "location": "path" }, "containerId": { "type": "string", "description": "The GTM Container ID.", "required": true, "location": "path" }, "containerVersionId": { "description": "The GTM Container Version ID.", "required": true, "type": "string", "location": "path" }, "fingerprint": { "location": "query", "type": "string", "description": "When provided, this fingerprint must match the fingerprint of the container version in storage." } }, "description": "Publishes a Container Version.", "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/versions/{containerVersionId}/publish", "response": { "$ref": "PublishContainerVersionResponse" } }, "update": { "response": { "$ref": "ContainerVersion" }, "parameters": { "fingerprint": { "description": "When provided, this fingerprint must match the fingerprint of the container version in storage.", "type": "string", "location": "query" }, "accountId": { "location": "path", "type": "string", "description": "The GTM Account ID.", "required": true }, "containerId": { "type": "string", "description": "The GTM Container ID.", "required": true, "location": "path" }, "containerVersionId": { "description": "The GTM Container Version ID.", "required": true, "type": "string", "location": "path" } }, "description": "Updates a Container Version.", "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/versions/{containerVersionId}", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containerversions" ], "parameterOrder": [ "accountId", "containerId", "containerVersionId" ], "httpMethod": "PUT", "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/versions/{containerVersionId}", "request": { "$ref": "ContainerVersion" }, "id": "tagmanager.accounts.containers.versions.update" }, "delete": { "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/versions/{containerVersionId}", "parameters": { "accountId": { "type": "string", "description": "The GTM Account ID.", "required": true, "location": "path" }, "containerId": { "location": "path", "type": "string", "description": "The GTM Container ID.", "required": true }, "containerVersionId": { "location": "path", "description": "The GTM Container Version ID.", "required": true, "type": "string" } }, "description": "Deletes a Container Version.", "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/versions/{containerVersionId}", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containerversions" ], "id": "tagmanager.accounts.containers.versions.delete", "parameterOrder": [ "accountId", "containerId", "containerVersionId" ], "httpMethod": "DELETE" }, "undelete": { "id": "tagmanager.accounts.containers.versions.undelete", "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/versions/{containerVersionId}/undelete", "parameterOrder": [ "accountId", "containerId", "containerVersionId" ], "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containerversions" ], "parameters": { "accountId": { "location": "path", "type": "string", "description": "The GTM Account ID.", "required": true }, "containerId": { "type": "string", "description": "The GTM Container ID.", "required": true, "location": "path" }, "containerVersionId": { "description": "The GTM Container Version ID.", "required": true, "type": "string", "location": "path" } }, "description": "Undeletes a Container Version.", "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/versions/{containerVersionId}/undelete", "response": { "$ref": "ContainerVersion" } } } }, "tags": { "methods": { "create": { "parameters": { "accountId": { "type": "string", "description": "The GTM Account ID.", "required": true, "location": "path" }, "containerId": { "type": "string", "description": "The GTM Container ID.", "required": true, "location": "path" } }, "description": "Creates a GTM Tag.", "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/tags", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "response": { "$ref": "Tag" }, "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/tags", "request": { "$ref": "Tag" }, "id": "tagmanager.accounts.containers.tags.create", "parameterOrder": [ "accountId", "containerId" ], "httpMethod": "POST" }, "delete": { "parameterOrder": [ "accountId", "containerId", "tagId" ], "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "id": "tagmanager.accounts.containers.tags.delete", "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/tags/{tagId}", "parameters": { "accountId": { "location": "path", "type": "string", "description": "The GTM Account ID.", "required": true }, "containerId": { "location": "path", "type": "string", "description": "The GTM Container ID.", "required": true }, "tagId": { "location": "path", "type": "string", "description": "The GTM Tag ID.", "required": true } }, "description": "Deletes a GTM Tag.", "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/tags/{tagId}" }, "update": { "response": { "$ref": "Tag" }, "parameters": { "accountId": { "description": "The GTM Account ID.", "required": true, "type": "string", "location": "path" }, "containerId": { "type": "string", "description": "The GTM Container ID.", "required": true, "location": "path" }, "fingerprint": { "description": "When provided, this fingerprint must match the fingerprint of the tag in storage.", "type": "string", "location": "query" }, "tagId": { "location": "path", "description": "The GTM Tag ID.", "required": true, "type": "string" } }, "description": "Updates a GTM Tag.", "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/tags/{tagId}", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "parameterOrder": [ "accountId", "containerId", "tagId" ], "httpMethod": "PUT", "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/tags/{tagId}", "request": { "$ref": "Tag" }, "id": "tagmanager.accounts.containers.tags.update" }, "get": { "httpMethod": "GET", "parameterOrder": [ "accountId", "containerId", "tagId" ], "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/tags/{tagId}", "id": "tagmanager.accounts.containers.tags.get", "response": { "$ref": "Tag" }, "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/tags/{tagId}", "parameters": { "accountId": { "location": "path", "type": "string", "description": "The GTM Account ID.", "required": true }, "containerId": { "location": "path", "type": "string", "description": "The GTM Container ID.", "required": true }, "tagId": { "type": "string", "description": "The GTM Tag ID.", "required": true, "location": "path" } }, "description": "Gets a GTM Tag.", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ] }, "list": { "response": { "$ref": "ListTagsResponse" }, "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/tags", "parameters": { "accountId": { "type": "string", "description": "The GTM Account ID.", "required": true, "location": "path" }, "containerId": { "location": "path", "type": "string", "description": "The GTM Container ID.", "required": true } }, "description": "Lists all GTM Tags of a Container.", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "httpMethod": "GET", "parameterOrder": [ "accountId", "containerId" ], "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/tags", "id": "tagmanager.accounts.containers.tags.list" } } }, "triggers": { "methods": { "create": { "httpMethod": "POST", "parameterOrder": [ "accountId", "containerId" ], "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/triggers", "request": { "$ref": "Trigger" }, "id": "tagmanager.accounts.containers.triggers.create", "response": { "$ref": "Trigger" }, "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/triggers", "parameters": { "accountId": { "location": "path", "description": "The GTM Account ID.", "required": true, "type": "string" }, "containerId": { "description": "The GTM Container ID.", "required": true, "type": "string", "location": "path" } }, "description": "Creates a GTM Trigger.", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ] }, "get": { "response": { "$ref": "Trigger" }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "parameters": { "triggerId": { "location": "path", "description": "The GTM Trigger ID.", "required": true, "type": "string" }, "accountId": { "location": "path", "description": "The GTM Account ID.", "required": true, "type": "string" }, "containerId": { "type": "string", "description": "The GTM Container ID.", "required": true, "location": "path" } }, "description": "Gets a GTM Trigger.", "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/triggers/{triggerId}", "parameterOrder": [ "accountId", "containerId", "triggerId" ], "httpMethod": "GET", "id": "tagmanager.accounts.containers.triggers.get", "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/triggers/{triggerId}" }, "list": { "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/triggers", "id": "tagmanager.accounts.containers.triggers.list", "parameterOrder": [ "accountId", "containerId" ], "httpMethod": "GET", "parameters": { "accountId": { "location": "path", "description": "The GTM Account ID.", "required": true, "type": "string" }, "containerId": { "description": "The GTM Container ID.", "required": true, "type": "string", "location": "path" } }, "description": "Lists all GTM Triggers of a Container.", "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/triggers", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "response": { "$ref": "ListTriggersResponse" } }, "delete": { "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/triggers/{triggerId}", "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/triggers/{triggerId}", "parameters": { "triggerId": { "type": "string", "description": "The GTM Trigger ID.", "required": true, "location": "path" }, "accountId": { "type": "string", "description": "The GTM Account ID.", "required": true, "location": "path" }, "containerId": { "description": "The GTM Container ID.", "required": true, "type": "string", "location": "path" } }, "description": "Deletes a GTM Trigger.", "id": "tagmanager.accounts.containers.triggers.delete", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "httpMethod": "DELETE", "parameterOrder": [ "accountId", "containerId", "triggerId" ] }, "update": { "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/triggers/{triggerId}", "parameters": { "triggerId": { "location": "path", "description": "The GTM Trigger ID.", "required": true, "type": "string" }, "fingerprint": { "location": "query", "description": "When provided, this fingerprint must match the fingerprint of the trigger in storage.", "type": "string" }, "accountId": { "location": "path", "description": "The GTM Account ID.", "required": true, "type": "string" }, "containerId": { "description": "The GTM Container ID.", "required": true, "type": "string", "location": "path" } }, "description": "Updates a GTM Trigger.", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "response": { "$ref": "Trigger" }, "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/triggers/{triggerId}", "request": { "$ref": "Trigger" }, "id": "tagmanager.accounts.containers.triggers.update", "httpMethod": "PUT", "parameterOrder": [ "accountId", "containerId", "triggerId" ] } } }, "variables": { "methods": { "update": { "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/variables/{variableId}", "request": { "$ref": "Variable" }, "id": "tagmanager.accounts.containers.variables.update", "parameterOrder": [ "accountId", "containerId", "variableId" ], "httpMethod": "PUT", "parameters": { "fingerprint": { "location": "query", "description": "When provided, this fingerprint must match the fingerprint of the variable in storage.", "type": "string" }, "accountId": { "location": "path", "description": "The GTM Account ID.", "required": true, "type": "string" }, "containerId": { "location": "path", "type": "string", "description": "The GTM Container ID.", "required": true }, "variableId": { "location": "path", "description": "The GTM Variable ID.", "required": true, "type": "string" } }, "description": "Updates a GTM Variable.", "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/variables/{variableId}", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "response": { "$ref": "Variable" } }, "delete": { "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/variables/{variableId}", "parameters": { "accountId": { "location": "path", "description": "The GTM Account ID.", "required": true, "type": "string" }, "containerId": { "description": "The GTM Container ID.", "required": true, "type": "string", "location": "path" }, "variableId": { "location": "path", "description": "The GTM Variable ID.", "required": true, "type": "string" } }, "description": "Deletes a GTM Variable.", "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/variables/{variableId}", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "id": "tagmanager.accounts.containers.variables.delete", "parameterOrder": [ "accountId", "containerId", "variableId" ], "httpMethod": "DELETE" }, "list": { "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/variables", "parameters": { "accountId": { "location": "path", "description": "The GTM Account ID.", "required": true, "type": "string" }, "containerId": { "description": "The GTM Container ID.", "required": true, "type": "string", "location": "path" } }, "description": "Lists all GTM Variables of a Container.", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "response": { "$ref": "ListVariablesResponse" }, "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/variables", "id": "tagmanager.accounts.containers.variables.list", "httpMethod": "GET", "parameterOrder": [ "accountId", "containerId" ] }, "get": { "response": { "$ref": "Variable" }, "parameters": { "accountId": { "type": "string", "description": "The GTM Account ID.", "required": true, "location": "path" }, "containerId": { "location": "path", "type": "string", "description": "The GTM Container ID.", "required": true }, "variableId": { "location": "path", "description": "The GTM Variable ID.", "required": true, "type": "string" } }, "description": "Gets a GTM Variable.", "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/variables/{variableId}", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "parameterOrder": [ "accountId", "containerId", "variableId" ], "httpMethod": "GET", "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/variables/{variableId}", "id": "tagmanager.accounts.containers.variables.get" }, "create": { "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/variables", "request": { "$ref": "Variable" }, "id": "tagmanager.accounts.containers.variables.create", "parameterOrder": [ "accountId", "containerId" ], "httpMethod": "POST", "parameters": { "accountId": { "type": "string", "description": "The GTM Account ID.", "required": true, "location": "path" }, "containerId": { "type": "string", "description": "The GTM Container ID.", "required": true, "location": "path" } }, "description": "Creates a GTM Variable.", "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/variables", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "response": { "$ref": "Variable" } } } }, "move_folders": { "methods": { "update": { "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/move_folders/{folderId}", "request": { "$ref": "Folder" }, "id": "tagmanager.accounts.containers.move_folders.update", "parameterOrder": [ "accountId", "containerId", "folderId" ], "httpMethod": "PUT", "parameters": { "tagId": { "repeated": true, "location": "query", "type": "string", "description": "The tags to be moved to the folder." }, "triggerId": { "repeated": true, "location": "query", "type": "string", "description": "The triggers to be moved to the folder." }, "containerId": { "type": "string", "description": "The GTM Container ID.", "required": true, "location": "path" }, "folderId": { "location": "path", "description": "The GTM Folder ID.", "required": true, "type": "string" }, "variableId": { "location": "query", "repeated": true, "description": "The variables to be moved to the folder.", "type": "string" }, "accountId": { "type": "string", "description": "The GTM Account ID.", "required": true, "location": "path" } }, "description": "Moves entities to a GTM Folder.", "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/move_folders/{folderId}", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ] } } }, "folders": { "methods": { "get": { "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "parameters": { "accountId": { "type": "string", "description": "The GTM Account ID.", "required": true, "location": "path" }, "containerId": { "description": "The GTM Container ID.", "required": true, "type": "string", "location": "path" }, "folderId": { "description": "The GTM Folder ID.", "required": true, "type": "string", "location": "path" } }, "description": "Gets a GTM Folder.", "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/folders/{folderId}", "response": { "$ref": "Folder" }, "id": "tagmanager.accounts.containers.folders.get", "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/folders/{folderId}", "parameterOrder": [ "accountId", "containerId", "folderId" ], "httpMethod": "GET" }, "list": { "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/folders", "id": "tagmanager.accounts.containers.folders.list", "httpMethod": "GET", "parameterOrder": [ "accountId", "containerId" ], "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/folders", "parameters": { "accountId": { "description": "The GTM Account ID.", "required": true, "type": "string", "location": "path" }, "containerId": { "location": "path", "description": "The GTM Container ID.", "required": true, "type": "string" } }, "description": "Lists all GTM Folders of a Container.", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "response": { "$ref": "ListFoldersResponse" } }, "delete": { "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "id": "tagmanager.accounts.containers.folders.delete", "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/folders/{folderId}", "parameters": { "accountId": { "description": "The GTM Account ID.", "required": true, "type": "string", "location": "path" }, "containerId": { "description": "The GTM Container ID.", "required": true, "type": "string", "location": "path" }, "folderId": { "location": "path", "description": "The GTM Folder ID.", "required": true, "type": "string" } }, "description": "Deletes a GTM Folder.", "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/folders/{folderId}", "parameterOrder": [ "accountId", "containerId", "folderId" ], "httpMethod": "DELETE" }, "update": { "response": { "$ref": "Folder" }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/folders/{folderId}", "parameters": { "accountId": { "description": "The GTM Account ID.", "required": true, "type": "string", "location": "path" }, "containerId": { "description": "The GTM Container ID.", "required": true, "type": "string", "location": "path" }, "folderId": { "type": "string", "description": "The GTM Folder ID.", "required": true, "location": "path" }, "fingerprint": { "description": "When provided, this fingerprint must match the fingerprint of the folder in storage.", "type": "string", "location": "query" } }, "description": "Updates a GTM Folder.", "httpMethod": "PUT", "parameterOrder": [ "accountId", "containerId", "folderId" ], "id": "tagmanager.accounts.containers.folders.update", "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/folders/{folderId}", "request": { "$ref": "Folder" } }, "create": { "parameters": { "accountId": { "location": "path", "type": "string", "description": "The GTM Account ID.", "required": true }, "containerId": { "location": "path", "type": "string", "description": "The GTM Container ID.", "required": true } }, "description": "Creates a GTM Folder.", "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/folders", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "response": { "$ref": "Folder" }, "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/folders", "request": { "$ref": "Folder" }, "id": "tagmanager.accounts.containers.folders.create", "parameterOrder": [ "accountId", "containerId" ], "httpMethod": "POST" } }, "resources": { "entities": { "methods": { "list": { "response": { "$ref": "FolderEntities" }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/folders/{folderId}/entities", "parameters": { "accountId": { "location": "path", "type": "string", "description": "The GTM Account ID.", "required": true }, "containerId": { "location": "path", "type": "string", "description": "The GTM Container ID.", "required": true }, "folderId": { "location": "path", "type": "string", "description": "The GTM Folder ID.", "required": true } }, "description": "List all entities in a GTM Folder.", "httpMethod": "GET", "parameterOrder": [ "accountId", "containerId", "folderId" ], "id": "tagmanager.accounts.containers.folders.entities.list", "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/folders/{folderId}/entities" } } } } }, "environments": { "methods": { "create": { "httpMethod": "POST", "parameterOrder": [ "accountId", "containerId" ], "id": "tagmanager.accounts.containers.environments.create", "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/environments", "request": { "$ref": "Environment" }, "response": { "$ref": "Environment" }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/environments", "parameters": { "accountId": { "location": "path", "description": "The GTM Account ID.", "required": true, "type": "string" }, "containerId": { "location": "path", "type": "string", "description": "The GTM Container ID.", "required": true } }, "description": "Creates a GTM Environment." }, "update": { "response": { "$ref": "Environment" }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "parameters": { "accountId": { "location": "path", "description": "The GTM Account ID.", "required": true, "type": "string" }, "containerId": { "description": "The GTM Container ID.", "required": true, "type": "string", "location": "path" }, "environmentId": { "location": "path", "type": "string", "description": "The GTM Environment ID.", "required": true }, "fingerprint": { "location": "query", "type": "string", "description": "When provided, this fingerprint must match the fingerprint of the environment in storage." } }, "description": "Updates a GTM Environment.", "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/environments/{environmentId}", "parameterOrder": [ "accountId", "containerId", "environmentId" ], "httpMethod": "PUT", "id": "tagmanager.accounts.containers.environments.update", "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/environments/{environmentId}", "request": { "$ref": "Environment" } }, "delete": { "parameterOrder": [ "accountId", "containerId", "environmentId" ], "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "id": "tagmanager.accounts.containers.environments.delete", "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/environments/{environmentId}", "parameters": { "accountId": { "location": "path", "description": "The GTM Account ID.", "required": true, "type": "string" }, "containerId": { "type": "string", "description": "The GTM Container ID.", "required": true, "location": "path" }, "environmentId": { "location": "path", "type": "string", "description": "The GTM Environment ID.", "required": true } }, "description": "Deletes a GTM Environment.", "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/environments/{environmentId}" }, "list": { "response": { "$ref": "ListEnvironmentsResponse" }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/environments", "parameters": { "accountId": { "type": "string", "description": "The GTM Account ID.", "required": true, "location": "path" }, "containerId": { "location": "path", "type": "string", "description": "The GTM Container ID.", "required": true } }, "description": "Lists all GTM Environments of a GTM Container.", "httpMethod": "GET", "parameterOrder": [ "accountId", "containerId" ], "id": "tagmanager.accounts.containers.environments.list", "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/environments" }, "get": { "response": { "$ref": "Environment" }, "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/environments/{environmentId}", "parameters": { "environmentId": { "description": "The GTM Environment ID.", "required": true, "type": "string", "location": "path" }, "accountId": { "type": "string", "description": "The GTM Account ID.", "required": true, "location": "path" }, "containerId": { "location": "path", "type": "string", "description": "The GTM Container ID.", "required": true } }, "description": "Gets a GTM Environment.", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "httpMethod": "GET", "parameterOrder": [ "accountId", "containerId", "environmentId" ], "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/environments/{environmentId}", "id": "tagmanager.accounts.containers.environments.get" } } } } }, "permissions": { "methods": { "create": { "httpMethod": "POST", "parameterOrder": [ "accountId" ], "flatPath": "tagmanager/v1/accounts/{accountId}/permissions", "request": { "$ref": "UserAccess" }, "id": "tagmanager.accounts.permissions.create", "response": { "$ref": "UserAccess" }, "path": "tagmanager/v1/accounts/{accountId}/permissions", "parameters": { "accountId": { "location": "path", "type": "string", "description": "The GTM Account ID.", "required": true } }, "description": "Creates a user's Account & Container Permissions.", "scopes": [ "https://www.googleapis.com/auth/tagmanager.manage.users" ] }, "update": { "httpMethod": "PUT", "parameterOrder": [ "accountId", "permissionId" ], "id": "tagmanager.accounts.permissions.update", "flatPath": "tagmanager/v1/accounts/{accountId}/permissions/{permissionId}", "request": { "$ref": "UserAccess" }, "response": { "$ref": "UserAccess" }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.manage.users" ], "path": "tagmanager/v1/accounts/{accountId}/permissions/{permissionId}", "parameters": { "permissionId": { "description": "The GTM User ID.", "required": true, "type": "string", "location": "path" }, "accountId": { "location": "path", "description": "The GTM Account ID.", "required": true, "type": "string" } }, "description": "Updates a user's Account & Container Permissions." }, "delete": { "id": "tagmanager.accounts.permissions.delete", "scopes": [ "https://www.googleapis.com/auth/tagmanager.manage.users" ], "path": "tagmanager/v1/accounts/{accountId}/permissions/{permissionId}", "flatPath": "tagmanager/v1/accounts/{accountId}/permissions/{permissionId}", "parameters": { "accountId": { "type": "string", "description": "The GTM Account ID.", "required": true, "location": "path" }, "permissionId": { "type": "string", "description": "The GTM User ID.", "required": true, "location": "path" } }, "description": "Removes a user from the account, revoking access to it and all of its containers.", "httpMethod": "DELETE", "parameterOrder": [ "accountId", "permissionId" ] }, "list": { "scopes": [ "https://www.googleapis.com/auth/tagmanager.manage.users" ], "path": "tagmanager/v1/accounts/{accountId}/permissions", "parameters": { "accountId": { "location": "path", "description": "The GTM Account ID.", "required": true, "type": "string" } }, "description": "List all users that have access to the account along with Account and Container Permissions granted to each of them.", "response": { "$ref": "ListAccountUsersResponse" }, "id": "tagmanager.accounts.permissions.list", "flatPath": "tagmanager/v1/accounts/{accountId}/permissions", "httpMethod": "GET", "parameterOrder": [ "accountId" ] }, "get": { "scopes": [ "https://www.googleapis.com/auth/tagmanager.manage.users" ], "parameters": { "accountId": { "type": "string", "description": "The GTM Account ID.", "required": true, "location": "path" }, "permissionId": { "type": "string", "description": "The GTM User ID.", "required": true, "location": "path" } }, "description": "Gets a user's Account & Container Permissions.", "path": "tagmanager/v1/accounts/{accountId}/permissions/{permissionId}", "response": { "$ref": "UserAccess" }, "id": "tagmanager.accounts.permissions.get", "flatPath": "tagmanager/v1/accounts/{accountId}/permissions/{permissionId}", "parameterOrder": [ "accountId", "permissionId" ], "httpMethod": "GET" } } } } } }, "mtlsRootUrl": "https://tagmanager.mtls.googleapis.com/", "canonicalName": "Tag Manager", "baseUrl": "https://tagmanager.googleapis.com/", "ownerDomain": "google.com", "rootUrl": "https://tagmanager.googleapis.com/", "revision": "20260810", "title": "Tag Manager API", "name": "tagmanager", "servicePath": "", "parameters": { "alt": { "description": "Data format for response.", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "type": "string", "default": "json", "location": "query", "enum": [ "json", "media", "proto" ] }, "key": { "location": "query", "type": "string", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, "quotaUser": { "type": "string", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "location": "query" }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query" }, "access_token": { "type": "string", "description": "OAuth access token.", "location": "query" }, "$.xgafv": { "description": "V1 error format.", "enumDescriptions": [ "v1 error format", "v2 error format" ], "location": "query", "enum": [ "1", "2" ], "type": "string" }, "oauth_token": { "location": "query", "type": "string", "description": "OAuth 2.0 token for the current user." }, "uploadType": { "location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "type": "string" }, "callback": { "description": "JSONP", "type": "string", "location": "query" }, "fields": { "location": "query", "description": "Selector specifying which fields to include in a partial response.", "type": "string" }, "prettyPrint": { "default": "true", "location": "query", "description": "Returns response with indentations and line breaks.", "type": "boolean" } }, "batchPath": "batch", "schemas": { "Variable": { "description": "Represents a Google Tag Manager Variable.", "type": "object", "properties": { "scheduleEndMs": { "type": "string", "format": "int64", "description": "The end timestamp in milliseconds to schedule a variable." }, "disablingTriggerId": { "description": "For mobile containers only: A list of trigger IDs for disabling conditional variables; the variable is enabled if one of the enabling trigger is true while all the disabling trigger are false. Treated as an unordered set.", "items": { "type": "string" }, "type": "array" }, "enablingTriggerId": { "type": "array", "description": "For mobile containers only: A list of trigger IDs for enabling conditional variables; the variable is enabled if one of the enabling triggers is true while all the disabling triggers are false. Treated as an unordered set.", "items": { "type": "string" } }, "scheduleStartMs": { "type": "string", "format": "int64", "description": "The start timestamp in milliseconds to schedule a variable." }, "notes": { "type": "string", "description": "User notes on how to apply this variable in the container." }, "parameter": { "type": "array", "description": "The variable's parameters.", "items": { "$ref": "Parameter" } }, "variableId": { "type": "string", "description": "The Variable ID uniquely identifies the GTM Variable." }, "fingerprint": { "description": "The fingerprint of the GTM Variable as computed at storage time. This value is recomputed whenever the variable is modified.", "type": "string" }, "parentFolderId": { "description": "Parent folder id.", "type": "string" }, "accountId": { "description": "GTM Account ID.", "type": "string" }, "name": { "description": "Variable display name.", "type": "string" }, "containerId": { "type": "string", "description": "GTM Container ID." }, "type": { "type": "string", "description": "GTM Variable Type." } }, "id": "Variable" }, "ListContainersResponse": { "id": "ListContainersResponse", "properties": { "containers": { "type": "array", "description": "All Containers of a GTM Account.", "items": { "$ref": "Container" } } }, "type": "object", "description": "List Containers Response." }, "Tag": { "id": "Tag", "properties": { "accountId": { "description": "GTM Account ID.", "type": "string" }, "name": { "type": "string", "description": "Tag display name." }, "containerId": { "description": "GTM Container ID.", "type": "string" }, "blockingTriggerId": { "type": "array", "description": "Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag will not fire.", "items": { "type": "string" } }, "paused": { "type": "boolean", "description": "True if the tag is paused." }, "type": { "description": "GTM Tag Type.", "type": "string" }, "parameter": { "type": "array", "description": "The tag's parameters.", "items": { "$ref": "Parameter" } }, "fingerprint": { "description": "The fingerprint of the GTM Tag as computed at storage time. This value is recomputed whenever the tag is modified.", "type": "string" }, "parentFolderId": { "description": "Parent folder id.", "type": "string" }, "tagId": { "type": "string", "description": "The Tag ID uniquely identifies the GTM Tag." }, "tagFiringOption": { "type": "string", "description": "Option to fire this tag.", "enumDescriptions": [ "Tag can be fired multiple times per event.", "Tag can only be fired per event but can be fired multiple times per load (e.g., app load or page load).", "Tag can only be fired per load (e.g., app load or page load)." ], "enum": [ "unlimited", "oncePerEvent", "oncePerLoad" ] }, "scheduleStartMs": { "description": "The start timestamp in milliseconds to schedule a tag.", "type": "string", "format": "int64" }, "notes": { "description": "User notes on how to apply this tag in the container.", "type": "string" }, "teardownTag": { "description": "The list of teardown tags. Currently we only allow one.", "items": { "$ref": "TeardownTag" }, "type": "array" }, "priority": { "$ref": "Parameter", "description": "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." }, "scheduleEndMs": { "type": "string", "format": "int64", "description": "The end timestamp in milliseconds to schedule a tag." }, "liveOnly": { "description": "If set to true, this tag will only fire in the live environment (e.g. not in preview or debug mode).", "type": "boolean" }, "firingTriggerId": { "description": "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.", "items": { "type": "string" }, "type": "array" }, "setupTag": { "description": "The list of setup tags. Currently we only allow one.", "items": { "$ref": "SetupTag" }, "type": "array" } }, "type": "object", "description": "Represents a Google Tag Manager Tag." }, "TeardownTag": { "type": "object", "properties": { "stopTeardownOnFailure": { "type": "boolean", "description": "If true, fire the teardown tag if and only if the main tag fires successfully. If false, fire the teardown tag regardless of main tag firing status." }, "tagName": { "description": "The name of the teardown tag.", "type": "string" } }, "id": "TeardownTag" }, "ContainerVersionHeader": { "properties": { "name": { "type": "string", "description": "Container version display name." }, "numVariables": { "description": "Number of variables in the container version.", "type": "string" }, "accountId": { "type": "string", "description": "GTM Account ID." }, "containerVersionId": { "type": "string", "description": "The Container Version ID uniquely identifies the GTM Container Version." }, "numTriggers": { "type": "string", "description": "Number of triggers in the container version." }, "deleted": { "type": "boolean", "description": "A value of true indicates this container version has been deleted." }, "numTags": { "type": "string", "description": "Number of tags in the container version." }, "containerId": { "type": "string", "description": "GTM Container ID." } }, "id": "ContainerVersionHeader", "description": "Represents a Google Tag Manager Container Version Header.", "type": "object" }, "ContainerVersion": { "type": "object", "description": "Represents a Google Tag Manager Container Version.", "id": "ContainerVersion", "properties": { "trigger": { "type": "array", "description": "The triggers in the container that this version was taken from.", "items": { "$ref": "Trigger" } }, "containerVersionId": { "type": "string", "description": "The Container Version ID uniquely identifies the GTM Container Version." }, "tag": { "type": "array", "description": "The tags in the container that this version was taken from.", "items": { "$ref": "Tag" } }, "deleted": { "description": "A value of true indicates this container version has been deleted.", "type": "boolean" }, "folder": { "type": "array", "description": "The folders in the container that this version was taken from.", "items": { "$ref": "Folder" } }, "fingerprint": { "type": "string", "description": "The fingerprint of the GTM Container Version as computed at storage time. This value is recomputed whenever the container version is modified." }, "name": { "description": "Container version display name.", "type": "string" }, "variable": { "description": "The variables in the container that this version was taken from.", "items": { "$ref": "Variable" }, "type": "array" }, "accountId": { "description": "GTM Account ID.", "type": "string" }, "notes": { "type": "string", "description": "User notes on how to apply this container version in the container." }, "containerId": { "type": "string", "description": "GTM Container ID." }, "container": { "description": "The container that this version was taken from.", "$ref": "Container" } } }, "ContainerAccess": { "description": "Defines the Google Tag Manager Container access permissions.", "type": "object", "properties": { "containerId": { "type": "string", "description": "GTM Container ID." }, "permission": { "type": "array", "description": "List of Container permissions. Valid container permissions are: read, edit, delete, publish.", "items": { "enum": [ "read", "edit", "publish", "delete", "manage", "editWorkspace" ], "enumDescriptions": [ "", "", "", "", "", "" ], "type": "string" } } }, "id": "ContainerAccess" }, "ListVariablesResponse": { "properties": { "variables": { "type": "array", "description": "All GTM Variables of a GTM Container.", "items": { "$ref": "Variable" } } }, "id": "ListVariablesResponse", "description": "List Variables Response.", "type": "object" }, "Container": { "type": "object", "description": "Represents a Google Tag Manager Container.", "id": "Container", "properties": { "name": { "description": "Container display name.", "type": "string" }, "accountId": { "type": "string", "description": "GTM Account ID." }, "notes": { "type": "string", "description": "Container Notes." }, "usageContext": { "type": "array", "description": "List of Usage Contexts for the Container. Valid values include: web, android, ios.", "items": { "enum": [ "web", "android", "ios", "androidSdk5", "iosSdk5", "amp" ], "type": "string", "enumDescriptions": [ "", "", "", "", "", "" ] } }, "containerId": { "description": "The Container ID uniquely identifies the GTM Container.", "type": "string" }, "domainName": { "type": "array", "description": "Optional list of domain names associated with the Container.", "items": { "type": "string" } }, "timeZoneCountryId": { "type": "string", "description": "Container Country ID." }, "publicId": { "type": "string", "description": "Container Public ID." }, "timeZoneId": { "type": "string", "description": "Container Time Zone ID." }, "enabledBuiltInVariable": { "type": "array", "description": "List of enabled built-in variables. Valid values include: pageUrl, pageHostname, pagePath, referrer, event, clickElement, clickClasses, clickId, clickTarget, clickUrl, clickText, formElement, formClasses, formId, formTarget, formUrl, formText, errorMessage, errorUrl, errorLine, newHistoryFragment, oldHistoryFragment, newHistoryState, oldHistoryState, historySource, containerVersion, debugMode, randomNumber, containerId.", "items": { "enum": [ "pageUrl", "pageHostname", "pagePath", "referrer", "event", "clickElement", "clickClasses", "clickId", "clickTarget", "clickUrl", "clickText", "firstPartyServingUrl", "formElement", "formClasses", "formId", "formTarget", "formUrl", "formText", "environmentName", "errorMessage", "errorUrl", "errorLine", "newHistoryUrl", "oldHistoryUrl", "newHistoryFragment", "oldHistoryFragment", "newHistoryState", "oldHistoryState", "historySource", "containerVersion", "debugMode", "randomNumber", "containerId", "appId", "appName", "appVersionCode", "appVersionName", "language", "osVersion", "platform", "sdkVersion", "deviceName", "resolution", "advertiserId", "advertisingTrackingEnabled", "htmlId", "ampBrowserLanguage", "ampCanonicalPath", "ampCanonicalUrl", "ampCanonicalHost", "ampReferrer", "ampTitle", "ampClientId", "ampClientTimezone", "ampClientTimestamp", "ampClientScreenWidth", "ampClientScreenHeight", "ampClientScrollX", "ampClientScrollY", "ampClientMaxScrollX", "ampClientMaxScrollY", "ampTotalEngagedTime", "ampPageViewId", "ampPageLoadTime", "ampPageDownloadTime", "ampGtmEvent", "eventName", "firebaseEventParameterCampaign", "firebaseEventParameterCampaignAclid", "firebaseEventParameterCampaignAnid", "firebaseEventParameterCampaignClickTimestamp", "firebaseEventParameterCampaignContent", "firebaseEventParameterCampaignCp1", "firebaseEventParameterCampaignGclid", "firebaseEventParameterCampaignSource", "firebaseEventParameterCampaignTerm", "firebaseEventParameterCurrency", "firebaseEventParameterDynamicLinkAcceptTime", "firebaseEventParameterDynamicLinkLinkid", "firebaseEventParameterNotificationMessageDeviceTime", "firebaseEventParameterNotificationMessageId", "firebaseEventParameterNotificationMessageName", "firebaseEventParameterNotificationMessageTime", "firebaseEventParameterNotificationTopic", "firebaseEventParameterPreviousAppVersion", "firebaseEventParameterPreviousOsVersion", "firebaseEventParameterPrice", "firebaseEventParameterProductId", "firebaseEventParameterQuantity", "firebaseEventParameterValue", "videoProvider", "videoUrl", "videoTitle", "videoDuration", "videoPercent", "videoVisible", "videoStatus", "videoCurrentTime", "scrollDepthThreshold", "scrollDepthUnits", "scrollDepthDirection", "elementVisibilityRatio", "elementVisibilityTime", "elementVisibilityFirstTime", "elementVisibilityRecentTime", "analyticsClientId", "analyticsSessionId", "analyticsSessionNumber" ], "type": "string", "enumDescriptions": [ "", "", "", "", "For web or mobile.", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "For web or mobile.", "", "For web or mobile.", "For web or mobile.", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ] } }, "fingerprint": { "type": "string", "description": "The fingerprint of the GTM Container as computed at storage time. This value is recomputed whenever the account is modified." } } }, "ListContainerVersionsResponse": { "properties": { "containerVersion": { "description": "All versions of a GTM Container.", "items": { "$ref": "ContainerVersion" }, "type": "array" }, "containerVersionHeader": { "description": "All container version headers of a GTM Container.", "items": { "$ref": "ContainerVersionHeader" }, "type": "array" } }, "id": "ListContainerVersionsResponse", "description": "List container versions response.", "type": "object" }, "ListAccountsResponse": { "id": "ListAccountsResponse", "properties": { "accounts": { "description": "List of GTM Accounts that a user has access to.", "items": { "$ref": "Account" }, "type": "array" } }, "type": "object", "description": "List Accounts Response." }, "Parameter": { "properties": { "list": { "type": "array", "description": "This list parameter's parameters (keys will be ignored).", "items": { "$ref": "Parameter" } }, "map": { "description": "This map parameter's parameters (must have keys; keys must be unique).", "items": { "$ref": "Parameter" }, "type": "array" }, "type": { "type": "string", "description": "The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name ", "enumDescriptions": [ "May include variable references.", "", "", "", "", "", "" ], "enum": [ "template", "integer", "boolean", "list", "map", "triggerReference", "tagReference" ] }, "value": { "type": "string", "description": "A parameter's value (may contain variable references). as appropriate to the specified type." }, "key": { "description": "The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.", "type": "string" } }, "id": "Parameter", "description": "Represents a Google Tag Manager Parameter.", "type": "object" }, "Account": { "id": "Account", "properties": { "accountId": { "type": "string", "description": "The Account ID uniquely identifies the GTM Account." }, "fingerprint": { "type": "string", "description": "The fingerprint of the GTM Account as computed at storage time. This value is recomputed whenever the account is modified." }, "shareData": { "description": "Whether the account shares data anonymously with Google and others.", "type": "boolean" }, "name": { "type": "string", "description": "Account display name." } }, "type": "object", "description": "Represents a Google Tag Manager Account." }, "PublishContainerVersionResponse": { "properties": { "containerVersion": { "$ref": "ContainerVersion", "description": "The container version created." }, "compilerError": { "description": "Compiler errors or not.", "type": "boolean" } }, "id": "PublishContainerVersionResponse", "description": "Publish container version response.", "type": "object" }, "ListEnvironmentsResponse": { "properties": { "environments": { "type": "array", "description": "All Environments of a GTM Container.", "items": { "$ref": "Environment" } } }, "id": "ListEnvironmentsResponse", "description": "List Environments Response.", "type": "object" }, "AccountAccess": { "description": "Defines the Google Tag Manager Account access permissions.", "type": "object", "properties": { "permission": { "description": "List of Account permissions. Valid account permissions are read and manage.", "items": { "type": "string", "enumDescriptions": [ "", "", "", "", "", "" ], "enum": [ "read", "edit", "publish", "delete", "manage", "editWorkspace" ] }, "type": "array" } }, "id": "AccountAccess" }, "Condition": { "type": "object", "description": "Represents a predicate.", "id": "Condition", "properties": { "type": { "enum": [ "equals", "contains", "startsWith", "endsWith", "matchRegex", "greater", "greaterOrEquals", "less", "lessOrEquals", "cssSelector", "urlMatches" ], "description": "The type of operator for this condition.", "enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "" ], "type": "string" }, "parameter": { "description": "A list of named parameters (key/value), depending on the condition's type. Notes: - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - At this time, the left operand (arg0) must be a reference to a variable. - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. ", "items": { "$ref": "Parameter" }, "type": "array" } } }, "Trigger": { "description": "Represents a Google Tag Manager Trigger", "type": "object", "properties": { "eventName": { "$ref": "Parameter", "description": "Name of the GTM event that is fired. Only valid for Timer triggers." }, "fingerprint": { "type": "string", "description": "The fingerprint of the GTM Trigger as computed at storage time. This value is recomputed whenever the trigger is modified." }, "parentFolderId": { "description": "Parent folder id.", "type": "string" }, "interval": { "$ref": "Parameter", "description": "Time between triggering recurring Timer Events (in milliseconds). Only valid for Timer triggers." }, "checkValidation": { "description": "Whether or not we should only fire tags if the form submit or link click event is not cancelled by some other event handler (e.g. because of validation). Only valid for Form Submission and Link Click triggers.", "$ref": "Parameter" }, "type": { "enum": [ "pageview", "domReady", "windowLoaded", "customEvent", "triggerGroup", "always", "formSubmission", "click", "linkClick", "jsError", "historyChange", "timer", "ampClick", "ampTimer", "ampScroll", "ampVisibility", "youTubeVideo", "scrollDepth", "elementVisibility" ], "description": "Defines the data layer event that causes this trigger.", "enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ], "type": "string" }, "verticalScrollPercentageList": { "description": "List of integer percentage values for scroll triggers. The trigger will fire when each percentage is reached when the view is scrolled vertically. Only valid for AMP scroll triggers.", "$ref": "Parameter" }, "containerId": { "type": "string", "description": "GTM Container ID." }, "uniqueTriggerId": { "$ref": "Parameter", "description": "Globally unique id of the trigger that auto-generates this (a Form Submit, Link Click or Timer listener) if any. Used to make incompatible auto-events work together with trigger filtering based on trigger ids. This value is populated during output generation since the tags implied by triggers don't exist until then. Only valid for Form Submit, Link Click and Timer triggers." }, "autoEventFilter": { "type": "array", "description": "Used in the case of auto event tracking.", "items": { "$ref": "Condition" } }, "maxTimerLengthSeconds": { "description": "Max time to fire Timer Events (in seconds). Only valid for AMP Timer trigger.", "$ref": "Parameter" }, "totalTimeMinMilliseconds": { "description": "A visibility trigger minimum total visible time (in milliseconds). Only valid for AMP Visibility trigger.", "$ref": "Parameter" }, "waitForTagsTimeout": { "description": "How long to wait (in milliseconds) for tags to fire when 'waits_for_tags' above evaluates to true. Only valid for Form Submission and Link Click triggers.", "$ref": "Parameter" }, "limit": { "description": "Limit of the number of GTM events this Timer Trigger will fire. If no limit is set, we will continue to fire GTM events until the user leaves the page. Only valid for Timer triggers.", "$ref": "Parameter" }, "triggerId": { "description": "The Trigger ID uniquely identifies the GTM Trigger.", "type": "string" }, "continuousTimeMinMilliseconds": { "$ref": "Parameter", "description": "A visibility trigger minimum continuous visible time (in milliseconds). Only valid for AMP Visibility trigger." }, "horizontalScrollPercentageList": { "$ref": "Parameter", "description": "List of integer percentage values for scroll triggers. The trigger will fire when each percentage is reached when the view is scrolled horizontally. Only valid for AMP scroll triggers." }, "filter": { "description": "The trigger will only fire iff all Conditions are true.", "items": { "$ref": "Condition" }, "type": "array" }, "parameter": { "description": "Additional parameters.", "items": { "$ref": "Parameter" }, "type": "array" }, "name": { "type": "string", "description": "Trigger display name." }, "visibilitySelector": { "$ref": "Parameter", "description": "A visibility trigger CSS selector (i.e. \"#id\"). Only valid for AMP Visibility trigger." }, "selector": { "$ref": "Parameter", "description": "A click trigger CSS selector (i.e. \"a\", \"button\" etc.). Only valid for AMP Click trigger." }, "accountId": { "type": "string", "description": "GTM Account ID." }, "intervalSeconds": { "description": "Time between Timer Events to fire (in seconds). Only valid for AMP Timer trigger.", "$ref": "Parameter" }, "waitForTags": { "$ref": "Parameter", "description": "Whether or not we should delay the form submissions or link opening until all of the tags have fired (by preventing the default action and later simulating the default action). Only valid for Form Submission and Link Click triggers." }, "visiblePercentageMin": { "$ref": "Parameter", "description": "A visibility trigger minimum percent visibility. Only valid for AMP Visibility trigger." }, "customEventFilter": { "type": "array", "description": "Used in the case of custom event, which is fired iff all Conditions are true.", "items": { "$ref": "Condition" } }, "visiblePercentageMax": { "description": "A visibility trigger maximum percent visibility. Only valid for AMP Visibility trigger.", "$ref": "Parameter" } }, "id": "Trigger" }, "CreateContainerVersionResponse": { "description": "Create container versions response.", "type": "object", "properties": { "compilerError": { "type": "boolean", "description": "Compiler errors or not." }, "containerVersion": { "description": "The container version created.", "$ref": "ContainerVersion" } }, "id": "CreateContainerVersionResponse" }, "SetupTag": { "id": "SetupTag", "properties": { "tagName": { "type": "string", "description": "The name of the setup tag." }, "stopOnSetupFailure": { "description": "If true, fire the main tag if and only if the setup tag fires successfully. If false, fire the main tag regardless of setup tag firing status.", "type": "boolean" } }, "type": "object" }, "CreateContainerVersionRequestVersionOptions": { "type": "object", "description": "Options for new container versions.", "id": "CreateContainerVersionRequestVersionOptions", "properties": { "name": { "type": "string", "description": "The name of the container version to be created." }, "quickPreview": { "type": "boolean", "description": "The creation of this version may be for quick preview and shouldn't be saved." }, "notes": { "description": "The notes of the container version to be created.", "type": "string" } } }, "Folder": { "description": "Represents a Google Tag Manager Folder.", "type": "object", "properties": { "accountId": { "description": "GTM Account ID.", "type": "string" }, "name": { "type": "string", "description": "Folder display name." }, "containerId": { "type": "string", "description": "GTM Container ID." }, "folderId": { "description": "The Folder ID uniquely identifies the GTM Folder.", "type": "string" }, "fingerprint": { "type": "string", "description": "The fingerprint of the GTM Folder as computed at storage time. This value is recomputed whenever the folder is modified." } }, "id": "Folder" }, "FolderEntities": { "id": "FolderEntities", "properties": { "tag": { "description": "The list of tags inside the folder.", "items": { "$ref": "Tag" }, "type": "array" }, "trigger": { "description": "The list of triggers inside the folder.", "items": { "$ref": "Trigger" }, "type": "array" }, "variable": { "description": "The list of variables inside the folder.", "items": { "$ref": "Variable" }, "type": "array" } }, "type": "object", "description": "Represents a Google Tag Manager Folder's contents." }, "ListAccountUsersResponse": { "description": "List AccountUsers Response.", "type": "object", "properties": { "userAccess": { "type": "array", "description": "All GTM AccountUsers of a GTM Account.", "items": { "$ref": "UserAccess" } } }, "id": "ListAccountUsersResponse" }, "ListTriggersResponse": { "id": "ListTriggersResponse", "properties": { "triggers": { "description": "All GTM Triggers of a GTM Container.", "items": { "$ref": "Trigger" }, "type": "array" } }, "type": "object", "description": "List triggers response." }, "UserAccess": { "type": "object", "description": "Represents a user's permissions to an account and its container.", "id": "UserAccess", "properties": { "permissionId": { "description": "Account Permission ID.", "type": "string" }, "accountAccess": { "$ref": "AccountAccess", "description": "GTM Account access permissions." }, "emailAddress": { "description": "User's email address.", "type": "string" }, "accountId": { "description": "GTM Account ID.", "type": "string" }, "containerAccess": { "description": "GTM Container access permissions.", "items": { "$ref": "ContainerAccess" }, "type": "array" } } }, "ListTagsResponse": { "type": "object", "description": "List Tags Response.", "id": "ListTagsResponse", "properties": { "tags": { "type": "array", "description": "All GTM Tags of a GTM Container.", "items": { "$ref": "Tag" } } } }, "Environment": { "type": "object", "description": "Represents a Google Tag Manager Environment. Note that a user can create, delete and update environments of type USER, but can only update the enable_debug and url fields of environments of other types.", "id": "Environment", "properties": { "name": { "type": "string", "description": "The environment display name. Can be set or changed only on USER type environments." }, "description": { "description": "The environment description. Can be set or changed only on USER type environments.", "type": "string" }, "authorizationCode": { "description": "The environment authorization code.", "type": "string" }, "authorizationTimestampMs": { "description": "The last update time-stamp for the authorization code.", "type": "string", "format": "int64" }, "accountId": { "description": "GTM Account ID.", "type": "string" }, "url": { "type": "string", "description": "Default preview page url for the environment." }, "type": { "enum": [ "user", "live", "latest", "draft" ], "type": "string", "description": "The type of this environment.", "enumDescriptions": [ "Used for user defined environments.", "Used for Live environment, which points to the live published container version.", "Used for Latest environment, which points to the latest created container version.", "Used for Draft environment, which points to the single draft in the container." ] }, "containerId": { "description": "GTM Container ID.", "type": "string" }, "enableDebug": { "type": "boolean", "description": "Whether or not to enable debug by default on for the environment." }, "environmentId": { "description": "GTM Environment ID uniquely identifies the GTM Environment.", "type": "string" }, "containerVersionId": { "type": "string" }, "fingerprint": { "description": "The fingerprint of the GTM environment as computed at storage time. This value is recomputed whenever the environment is modified.", "type": "string" } } }, "ListFoldersResponse": { "type": "object", "description": "List Folders Response.", "id": "ListFoldersResponse", "properties": { "folders": { "description": "All GTM Folders of a GTM Container.", "items": { "$ref": "Folder" }, "type": "array" } } } }, "description": "This API allows clients to access and modify container and tag configuration.", "kind": "discovery#restDescription", "basePath": "", "protocol": "rest" }