{ "rootUrl": "https://tagmanager.googleapis.com/", "baseUrl": "https://tagmanager.googleapis.com/", "version": "v1", "revision": "20260928", "parameters": { "access_token": { "description": "OAuth access token.", "type": "string", "location": "query" }, "key": { "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.", "type": "string", "location": "query" }, "prettyPrint": { "location": "query", "description": "Returns response with indentations and line breaks.", "type": "boolean", "default": "true" }, "fields": { "type": "string", "location": "query", "description": "Selector specifying which fields to include in a partial response." }, "callback": { "description": "JSONP", "type": "string", "location": "query" }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query" }, "oauth_token": { "location": "query", "description": "OAuth 2.0 token for the current user.", "type": "string" }, "alt": { "type": "string", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "description": "Data format for response.", "enum": [ "json", "media", "proto" ], "location": "query", "default": "json" }, "quotaUser": { "type": "string", "location": "query", "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." }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query" }, "$.xgafv": { "type": "string", "enum": [ "1", "2" ], "enumDescriptions": [ "v1 error format", "v2 error format" ], "description": "V1 error format.", "location": "query" } }, "mtlsRootUrl": "https://tagmanager.mtls.googleapis.com/", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/tagmanager.publish": { "description": "Publish your Google Tag Manager container versions" }, "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.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.edit.containerversions": { "description": "Manage your Google Tag Manager container versions" }, "https://www.googleapis.com/auth/tagmanager.manage.accounts": { "description": "View and manage your Google Tag Manager accounts" }, "https://www.googleapis.com/auth/tagmanager.readonly": { "description": "View your Google Tag Manager container and its subcomponents" } } } }, "discoveryVersion": "v1", "title": "Tag Manager API", "kind": "discovery#restDescription", "resources": { "accounts": { "resources": { "permissions": { "methods": { "update": { "parameterOrder": [ "accountId", "permissionId" ], "scopes": [ "https://www.googleapis.com/auth/tagmanager.manage.users" ], "response": { "$ref": "UserAccess" }, "id": "tagmanager.accounts.permissions.update", "httpMethod": "PUT", "path": "tagmanager/v1/accounts/{accountId}/permissions/{permissionId}", "request": { "$ref": "UserAccess" }, "flatPath": "tagmanager/v1/accounts/{accountId}/permissions/{permissionId}", "description": "Updates a user's Account & Container Permissions.", "parameters": { "permissionId": { "type": "string", "description": "The GTM User ID.", "required": true, "location": "path" }, "accountId": { "description": "The GTM Account ID.", "location": "path", "type": "string", "required": true } } }, "get": { "parameters": { "permissionId": { "required": true, "description": "The GTM User ID.", "type": "string", "location": "path" }, "accountId": { "required": true, "description": "The GTM Account ID.", "type": "string", "location": "path" } }, "parameterOrder": [ "accountId", "permissionId" ], "scopes": [ "https://www.googleapis.com/auth/tagmanager.manage.users" ], "response": { "$ref": "UserAccess" }, "httpMethod": "GET", "id": "tagmanager.accounts.permissions.get", "flatPath": "tagmanager/v1/accounts/{accountId}/permissions/{permissionId}", "description": "Gets a user's Account & Container Permissions.", "path": "tagmanager/v1/accounts/{accountId}/permissions/{permissionId}" }, "list": { "httpMethod": "GET", "response": { "$ref": "ListAccountUsersResponse" }, "path": "tagmanager/v1/accounts/{accountId}/permissions", "parameterOrder": [ "accountId" ], "description": "List all users that have access to the account along with Account and Container Permissions granted to each of them.", "parameters": { "accountId": { "location": "path", "description": "The GTM Account ID.", "type": "string", "required": true } }, "flatPath": "tagmanager/v1/accounts/{accountId}/permissions", "scopes": [ "https://www.googleapis.com/auth/tagmanager.manage.users" ], "id": "tagmanager.accounts.permissions.list" }, "create": { "id": "tagmanager.accounts.permissions.create", "response": { "$ref": "UserAccess" }, "request": { "$ref": "UserAccess" }, "description": "Creates a user's Account & Container Permissions.", "flatPath": "tagmanager/v1/accounts/{accountId}/permissions", "httpMethod": "POST", "parameterOrder": [ "accountId" ], "parameters": { "accountId": { "location": "path", "description": "The GTM Account ID.", "required": true, "type": "string" } }, "path": "tagmanager/v1/accounts/{accountId}/permissions", "scopes": [ "https://www.googleapis.com/auth/tagmanager.manage.users" ] }, "delete": { "flatPath": "tagmanager/v1/accounts/{accountId}/permissions/{permissionId}", "httpMethod": "DELETE", "description": "Removes a user from the account, revoking access to it and all of its containers.", "id": "tagmanager.accounts.permissions.delete", "path": "tagmanager/v1/accounts/{accountId}/permissions/{permissionId}", "parameterOrder": [ "accountId", "permissionId" ], "parameters": { "permissionId": { "description": "The GTM User ID.", "location": "path", "required": true, "type": "string" }, "accountId": { "location": "path", "type": "string", "required": true, "description": "The GTM Account ID." } }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.manage.users" ] } } }, "containers": { "methods": { "create": { "response": { "$ref": "Container" }, "parameters": { "accountId": { "type": "string", "location": "path", "description": "The GTM Account ID.", "required": true } }, "id": "tagmanager.accounts.containers.create", "request": { "$ref": "Container" }, "path": "tagmanager/v1/accounts/{accountId}/containers", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "httpMethod": "POST", "flatPath": "tagmanager/v1/accounts/{accountId}/containers", "description": "Creates a Container.", "parameterOrder": [ "accountId" ] }, "delete": { "scopes": [ "https://www.googleapis.com/auth/tagmanager.delete.containers" ], "parameters": { "accountId": { "location": "path", "type": "string", "description": "The GTM Account ID.", "required": true }, "containerId": { "type": "string", "required": true, "location": "path", "description": "The GTM Container ID." } }, "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}", "id": "tagmanager.accounts.containers.delete", "description": "Deletes a Container.", "parameterOrder": [ "accountId", "containerId" ], "httpMethod": "DELETE", "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}" }, "update": { "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}", "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}", "parameterOrder": [ "accountId", "containerId" ], "description": "Updates a Container.", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "request": { "$ref": "Container" }, "response": { "$ref": "Container" }, "id": "tagmanager.accounts.containers.update", "parameters": { "containerId": { "type": "string", "description": "The GTM Container ID.", "location": "path", "required": true }, "fingerprint": { "description": "When provided, this fingerprint must match the fingerprint of the container in storage.", "location": "query", "type": "string" }, "accountId": { "description": "The GTM Account ID.", "location": "path", "required": true, "type": "string" } }, "httpMethod": "PUT" }, "get": { "description": "Gets a Container.", "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}", "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "parameters": { "accountId": { "type": "string", "required": true, "location": "path", "description": "The GTM Account ID." }, "containerId": { "location": "path", "type": "string", "required": true, "description": "The GTM Container ID." } }, "response": { "$ref": "Container" }, "parameterOrder": [ "accountId", "containerId" ], "id": "tagmanager.accounts.containers.get", "httpMethod": "GET" }, "list": { "parameterOrder": [ "accountId" ], "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "parameters": { "accountId": { "required": true, "type": "string", "description": "The GTM Account ID.", "location": "path" } }, "httpMethod": "GET", "flatPath": "tagmanager/v1/accounts/{accountId}/containers", "id": "tagmanager.accounts.containers.list", "response": { "$ref": "ListContainersResponse" }, "description": "Lists all Containers that belongs to a GTM Account.", "path": "tagmanager/v1/accounts/{accountId}/containers" } }, "resources": { "variables": { "methods": { "list": { "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "parameters": { "accountId": { "required": true, "description": "The GTM Account ID.", "location": "path", "type": "string" }, "containerId": { "description": "The GTM Container ID.", "location": "path", "type": "string", "required": true } }, "parameterOrder": [ "accountId", "containerId" ], "httpMethod": "GET", "response": { "$ref": "ListVariablesResponse" }, "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/variables", "id": "tagmanager.accounts.containers.variables.list", "description": "Lists all GTM Variables of a Container.", "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/variables" }, "update": { "parameters": { "containerId": { "description": "The GTM Container ID.", "location": "path", "type": "string", "required": true }, "variableId": { "required": true, "description": "The GTM Variable ID.", "location": "path", "type": "string" }, "fingerprint": { "type": "string", "description": "When provided, this fingerprint must match the fingerprint of the variable in storage.", "location": "query" }, "accountId": { "description": "The GTM Account ID.", "type": "string", "location": "path", "required": true } }, "description": "Updates a GTM Variable.", "request": { "$ref": "Variable" }, "id": "tagmanager.accounts.containers.variables.update", "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/variables/{variableId}", "parameterOrder": [ "accountId", "containerId", "variableId" ], "httpMethod": "PUT", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/variables/{variableId}", "response": { "$ref": "Variable" } }, "get": { "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/variables/{variableId}", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "id": "tagmanager.accounts.containers.variables.get", "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/variables/{variableId}", "response": { "$ref": "Variable" }, "description": "Gets a GTM Variable.", "httpMethod": "GET", "parameterOrder": [ "accountId", "containerId", "variableId" ], "parameters": { "variableId": { "type": "string", "description": "The GTM Variable ID.", "required": true, "location": "path" }, "accountId": { "description": "The GTM Account ID.", "required": true, "type": "string", "location": "path" }, "containerId": { "description": "The GTM Container ID.", "location": "path", "type": "string", "required": true } } }, "create": { "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "parameters": { "accountId": { "location": "path", "required": true, "type": "string", "description": "The GTM Account ID." }, "containerId": { "type": "string", "required": true, "description": "The GTM Container ID.", "location": "path" } }, "httpMethod": "POST", "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/variables", "description": "Creates a GTM Variable.", "parameterOrder": [ "accountId", "containerId" ], "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/variables", "id": "tagmanager.accounts.containers.variables.create", "response": { "$ref": "Variable" }, "request": { "$ref": "Variable" } }, "delete": { "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/variables/{variableId}", "id": "tagmanager.accounts.containers.variables.delete", "httpMethod": "DELETE", "description": "Deletes a GTM Variable.", "parameters": { "containerId": { "required": true, "type": "string", "location": "path", "description": "The GTM Container ID." }, "variableId": { "required": true, "description": "The GTM Variable ID.", "location": "path", "type": "string" }, "accountId": { "location": "path", "type": "string", "required": true, "description": "The GTM Account ID." } }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "parameterOrder": [ "accountId", "containerId", "variableId" ], "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/variables/{variableId}" } } }, "reauthorize_environments": { "methods": { "update": { "parameterOrder": [ "accountId", "containerId", "environmentId" ], "scopes": [ "https://www.googleapis.com/auth/tagmanager.publish" ], "response": { "$ref": "Environment" }, "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/reauthorize_environments/{environmentId}", "description": "Re-generates the authorization code for a GTM Environment.", "httpMethod": "PUT", "id": "tagmanager.accounts.containers.reauthorize_environments.update", "parameters": { "accountId": { "type": "string", "required": true, "description": "The GTM Account ID.", "location": "path" }, "environmentId": { "location": "path", "type": "string", "description": "The GTM Environment ID.", "required": true }, "containerId": { "required": true, "type": "string", "description": "The GTM Container ID.", "location": "path" } }, "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/reauthorize_environments/{environmentId}", "request": { "$ref": "Environment" } } } }, "versions": { "methods": { "publish": { "response": { "$ref": "PublishContainerVersionResponse" }, "parameterOrder": [ "accountId", "containerId", "containerVersionId" ], "id": "tagmanager.accounts.containers.versions.publish", "description": "Publishes a Container Version.", "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/versions/{containerVersionId}/publish", "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/versions/{containerVersionId}/publish", "httpMethod": "POST", "parameters": { "containerId": { "type": "string", "description": "The GTM Container ID.", "location": "path", "required": true }, "fingerprint": { "description": "When provided, this fingerprint must match the fingerprint of the container version in storage.", "location": "query", "type": "string" }, "accountId": { "required": true, "location": "path", "type": "string", "description": "The GTM Account ID." }, "containerVersionId": { "location": "path", "type": "string", "required": true, "description": "The GTM Container Version ID." } }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.publish" ] }, "restore": { "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "parameters": { "containerVersionId": { "required": true, "type": "string", "description": "The GTM Container Version ID.", "location": "path" }, "containerId": { "type": "string", "description": "The GTM Container ID.", "required": true, "location": "path" }, "accountId": { "required": true, "description": "The GTM Account ID.", "type": "string", "location": "path" } }, "response": { "$ref": "ContainerVersion" }, "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/versions/{containerVersionId}/restore", "httpMethod": "POST", "parameterOrder": [ "accountId", "containerId", "containerVersionId" ], "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).", "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/versions/{containerVersionId}/restore", "id": "tagmanager.accounts.containers.versions.restore" }, "create": { "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containerversions" ], "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/versions", "description": "Creates a Container Version.", "response": { "$ref": "CreateContainerVersionResponse" }, "parameters": { "accountId": { "description": "The GTM Account ID.", "type": "string", "location": "path", "required": true }, "containerId": { "location": "path", "type": "string", "description": "The GTM Container ID.", "required": true } }, "httpMethod": "POST", "parameterOrder": [ "accountId", "containerId" ], "request": { "$ref": "CreateContainerVersionRequestVersionOptions" }, "id": "tagmanager.accounts.containers.versions.create", "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/versions" }, "delete": { "httpMethod": "DELETE", "parameterOrder": [ "accountId", "containerId", "containerVersionId" ], "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/versions/{containerVersionId}", "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", "parameters": { "accountId": { "location": "path", "description": "The GTM Account ID.", "type": "string", "required": true }, "containerId": { "location": "path", "description": "The GTM Container ID.", "type": "string", "required": true }, "containerVersionId": { "location": "path", "description": "The GTM Container Version ID.", "type": "string", "required": true } } }, "undelete": { "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containerversions" ], "parameterOrder": [ "accountId", "containerId", "containerVersionId" ], "response": { "$ref": "ContainerVersion" }, "id": "tagmanager.accounts.containers.versions.undelete", "description": "Undeletes a Container Version.", "httpMethod": "POST", "parameters": { "accountId": { "required": true, "location": "path", "description": "The GTM Account ID.", "type": "string" }, "containerId": { "type": "string", "location": "path", "required": true, "description": "The GTM Container ID." }, "containerVersionId": { "description": "The GTM Container Version ID.", "location": "path", "type": "string", "required": true } }, "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/versions/{containerVersionId}/undelete", "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/versions/{containerVersionId}/undelete" }, "get": { "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/versions/{containerVersionId}", "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/versions/{containerVersionId}", "parameterOrder": [ "accountId", "containerId", "containerVersionId" ], "description": "Gets a Container Version.", "httpMethod": "GET", "response": { "$ref": "ContainerVersion" }, "id": "tagmanager.accounts.containers.versions.get", "parameters": { "containerId": { "description": "The GTM Container ID.", "required": true, "type": "string", "location": "path" }, "containerVersionId": { "location": "path", "description": "The GTM Container Version ID. Specify published to retrieve the currently published version.", "type": "string", "required": true }, "accountId": { "description": "The GTM Account ID.", "required": true, "location": "path", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.edit.containerversions", "https://www.googleapis.com/auth/tagmanager.readonly" ] }, "list": { "httpMethod": "GET", "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/versions", "response": { "$ref": "ListContainerVersionsResponse" }, "parameters": { "includeDeleted": { "default": "false", "location": "query", "type": "boolean", "description": "Also retrieve deleted (archived) versions when true." }, "accountId": { "required": true, "type": "string", "location": "path", "description": "The GTM Account ID." }, "headers": { "type": "boolean", "location": "query", "default": "false", "description": "Retrieve headers only when true." }, "containerId": { "location": "path", "type": "string", "required": true, "description": "The GTM Container ID." } }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.edit.containerversions", "https://www.googleapis.com/auth/tagmanager.readonly" ], "parameterOrder": [ "accountId", "containerId" ], "id": "tagmanager.accounts.containers.versions.list", "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/versions", "description": "Lists all Container Versions of a GTM Container." }, "update": { "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/versions/{containerVersionId}", "description": "Updates a Container Version.", "httpMethod": "PUT", "request": { "$ref": "ContainerVersion" }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containerversions" ], "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/versions/{containerVersionId}", "parameters": { "accountId": { "description": "The GTM Account ID.", "required": true, "location": "path", "type": "string" }, "containerVersionId": { "required": true, "description": "The GTM Container Version ID.", "type": "string", "location": "path" }, "containerId": { "required": true, "type": "string", "description": "The GTM Container ID.", "location": "path" }, "fingerprint": { "location": "query", "description": "When provided, this fingerprint must match the fingerprint of the container version in storage.", "type": "string" } }, "response": { "$ref": "ContainerVersion" }, "id": "tagmanager.accounts.containers.versions.update", "parameterOrder": [ "accountId", "containerId", "containerVersionId" ] } } }, "triggers": { "methods": { "update": { "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/triggers/{triggerId}", "description": "Updates a GTM Trigger.", "httpMethod": "PUT", "parameterOrder": [ "accountId", "containerId", "triggerId" ], "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/triggers/{triggerId}", "parameters": { "accountId": { "location": "path", "description": "The GTM Account ID.", "type": "string", "required": true }, "triggerId": { "description": "The GTM Trigger ID.", "required": true, "type": "string", "location": "path" }, "containerId": { "required": true, "description": "The GTM Container ID.", "type": "string", "location": "path" }, "fingerprint": { "description": "When provided, this fingerprint must match the fingerprint of the trigger in storage.", "location": "query", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "request": { "$ref": "Trigger" }, "response": { "$ref": "Trigger" }, "id": "tagmanager.accounts.containers.triggers.update" }, "list": { "response": { "$ref": "ListTriggersResponse" }, "description": "Lists all GTM Triggers of a Container.", "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/triggers", "parameterOrder": [ "accountId", "containerId" ], "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "httpMethod": "GET", "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/triggers", "id": "tagmanager.accounts.containers.triggers.list", "parameters": { "containerId": { "type": "string", "location": "path", "description": "The GTM Container ID.", "required": true }, "accountId": { "location": "path", "type": "string", "required": true, "description": "The GTM Account ID." } } }, "create": { "httpMethod": "POST", "response": { "$ref": "Trigger" }, "parameters": { "accountId": { "type": "string", "location": "path", "required": true, "description": "The GTM Account ID." }, "containerId": { "type": "string", "location": "path", "required": true, "description": "The GTM Container ID." } }, "parameterOrder": [ "accountId", "containerId" ], "description": "Creates a GTM Trigger.", "id": "tagmanager.accounts.containers.triggers.create", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "request": { "$ref": "Trigger" }, "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/triggers", "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/triggers" }, "delete": { "httpMethod": "DELETE", "parameterOrder": [ "accountId", "containerId", "triggerId" ], "description": "Deletes a GTM Trigger.", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/triggers/{triggerId}", "id": "tagmanager.accounts.containers.triggers.delete", "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/triggers/{triggerId}", "parameters": { "containerId": { "required": true, "type": "string", "description": "The GTM Container ID.", "location": "path" }, "accountId": { "required": true, "type": "string", "description": "The GTM Account ID.", "location": "path" }, "triggerId": { "location": "path", "type": "string", "required": true, "description": "The GTM Trigger ID." } } }, "get": { "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/triggers/{triggerId}", "parameters": { "accountId": { "required": true, "type": "string", "location": "path", "description": "The GTM Account ID." }, "containerId": { "location": "path", "description": "The GTM Container ID.", "required": true, "type": "string" }, "triggerId": { "required": true, "description": "The GTM Trigger ID.", "location": "path", "type": "string" } }, "httpMethod": "GET", "parameterOrder": [ "accountId", "containerId", "triggerId" ], "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/triggers/{triggerId}", "response": { "$ref": "Trigger" }, "description": "Gets a GTM Trigger.", "id": "tagmanager.accounts.containers.triggers.get" } } }, "folders": { "methods": { "update": { "response": { "$ref": "Folder" }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "description": "Updates a GTM Folder.", "request": { "$ref": "Folder" }, "parameters": { "folderId": { "description": "The GTM Folder ID.", "required": true, "type": "string", "location": "path" }, "containerId": { "type": "string", "description": "The GTM Container ID.", "location": "path", "required": true }, "fingerprint": { "description": "When provided, this fingerprint must match the fingerprint of the folder in storage.", "type": "string", "location": "query" }, "accountId": { "required": true, "description": "The GTM Account ID.", "location": "path", "type": "string" } }, "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/folders/{folderId}", "id": "tagmanager.accounts.containers.folders.update", "httpMethod": "PUT", "parameterOrder": [ "accountId", "containerId", "folderId" ], "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/folders/{folderId}" }, "get": { "parameterOrder": [ "accountId", "containerId", "folderId" ], "response": { "$ref": "Folder" }, "parameters": { "folderId": { "required": true, "type": "string", "description": "The GTM Folder ID.", "location": "path" }, "containerId": { "type": "string", "location": "path", "required": true, "description": "The GTM Container ID." }, "accountId": { "type": "string", "required": true, "location": "path", "description": "The GTM Account ID." } }, "description": "Gets a GTM Folder.", "id": "tagmanager.accounts.containers.folders.get", "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/folders/{folderId}", "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/folders/{folderId}", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "httpMethod": "GET" }, "list": { "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/folders", "parameterOrder": [ "accountId", "containerId" ], "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/folders", "id": "tagmanager.accounts.containers.folders.list", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "response": { "$ref": "ListFoldersResponse" }, "parameters": { "containerId": { "required": true, "type": "string", "location": "path", "description": "The GTM Container ID." }, "accountId": { "required": true, "type": "string", "description": "The GTM Account ID.", "location": "path" } }, "description": "Lists all GTM Folders of a Container.", "httpMethod": "GET" }, "create": { "description": "Creates a GTM Folder.", "parameterOrder": [ "accountId", "containerId" ], "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/folders", "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/folders", "parameters": { "accountId": { "description": "The GTM Account ID.", "location": "path", "required": true, "type": "string" }, "containerId": { "description": "The GTM Container ID.", "type": "string", "location": "path", "required": true } }, "response": { "$ref": "Folder" }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "id": "tagmanager.accounts.containers.folders.create", "request": { "$ref": "Folder" }, "httpMethod": "POST" }, "delete": { "description": "Deletes a GTM Folder.", "parameters": { "accountId": { "required": true, "description": "The GTM Account ID.", "type": "string", "location": "path" }, "folderId": { "type": "string", "required": true, "location": "path", "description": "The GTM Folder ID." }, "containerId": { "location": "path", "required": true, "description": "The GTM Container ID.", "type": "string" } }, "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/folders/{folderId}", "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/folders/{folderId}", "parameterOrder": [ "accountId", "containerId", "folderId" ], "id": "tagmanager.accounts.containers.folders.delete" } }, "resources": { "entities": { "methods": { "list": { "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "httpMethod": "GET", "parameterOrder": [ "accountId", "containerId", "folderId" ], "parameters": { "containerId": { "type": "string", "description": "The GTM Container ID.", "required": true, "location": "path" }, "accountId": { "required": true, "description": "The GTM Account ID.", "type": "string", "location": "path" }, "folderId": { "type": "string", "location": "path", "description": "The GTM Folder ID.", "required": true } }, "response": { "$ref": "FolderEntities" }, "description": "List all entities in a GTM Folder.", "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/folders/{folderId}/entities", "id": "tagmanager.accounts.containers.folders.entities.list", "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/folders/{folderId}/entities" } } } } }, "environments": { "methods": { "get": { "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "response": { "$ref": "Environment" }, "id": "tagmanager.accounts.containers.environments.get", "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/environments/{environmentId}", "description": "Gets a GTM Environment.", "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/environments/{environmentId}", "parameters": { "containerId": { "description": "The GTM Container ID.", "required": true, "type": "string", "location": "path" }, "environmentId": { "required": true, "type": "string", "description": "The GTM Environment ID.", "location": "path" }, "accountId": { "location": "path", "description": "The GTM Account ID.", "type": "string", "required": true } }, "httpMethod": "GET", "parameterOrder": [ "accountId", "containerId", "environmentId" ] }, "update": { "request": { "$ref": "Environment" }, "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/environments/{environmentId}", "response": { "$ref": "Environment" }, "id": "tagmanager.accounts.containers.environments.update", "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/environments/{environmentId}", "parameters": { "accountId": { "required": true, "description": "The GTM Account ID.", "location": "path", "type": "string" }, "containerId": { "type": "string", "location": "path", "required": true, "description": "The GTM Container ID." }, "fingerprint": { "location": "query", "description": "When provided, this fingerprint must match the fingerprint of the environment in storage.", "type": "string" }, "environmentId": { "required": true, "type": "string", "location": "path", "description": "The GTM Environment ID." } }, "httpMethod": "PUT", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "parameterOrder": [ "accountId", "containerId", "environmentId" ], "description": "Updates a GTM Environment." }, "list": { "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/environments", "description": "Lists all GTM Environments of a GTM Container.", "httpMethod": "GET", "parameters": { "accountId": { "type": "string", "location": "path", "required": true, "description": "The GTM Account ID." }, "containerId": { "description": "The GTM Container ID.", "required": true, "type": "string", "location": "path" } }, "id": "tagmanager.accounts.containers.environments.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", "parameterOrder": [ "accountId", "containerId" ] }, "create": { "id": "tagmanager.accounts.containers.environments.create", "description": "Creates a GTM Environment.", "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/environments", "parameterOrder": [ "accountId", "containerId" ], "httpMethod": "POST", "request": { "$ref": "Environment" }, "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/environments", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "parameters": { "accountId": { "description": "The GTM Account ID.", "location": "path", "type": "string", "required": true }, "containerId": { "location": "path", "type": "string", "description": "The GTM Container ID.", "required": true } }, "response": { "$ref": "Environment" } }, "delete": { "httpMethod": "DELETE", "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/environments/{environmentId}", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/environments/{environmentId}", "id": "tagmanager.accounts.containers.environments.delete", "parameters": { "accountId": { "location": "path", "type": "string", "required": true, "description": "The GTM Account ID." }, "environmentId": { "required": true, "description": "The GTM Environment ID.", "type": "string", "location": "path" }, "containerId": { "required": true, "type": "string", "description": "The GTM Container ID.", "location": "path" } }, "description": "Deletes a GTM Environment.", "parameterOrder": [ "accountId", "containerId", "environmentId" ] } } }, "move_folders": { "methods": { "update": { "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/move_folders/{folderId}", "parameters": { "triggerId": { "repeated": true, "description": "The triggers to be moved to the folder.", "type": "string", "location": "query" }, "folderId": { "description": "The GTM Folder ID.", "location": "path", "type": "string", "required": true }, "containerId": { "required": true, "description": "The GTM Container ID.", "location": "path", "type": "string" }, "accountId": { "type": "string", "description": "The GTM Account ID.", "required": true, "location": "path" }, "tagId": { "description": "The tags to be moved to the folder.", "location": "query", "repeated": true, "type": "string" }, "variableId": { "location": "query", "description": "The variables to be moved to the folder.", "type": "string", "repeated": true } }, "description": "Moves entities to a GTM Folder.", "parameterOrder": [ "accountId", "containerId", "folderId" ], "request": { "$ref": "Folder" }, "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/move_folders/{folderId}", "httpMethod": "PUT", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "id": "tagmanager.accounts.containers.move_folders.update" } } }, "tags": { "methods": { "update": { "request": { "$ref": "Tag" }, "parameterOrder": [ "accountId", "containerId", "tagId" ], "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/tags/{tagId}", "description": "Updates a GTM Tag.", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "httpMethod": "PUT", "id": "tagmanager.accounts.containers.tags.update", "response": { "$ref": "Tag" }, "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/tags/{tagId}", "parameters": { "tagId": { "description": "The GTM Tag ID.", "required": true, "type": "string", "location": "path" }, "containerId": { "description": "The GTM Container ID.", "type": "string", "required": true, "location": "path" }, "fingerprint": { "type": "string", "location": "query", "description": "When provided, this fingerprint must match the fingerprint of the tag in storage." }, "accountId": { "type": "string", "required": true, "location": "path", "description": "The GTM Account ID." } } }, "get": { "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "response": { "$ref": "Tag" }, "parameters": { "tagId": { "type": "string", "description": "The GTM Tag ID.", "location": "path", "required": true }, "containerId": { "description": "The GTM Container ID.", "required": true, "type": "string", "location": "path" }, "accountId": { "required": true, "type": "string", "description": "The GTM Account ID.", "location": "path" } }, "parameterOrder": [ "accountId", "containerId", "tagId" ], "description": "Gets a GTM Tag.", "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/tags/{tagId}", "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/tags/{tagId}", "httpMethod": "GET", "id": "tagmanager.accounts.containers.tags.get" }, "list": { "description": "Lists all GTM Tags of a Container.", "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/tags", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "parameterOrder": [ "accountId", "containerId" ], "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/tags", "id": "tagmanager.accounts.containers.tags.list", "parameters": { "containerId": { "required": true, "description": "The GTM Container ID.", "location": "path", "type": "string" }, "accountId": { "location": "path", "required": true, "description": "The GTM Account ID.", "type": "string" } }, "httpMethod": "GET", "response": { "$ref": "ListTagsResponse" } }, "create": { "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/tags", "request": { "$ref": "Tag" }, "httpMethod": "POST", "response": { "$ref": "Tag" }, "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/tags", "id": "tagmanager.accounts.containers.tags.create", "description": "Creates a GTM Tag.", "parameters": { "containerId": { "required": true, "type": "string", "description": "The GTM Container ID.", "location": "path" }, "accountId": { "location": "path", "required": true, "type": "string", "description": "The GTM Account ID." } }, "parameterOrder": [ "accountId", "containerId" ] }, "delete": { "path": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/tags/{tagId}", "description": "Deletes a GTM Tag.", "httpMethod": "DELETE", "parameters": { "tagId": { "type": "string", "description": "The GTM Tag ID.", "location": "path", "required": true }, "containerId": { "required": true, "description": "The GTM Container ID.", "location": "path", "type": "string" }, "accountId": { "location": "path", "type": "string", "description": "The GTM Account ID.", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "flatPath": "tagmanager/v1/accounts/{accountId}/containers/{containerId}/tags/{tagId}", "parameterOrder": [ "accountId", "containerId", "tagId" ], "id": "tagmanager.accounts.containers.tags.delete" } } } } } }, "methods": { "list": { "path": "tagmanager/v1/accounts", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.manage.accounts", "https://www.googleapis.com/auth/tagmanager.readonly" ], "parameterOrder": [], "response": { "$ref": "ListAccountsResponse" }, "httpMethod": "GET", "description": "Lists all GTM Accounts that a user has access to.", "id": "tagmanager.accounts.list", "flatPath": "tagmanager/v1/accounts", "parameters": {} }, "get": { "response": { "$ref": "Account" }, "id": "tagmanager.accounts.get", "parameterOrder": [ "accountId" ], "description": "Gets a GTM Account.", "flatPath": "tagmanager/v1/accounts/{accountId}", "path": "tagmanager/v1/accounts/{accountId}", "parameters": { "accountId": { "type": "string", "description": "The GTM Account ID.", "location": "path", "required": true } }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.manage.accounts", "https://www.googleapis.com/auth/tagmanager.readonly" ] }, "update": { "parameterOrder": [ "accountId" ], "request": { "$ref": "Account" }, "id": "tagmanager.accounts.update", "scopes": [ "https://www.googleapis.com/auth/tagmanager.manage.accounts" ], "path": "tagmanager/v1/accounts/{accountId}", "response": { "$ref": "Account" }, "parameters": { "accountId": { "required": true, "type": "string", "location": "path", "description": "The GTM Account ID." }, "fingerprint": { "type": "string", "location": "query", "description": "When provided, this fingerprint must match the fingerprint of the account in storage." } }, "flatPath": "tagmanager/v1/accounts/{accountId}", "description": "Updates a GTM Account.", "httpMethod": "PUT" } } } }, "ownerName": "Google", "schemas": { "ContainerAccess": { "type": "object", "id": "ContainerAccess", "description": "Defines the Google Tag Manager Container access permissions.", "properties": { "permission": { "items": { "type": "string", "enumDescriptions": [ "", "", "", "", "", "" ], "enum": [ "read", "edit", "publish", "delete", "manage", "editWorkspace" ] }, "description": "List of Container permissions. Valid container permissions are: read, edit, delete, publish.", "type": "array" }, "containerId": { "type": "string", "description": "GTM Container ID." } } }, "Container": { "description": "Represents a Google Tag Manager Container.", "properties": { "publicId": { "description": "Container Public ID.", "type": "string" }, "usageContext": { "items": { "type": "string", "enumDescriptions": [ "", "", "", "", "", "" ], "enum": [ "web", "android", "ios", "androidSdk5", "iosSdk5", "amp" ] }, "type": "array", "description": "List of Usage Contexts for the Container. Valid values include: web, android, ios." }, "containerId": { "description": "The Container ID uniquely identifies the GTM Container.", "type": "string" }, "enabledBuiltInVariable": { "type": "array", "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" ], "enumDescriptions": [ "", "", "", "", "For web or mobile.", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "For web or mobile.", "", "For web or mobile.", "For web or mobile.", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ], "type": "string" }, "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." }, "notes": { "description": "Container Notes.", "type": "string" }, "timeZoneId": { "type": "string", "description": "Container Time Zone ID." }, "name": { "type": "string", "description": "Container display name." }, "fingerprint": { "description": "The fingerprint of the GTM Container as computed at storage time. This value is recomputed whenever the account is modified.", "type": "string" }, "domainName": { "type": "array", "description": "Optional list of domain names associated with the Container.", "items": { "type": "string" } }, "accountId": { "type": "string", "description": "GTM Account ID." }, "timeZoneCountryId": { "type": "string", "description": "Container Country ID." } }, "type": "object", "id": "Container" }, "ListTriggersResponse": { "id": "ListTriggersResponse", "type": "object", "properties": { "triggers": { "description": "All GTM Triggers of a GTM Container.", "type": "array", "items": { "$ref": "Trigger" } } }, "description": "List triggers response." }, "Variable": { "type": "object", "description": "Represents a Google Tag Manager Variable.", "id": "Variable", "properties": { "accountId": { "type": "string", "description": "GTM Account ID." }, "parameter": { "description": "The variable's parameters.", "items": { "$ref": "Parameter" }, "type": "array" }, "name": { "type": "string", "description": "Variable display name." }, "scheduleStartMs": { "format": "int64", "type": "string", "description": "The start timestamp in milliseconds to schedule a variable." }, "type": { "type": "string", "description": "GTM Variable Type." }, "parentFolderId": { "description": "Parent folder id.", "type": "string" }, "enablingTriggerId": { "type": "array", "items": { "type": "string" }, "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." }, "notes": { "description": "User notes on how to apply this variable in the container.", "type": "string" }, "fingerprint": { "type": "string", "description": "The fingerprint of the GTM Variable as computed at storage time. This value is recomputed whenever the variable is modified." }, "disablingTriggerId": { "items": { "type": "string" }, "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.", "type": "array" }, "variableId": { "description": "The Variable ID uniquely identifies the GTM Variable.", "type": "string" }, "containerId": { "description": "GTM Container ID.", "type": "string" }, "scheduleEndMs": { "description": "The end timestamp in milliseconds to schedule a variable.", "type": "string", "format": "int64" } } }, "Account": { "id": "Account", "type": "object", "description": "Represents a Google Tag Manager Account.", "properties": { "fingerprint": { "type": "string", "description": "The fingerprint of the GTM Account as computed at storage time. This value is recomputed whenever the account is modified." }, "name": { "description": "Account display name.", "type": "string" }, "accountId": { "type": "string", "description": "The Account ID uniquely identifies the GTM Account." }, "shareData": { "description": "Whether the account shares data anonymously with Google and others.", "type": "boolean" } } }, "Parameter": { "description": "Represents a Google Tag Manager Parameter.", "properties": { "type": { "type": "string", "enumDescriptions": [ "May include variable references.", "", "", "", "", "", "" ], "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 ", "enum": [ "template", "integer", "boolean", "list", "map", "triggerReference", "tagReference" ] }, "list": { "items": { "$ref": "Parameter" }, "description": "This list parameter's parameters (keys will be ignored).", "type": "array" }, "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" }, "value": { "type": "string", "description": "A parameter's value (may contain variable references). as appropriate to the specified type." }, "map": { "type": "array", "description": "This map parameter's parameters (must have keys; keys must be unique).", "items": { "$ref": "Parameter" } } }, "type": "object", "id": "Parameter" }, "CreateContainerVersionRequestVersionOptions": { "id": "CreateContainerVersionRequestVersionOptions", "description": "Options for new container versions.", "type": "object", "properties": { "name": { "description": "The name of the container version to be created.", "type": "string" }, "quickPreview": { "description": "The creation of this version may be for quick preview and shouldn't be saved.", "type": "boolean" }, "notes": { "description": "The notes of the container version to be created.", "type": "string" } } }, "ListFoldersResponse": { "type": "object", "properties": { "folders": { "description": "All GTM Folders of a GTM Container.", "type": "array", "items": { "$ref": "Folder" } } }, "id": "ListFoldersResponse", "description": "List Folders Response." }, "ListAccountsResponse": { "description": "List Accounts Response.", "type": "object", "id": "ListAccountsResponse", "properties": { "accounts": { "items": { "$ref": "Account" }, "type": "array", "description": "List of GTM Accounts that a user has access to." } } }, "ListTagsResponse": { "properties": { "tags": { "type": "array", "description": "All GTM Tags of a GTM Container.", "items": { "$ref": "Tag" } } }, "description": "List Tags Response.", "type": "object", "id": "ListTagsResponse" }, "ListVariablesResponse": { "description": "List Variables Response.", "type": "object", "properties": { "variables": { "type": "array", "items": { "$ref": "Variable" }, "description": "All GTM Variables of a GTM Container." } }, "id": "ListVariablesResponse" }, "ContainerVersion": { "properties": { "tag": { "type": "array", "items": { "$ref": "Tag" }, "description": "The tags in the container that this version was taken from." }, "name": { "description": "Container version display name.", "type": "string" }, "containerId": { "description": "GTM Container ID.", "type": "string" }, "container": { "$ref": "Container", "description": "The container that this version was taken from." }, "variable": { "description": "The variables in the container that this version was taken from.", "type": "array", "items": { "$ref": "Variable" } }, "containerVersionId": { "type": "string", "description": "The Container Version ID uniquely identifies the GTM Container Version." }, "notes": { "type": "string", "description": "User notes on how to apply this container version in the container." }, "trigger": { "description": "The triggers in the container that this version was taken from.", "type": "array", "items": { "$ref": "Trigger" } }, "accountId": { "description": "GTM Account ID.", "type": "string" }, "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." }, "deleted": { "type": "boolean", "description": "A value of true indicates this container version has been deleted." }, "folder": { "description": "The folders in the container that this version was taken from.", "items": { "$ref": "Folder" }, "type": "array" } }, "id": "ContainerVersion", "type": "object", "description": "Represents a Google Tag Manager Container Version." }, "ListEnvironmentsResponse": { "id": "ListEnvironmentsResponse", "properties": { "environments": { "items": { "$ref": "Environment" }, "type": "array", "description": "All Environments of a GTM Container." } }, "type": "object", "description": "List Environments Response." }, "ListContainerVersionsResponse": { "type": "object", "description": "List container versions response.", "id": "ListContainerVersionsResponse", "properties": { "containerVersion": { "items": { "$ref": "ContainerVersion" }, "description": "All versions of a GTM Container.", "type": "array" }, "containerVersionHeader": { "description": "All container version headers of a GTM Container.", "type": "array", "items": { "$ref": "ContainerVersionHeader" } } } }, "SetupTag": { "type": "object", "id": "SetupTag", "properties": { "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" }, "tagName": { "description": "The name of the setup tag.", "type": "string" } } }, "TeardownTag": { "properties": { "tagName": { "type": "string", "description": "The name of the teardown tag." }, "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." } }, "type": "object", "id": "TeardownTag" }, "Environment": { "properties": { "authorizationTimestampMs": { "format": "int64", "type": "string", "description": "The last update time-stamp for the authorization code." }, "url": { "type": "string", "description": "Default preview page url for the environment." }, "fingerprint": { "description": "The fingerprint of the GTM environment as computed at storage time. This value is recomputed whenever the environment is modified.", "type": "string" }, "containerVersionId": { "type": "string" }, "enableDebug": { "type": "boolean", "description": "Whether or not to enable debug by default on for the environment." }, "description": { "description": "The environment description. Can be set or changed only on USER type environments.", "type": "string" }, "containerId": { "type": "string", "description": "GTM Container ID." }, "authorizationCode": { "type": "string", "description": "The environment authorization code." }, "type": { "enum": [ "user", "live", "latest", "draft" ], "description": "The type of this environment.", "type": "string", "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." ] }, "accountId": { "description": "GTM Account ID.", "type": "string" }, "name": { "type": "string", "description": "The environment display name. Can be set or changed only on USER type environments." }, "environmentId": { "type": "string", "description": "GTM Environment ID uniquely identifies the GTM 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" }, "Tag": { "type": "object", "description": "Represents a Google Tag Manager Tag.", "id": "Tag", "properties": { "containerId": { "description": "GTM Container ID.", "type": "string" }, "parentFolderId": { "type": "string", "description": "Parent folder id." }, "priority": { "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.", "$ref": "Parameter" }, "notes": { "type": "string", "description": "User notes on how to apply this tag in the container." }, "scheduleEndMs": { "format": "int64", "type": "string", "description": "The end timestamp in milliseconds to schedule a tag." }, "paused": { "description": "True if the tag is paused.", "type": "boolean" }, "tagId": { "description": "The Tag ID uniquely identifies the GTM Tag.", "type": "string" }, "firingTriggerId": { "type": "array", "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" } }, "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" ] }, "teardownTag": { "type": "array", "items": { "$ref": "TeardownTag" }, "description": "The list of teardown tags. Currently we only allow one." }, "scheduleStartMs": { "type": "string", "format": "int64", "description": "The start timestamp in milliseconds to schedule a tag." }, "blockingTriggerId": { "type": "array", "items": { "type": "string" }, "description": "Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag will not fire." }, "fingerprint": { "type": "string", "description": "The fingerprint of the GTM Tag as computed at storage time. This value is recomputed whenever the tag is modified." }, "accountId": { "description": "GTM Account ID.", "type": "string" }, "parameter": { "type": "array", "items": { "$ref": "Parameter" }, "description": "The tag's parameters." }, "liveOnly": { "type": "boolean", "description": "If set to true, this tag will only fire in the live environment (e.g. not in preview or debug mode)." }, "setupTag": { "description": "The list of setup tags. Currently we only allow one.", "type": "array", "items": { "$ref": "SetupTag" } }, "name": { "description": "Tag display name.", "type": "string" }, "type": { "type": "string", "description": "GTM Tag Type." } } }, "ListAccountUsersResponse": { "properties": { "userAccess": { "description": "All GTM AccountUsers of a GTM Account.", "type": "array", "items": { "$ref": "UserAccess" } } }, "description": "List AccountUsers Response.", "id": "ListAccountUsersResponse", "type": "object" }, "UserAccess": { "description": "Represents a user's permissions to an account and its container.", "properties": { "accountAccess": { "description": "GTM Account access permissions.", "$ref": "AccountAccess" }, "containerAccess": { "items": { "$ref": "ContainerAccess" }, "description": "GTM Container access permissions.", "type": "array" }, "emailAddress": { "description": "User's email address.", "type": "string" }, "accountId": { "description": "GTM Account ID.", "type": "string" }, "permissionId": { "type": "string", "description": "Account Permission ID." } }, "type": "object", "id": "UserAccess" }, "AccountAccess": { "type": "object", "properties": { "permission": { "description": "List of Account permissions. Valid account permissions are read and manage.", "type": "array", "items": { "enum": [ "read", "edit", "publish", "delete", "manage", "editWorkspace" ], "enumDescriptions": [ "", "", "", "", "", "" ], "type": "string" } } }, "id": "AccountAccess", "description": "Defines the Google Tag Manager Account access permissions." }, "CreateContainerVersionResponse": { "id": "CreateContainerVersionResponse", "type": "object", "description": "Create container versions response.", "properties": { "containerVersion": { "description": "The container version created.", "$ref": "ContainerVersion" }, "compilerError": { "description": "Compiler errors or not.", "type": "boolean" } } }, "ContainerVersionHeader": { "type": "object", "properties": { "accountId": { "type": "string", "description": "GTM Account ID." }, "deleted": { "description": "A value of true indicates this container version has been deleted.", "type": "boolean" }, "containerVersionId": { "type": "string", "description": "The Container Version ID uniquely identifies the GTM Container Version." }, "name": { "type": "string", "description": "Container version display name." }, "numTags": { "type": "string", "description": "Number of tags in the container version." }, "numTriggers": { "type": "string", "description": "Number of triggers in the container version." }, "numVariables": { "description": "Number of variables in the container version.", "type": "string" }, "containerId": { "description": "GTM Container ID.", "type": "string" } }, "description": "Represents a Google Tag Manager Container Version Header.", "id": "ContainerVersionHeader" }, "ListContainersResponse": { "type": "object", "description": "List Containers Response.", "id": "ListContainersResponse", "properties": { "containers": { "type": "array", "description": "All Containers of a GTM Account.", "items": { "$ref": "Container" } } } }, "Trigger": { "id": "Trigger", "properties": { "intervalSeconds": { "description": "Time between Timer Events to fire (in seconds). Only valid for AMP Timer trigger.", "$ref": "Parameter" }, "waitForTags": { "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.", "$ref": "Parameter" }, "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." }, "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" }, "customEventFilter": { "items": { "$ref": "Condition" }, "description": "Used in the case of custom event, which is fired iff all Conditions are true.", "type": "array" }, "visiblePercentageMax": { "$ref": "Parameter", "description": "A visibility trigger maximum percent visibility. Only valid for AMP Visibility trigger." }, "autoEventFilter": { "type": "array", "items": { "$ref": "Condition" }, "description": "Used in the case of auto event tracking." }, "totalTimeMinMilliseconds": { "description": "A visibility trigger minimum total visible time (in milliseconds). Only valid for AMP Visibility trigger.", "$ref": "Parameter" }, "filter": { "items": { "$ref": "Condition" }, "type": "array", "description": "The trigger will only fire iff all Conditions are true." }, "checkValidation": { "$ref": "Parameter", "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." }, "selector": { "description": "A click trigger CSS selector (i.e. \"a\", \"button\" etc.). Only valid for AMP Click trigger.", "$ref": "Parameter" }, "eventName": { "description": "Name of the GTM event that is fired. Only valid for Timer triggers.", "$ref": "Parameter" }, "visibilitySelector": { "description": "A visibility trigger CSS selector (i.e. \"#id\"). Only valid for AMP Visibility trigger.", "$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" }, "visiblePercentageMin": { "description": "A visibility trigger minimum percent visibility. Only valid for AMP Visibility trigger.", "$ref": "Parameter" }, "maxTimerLengthSeconds": { "$ref": "Parameter", "description": "Max time to fire Timer Events (in seconds). Only valid for AMP Timer trigger." }, "containerId": { "description": "GTM Container ID.", "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" }, "name": { "description": "Trigger display name.", "type": "string" }, "type": { "enum": [ "pageview", "domReady", "windowLoaded", "customEvent", "triggerGroup", "always", "formSubmission", "click", "linkClick", "jsError", "historyChange", "timer", "ampClick", "ampTimer", "ampScroll", "ampVisibility", "youTubeVideo", "scrollDepth", "elementVisibility" ], "enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ], "type": "string", "description": "Defines the data layer event that causes this trigger." }, "fingerprint": { "description": "The fingerprint of the GTM Trigger as computed at storage time. This value is recomputed whenever the trigger is modified.", "type": "string" }, "parentFolderId": { "type": "string", "description": "Parent folder id." }, "accountId": { "type": "string", "description": "GTM Account ID." }, "uniqueTriggerId": { "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.", "$ref": "Parameter" }, "parameter": { "description": "Additional parameters.", "type": "array", "items": { "$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." }, "interval": { "$ref": "Parameter", "description": "Time between triggering recurring Timer Events (in milliseconds). Only valid for Timer triggers." } }, "description": "Represents a Google Tag Manager Trigger", "type": "object" }, "Folder": { "type": "object", "properties": { "name": { "type": "string", "description": "Folder display name." }, "accountId": { "description": "GTM Account ID.", "type": "string" }, "folderId": { "type": "string", "description": "The Folder ID uniquely identifies the GTM Folder." }, "containerId": { "type": "string", "description": "GTM Container ID." }, "fingerprint": { "description": "The fingerprint of the GTM Folder as computed at storage time. This value is recomputed whenever the folder is modified.", "type": "string" } }, "id": "Folder", "description": "Represents a Google Tag Manager Folder." }, "FolderEntities": { "description": "Represents a Google Tag Manager Folder's contents.", "type": "object", "id": "FolderEntities", "properties": { "tag": { "type": "array", "description": "The list of tags inside the folder.", "items": { "$ref": "Tag" } }, "trigger": { "items": { "$ref": "Trigger" }, "description": "The list of triggers inside the folder.", "type": "array" }, "variable": { "type": "array", "description": "The list of variables inside the folder.", "items": { "$ref": "Variable" } } } }, "PublishContainerVersionResponse": { "properties": { "compilerError": { "description": "Compiler errors or not.", "type": "boolean" }, "containerVersion": { "$ref": "ContainerVersion", "description": "The container version created." } }, "id": "PublishContainerVersionResponse", "type": "object", "description": "Publish container version response." }, "Condition": { "description": "Represents a predicate.", "properties": { "parameter": { "type": "array", "items": { "$ref": "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. " }, "type": { "enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "" ], "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "matchRegex", "greater", "greaterOrEquals", "less", "lessOrEquals", "cssSelector", "urlMatches" ], "description": "The type of operator for this condition." } }, "type": "object", "id": "Condition" } }, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "description": "This API allows clients to access and modify container and tag configuration.", "name": "tagmanager", "servicePath": "", "basePath": "", "canonicalName": "Tag Manager", "ownerDomain": "google.com", "id": "tagmanager:v1", "batchPath": "batch", "protocol": "rest", "documentationLink": "https://developers.google.com/tag-manager" }