{ "documentationLink": "https://developers.google.com/tag-manager", "baseUrl": "https://tagmanager.googleapis.com/", "version": "v2", "rootUrl": "https://tagmanager.googleapis.com/", "canonicalName": "Tag Manager", "discoveryVersion": "v1", "schemas": { "ContainerVersion": { "type": "object", "description": "Represents a Google Tag Manager Container Version.", "id": "ContainerVersion", "properties": { "variable": { "description": "The variables in the container that this version was taken from.", "items": { "$ref": "Variable" }, "type": "array" }, "customTemplate": { "items": { "$ref": "CustomTemplate" }, "type": "array", "description": "The custom templates in the container that this version was taken from." }, "description": { "description": "Container version description.", "type": "string" }, "fingerprint": { "description": "The fingerprint of the GTM Container Version as computed at storage time. This value is recomputed whenever the container version is modified.", "type": "string" }, "containerId": { "description": "GTM Container ID.", "type": "string" }, "tagManagerUrl": { "type": "string", "description": "Auto generated link to the tag manager UI" }, "trigger": { "description": "The triggers in the container that this version was taken from.", "type": "array", "items": { "$ref": "Trigger" } }, "path": { "description": "GTM Container Version's API relative path.", "type": "string" }, "client": { "items": { "$ref": "Client" }, "type": "array", "description": "The clients in the container that this version was taken from." }, "folder": { "type": "array", "description": "The folders in the container that this version was taken from.", "items": { "$ref": "Folder" } }, "container": { "$ref": "Container", "description": "The container that this version was taken from." }, "name": { "description": "Container version display name.", "type": "string" }, "zone": { "items": { "$ref": "Zone" }, "type": "array", "description": "The zones in the container that this version was taken from." }, "builtInVariable": { "type": "array", "items": { "$ref": "BuiltInVariable" }, "description": "The built-in variables in the container that this version was taken from." }, "gtagConfig": { "description": "The Google tag configs in the container that this version was taken from.", "items": { "$ref": "GtagConfig" }, "type": "array" }, "transformation": { "type": "array", "description": "The transformations in the container that this version was taken from.", "items": { "$ref": "Transformation" } }, "deleted": { "type": "boolean", "description": "A value of true indicates this container version has been deleted." }, "containerVersionId": { "type": "string", "description": "The Container Version ID uniquely identifies the GTM Container Version." }, "tag": { "items": { "$ref": "Tag" }, "type": "array", "description": "The tags in the container that this version was taken from." }, "accountId": { "description": "GTM Account ID.", "type": "string" } } }, "GetContainerSnippetResponse": { "type": "object", "id": "GetContainerSnippetResponse", "properties": { "containerConfig": { "description": "Server container config param for manually provisioning a tagging server.", "type": "string" }, "snippet": { "type": "string", "description": "Tagging snippet for a Container." } } }, "RevertBuiltInVariableResponse": { "properties": { "enabled": { "description": "Whether the built-in variable is enabled after reversion.", "type": "boolean" } }, "description": "The result of reverting a built-in variable in a workspace.", "id": "RevertBuiltInVariableResponse", "type": "object" }, "RevertTriggerResponse": { "properties": { "trigger": { "$ref": "Trigger", "description": "Trigger as it appears in the latest container version since the last workspace synchronization operation. If no trigger is present, that means the trigger was deleted in the latest container version." } }, "type": "object", "description": "The result of reverting a trigger in a workspace.", "id": "RevertTriggerResponse" }, "Parameter": { "id": "Parameter", "description": "Represents a Google Tag Manager Parameter.", "type": "object", "properties": { "isWeakReference": { "description": "Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.", "type": "boolean" }, "key": { "type": "string", "description": "The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values." }, "type": { "enumDescriptions": [ "", "May include variable references.", "", "", "", "", "", "" ], "type": "string", "enum": [ "typeUnspecified", "template", "integer", "boolean", "list", "map", "triggerReference", "tagReference" ], "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 " }, "value": { "description": "A parameter's value (may contain variable references). as appropriate to the specified type.", "type": "string" }, "list": { "type": "array", "items": { "$ref": "Parameter" }, "description": "This list parameter's parameters (keys will be ignored)." }, "map": { "items": { "$ref": "Parameter" }, "type": "array", "description": "This map parameter's parameters (must have keys; keys must be unique)." } } }, "BulkUpdateWorkspaceResponse": { "type": "object", "id": "BulkUpdateWorkspaceResponse", "properties": { "changes": { "items": { "$ref": "Entity" }, "description": "The entities that were added or updated during the bulk-update. Does not include entities that were deleted or updated by the system.", "type": "array" } } }, "Container": { "id": "Container", "description": "Represents a Google Tag Manager Container, which specifies the platform tags will run on, manages workspaces, and retains container versions.", "type": "object", "properties": { "usageContext": { "items": { "type": "string", "enum": [ "usageContextUnspecified", "web", "android", "ios", "androidSdk5", "iosSdk5", "amp", "server" ], "enumDescriptions": [ "", "", "", "", "", "", "", "" ] }, "type": "array", "description": "List of Usage Contexts for the Container. Valid values include: web, android, or ios." }, "containerId": { "type": "string", "description": "The Container ID uniquely identifies the GTM Container." }, "accountId": { "type": "string", "description": "GTM Account ID." }, "taggingServerUrls": { "items": { "type": "string" }, "type": "array", "description": "List of server-side container URLs for the Container. If multiple URLs are provided, all URL paths must match." }, "fingerprint": { "type": "string", "description": "The fingerprint of the GTM Container as computed at storage time. This value is recomputed whenever the account is modified." }, "tagIds": { "items": { "type": "string" }, "type": "array", "description": "All Tag IDs that refer to this Container." }, "path": { "description": "GTM Container's API relative path.", "type": "string" }, "name": { "description": "Container display name.", "type": "string" }, "publicId": { "type": "string", "description": "Container Public ID." }, "notes": { "description": "Container Notes.", "type": "string" }, "features": { "description": "Read-only Container feature set.", "$ref": "ContainerFeatures" }, "domainName": { "items": { "type": "string" }, "type": "array", "description": "List of domain names associated with the Container." }, "tagManagerUrl": { "description": "Auto generated link to the tag manager UI", "type": "string" } } }, "Trigger": { "properties": { "tagManagerUrl": { "description": "Auto generated link to the tag manager UI", "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" }, "continuousTimeMinMilliseconds": { "$ref": "Parameter", "description": "A visibility trigger minimum continuous visible time (in milliseconds). Only valid for AMP Visibility trigger." }, "fingerprint": { "type": "string", "description": "The fingerprint of the GTM Trigger as computed at storage time. This value is recomputed whenever the trigger is modified." }, "visiblePercentageMax": { "description": "A visibility trigger maximum percent visibility. Only valid for AMP Visibility trigger.", "$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." }, "autoEventFilter": { "type": "array", "items": { "$ref": "Condition" }, "description": "Used in the case of auto event tracking." }, "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" }, "containerId": { "description": "GTM Container ID.", "type": "string" }, "accountId": { "type": "string", "description": "GTM Account ID." }, "path": { "type": "string", "description": "GTM Trigger's API relative path." }, "notes": { "description": "User notes on how to apply this trigger in the container.", "type": "string" }, "eventName": { "description": "Name of the GTM event that is fired. Only valid for Timer triggers.", "$ref": "Parameter" }, "workspaceId": { "type": "string", "description": "GTM Workspace ID." }, "name": { "description": "Trigger display name.", "type": "string" }, "customEventFilter": { "type": "array", "items": { "$ref": "Condition" }, "description": "Used in the case of custom event, which is fired iff all Conditions are true." }, "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." }, "intervalSeconds": { "$ref": "Parameter", "description": "Time between Timer Events to fire (in seconds). Only valid for AMP Timer trigger." }, "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" }, "triggerId": { "description": "The Trigger ID uniquely identifies the GTM Trigger.", "type": "string" }, "filter": { "items": { "$ref": "Condition" }, "type": "array", "description": "The trigger will only fire iff all Conditions are true." }, "parentFolderId": { "type": "string", "description": "Parent folder id." }, "parameter": { "description": "Additional parameters.", "type": "array", "items": { "$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." }, "totalTimeMinMilliseconds": { "description": "A visibility trigger minimum total visible time (in milliseconds). 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." }, "limit": { "$ref": "Parameter", "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." }, "visiblePercentageMin": { "description": "A visibility trigger minimum percent visibility. Only valid for AMP Visibility trigger.", "$ref": "Parameter" }, "type": { "enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ], "description": "Defines the data layer event that causes this trigger.", "type": "string", "enum": [ "eventTypeUnspecified", "pageview", "domReady", "windowLoaded", "customEvent", "triggerGroup", "init", "consentInit", "serverPageview", "always", "firebaseAppException", "firebaseAppUpdate", "firebaseCampaign", "firebaseFirstOpen", "firebaseInAppPurchase", "firebaseNotificationDismiss", "firebaseNotificationForeground", "firebaseNotificationOpen", "firebaseNotificationReceive", "firebaseOsUpdate", "firebaseSessionStart", "firebaseUserEngagement", "formSubmission", "click", "linkClick", "jsError", "historyChange", "timer", "ampClick", "ampTimer", "ampScroll", "ampVisibility", "youTubeVideo", "scrollDepth", "elementVisibility" ] }, "interval": { "$ref": "Parameter", "description": "Time between triggering recurring Timer Events (in milliseconds). Only valid for Timer triggers." }, "visibilitySelector": { "description": "A visibility trigger CSS selector (i.e. \"#id\"). Only valid for AMP Visibility trigger.", "$ref": "Parameter" } }, "description": "Represents a Google Tag Manager Trigger", "id": "Trigger", "type": "object" }, "CreateContainerVersionRequestVersionOptions": { "properties": { "notes": { "description": "The notes of the container version to be created.", "type": "string" }, "name": { "description": "The name of the container version to be created.", "type": "string" } }, "description": "Options for new container versions.", "type": "object", "id": "CreateContainerVersionRequestVersionOptions" }, "RevertZoneResponse": { "type": "object", "properties": { "zone": { "$ref": "Zone", "description": "Zone as it appears in the latest container version since the last workspace synchronization operation. If no zone is present, that means the zone was deleted in the latest container version." } }, "id": "RevertZoneResponse", "description": "The result of reverting a zone in a workspace." }, "GtagConfig": { "type": "object", "properties": { "accountId": { "type": "string", "description": "Google tag account ID." }, "fingerprint": { "type": "string", "description": "The fingerprint of the Google tag config as computed at storage time. This value is recomputed whenever the config is modified." }, "gtagConfigId": { "description": "The ID uniquely identifies the Google tag config.", "type": "string" }, "parameter": { "type": "array", "description": "The Google tag config's parameters.", "items": { "$ref": "Parameter" } }, "containerId": { "description": "Google tag container ID.", "type": "string" }, "workspaceId": { "description": "Google tag workspace ID. Only used by GTM containers. Set to 0 otherwise.", "type": "string" }, "tagManagerUrl": { "type": "string", "description": "Auto generated link to the tag manager UI" }, "type": { "description": "Google tag config type.", "type": "string" }, "path": { "description": "Google tag config's API relative path.", "type": "string" } }, "description": "Represents a Google tag configuration.", "id": "GtagConfig" }, "SyncStatus": { "properties": { "mergeConflict": { "type": "boolean", "description": "Synchornization operation detected a merge conflict." }, "syncError": { "type": "boolean", "description": "An error occurred during the synchronization operation." } }, "description": "The status of a workspace after synchronization.", "id": "SyncStatus", "type": "object" }, "ListZonesResponse": { "id": "ListZonesResponse", "type": "object", "properties": { "zone": { "items": { "$ref": "Zone" }, "type": "array", "description": "All GTM Zones of a GTM Container." }, "nextPageToken": { "type": "string", "description": "Continuation token for fetching the next page of results." } } }, "ListContainerVersionsResponse": { "properties": { "containerVersionHeader": { "items": { "$ref": "ContainerVersionHeader" }, "type": "array", "description": "All container version headers of a GTM Container." }, "nextPageToken": { "type": "string", "description": "Continuation token for fetching the next page of results." } }, "type": "object", "description": "List container versions response.", "id": "ListContainerVersionsResponse" }, "ListContainersResponse": { "id": "ListContainersResponse", "description": "List Containers Response.", "properties": { "nextPageToken": { "description": "Continuation token for fetching the next page of results.", "type": "string" }, "container": { "items": { "$ref": "Container" }, "type": "array", "description": "All Containers of a GTM Account." } }, "type": "object" }, "Environment": { "id": "Environment", "properties": { "enableDebug": { "type": "boolean", "description": "Whether or not to enable debug by default for the environment." }, "url": { "description": "Default preview page url for the environment.", "type": "string" }, "authorizationTimestamp": { "format": "google-datetime", "description": "The last update time-stamp for the authorization code.", "type": "string" }, "environmentId": { "type": "string", "description": "GTM Environment ID uniquely identifies the GTM Environment." }, "type": { "enumDescriptions": [ "Points to a user defined environment.", "Points to the current live container version.", "Points to the latest container version.", "Automatically managed environment that points to a workspace preview or version created by a workspace." ], "type": "string", "enum": [ "user", "live", "latest", "workspace" ], "description": "The type of this environment." }, "path": { "description": "GTM Environment's API relative path.", "type": "string" }, "tagManagerUrl": { "description": "Auto generated link to the tag manager UI", "type": "string" }, "name": { "description": "The environment display name. Can be set or changed only on USER type environments.", "type": "string" }, "workspaceId": { "type": "string", "description": "Represents a link to a quick preview of a workspace." }, "containerVersionId": { "description": "Represents a link to a container version.", "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" }, "description": { "type": "string", "description": "The environment description. Can be set or changed only on USER type environments." }, "accountId": { "description": "GTM Account ID.", "type": "string" }, "authorizationCode": { "description": "The environment authorization code.", "type": "string" }, "containerId": { "description": "GTM Container ID.", "type": "string" } }, "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.", "type": "object" }, "SyncWorkspaceResponse": { "id": "SyncWorkspaceResponse", "description": "A response after synchronizing the workspace to the latest container version.", "properties": { "syncStatus": { "$ref": "SyncStatus", "description": "Indicates whether synchronization caused a merge conflict or sync error." }, "mergeConflict": { "items": { "$ref": "MergeConflict" }, "type": "array", "description": "The merge conflict after sync. If this field is not empty, the sync is still treated as successful. But a version cannot be created until all conflicts are resolved." } }, "type": "object" }, "ContainerVersionHeader": { "type": "object", "description": "Represents a Google Tag Manager Container Version Header.", "properties": { "accountId": { "description": "GTM Account ID.", "type": "string" }, "numTriggers": { "type": "string", "description": "Number of triggers in the container version." }, "name": { "type": "string", "description": "Container version display name." }, "path": { "description": "GTM Container Version's API relative path.", "type": "string" }, "numCustomTemplates": { "description": "Number of custom templates in the container version.", "type": "string" }, "numTags": { "description": "Number of tags in the container version.", "type": "string" }, "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." }, "numZones": { "type": "string", "description": "Number of zones in the container version." }, "containerId": { "type": "string", "description": "GTM Container ID." }, "numTransformations": { "description": "Number of transformations in the container version.", "type": "string" }, "numGtagConfigs": { "type": "string", "description": "Number of Google tag configs in the container version." }, "numVariables": { "type": "string", "description": "Number of variables in the container version." }, "numClients": { "description": "Number of clients in the container version.", "type": "string" } }, "id": "ContainerVersionHeader" }, "CreateBuiltInVariableResponse": { "id": "CreateBuiltInVariableResponse", "properties": { "builtInVariable": { "items": { "$ref": "BuiltInVariable" }, "description": "List of created built-in variables.", "type": "array" } }, "type": "object" }, "Folder": { "id": "Folder", "type": "object", "properties": { "containerId": { "type": "string", "description": "GTM Container ID." }, "workspaceId": { "type": "string", "description": "GTM Workspace ID." }, "folderId": { "type": "string", "description": "The Folder ID uniquely identifies the GTM Folder." }, "accountId": { "type": "string", "description": "GTM Account ID." }, "path": { "type": "string", "description": "GTM Folder's API relative path." }, "notes": { "description": "User notes on how to apply this folder in the container.", "type": "string" }, "name": { "description": "Folder display name.", "type": "string" }, "tagManagerUrl": { "description": "Auto generated link to the tag manager UI", "type": "string" }, "fingerprint": { "description": "The fingerprint of the GTM Folder as computed at storage time. This value is recomputed whenever the folder is modified.", "type": "string" } }, "description": "Represents a Google Tag Manager Folder." }, "AccountAccess": { "id": "AccountAccess", "properties": { "permission": { "description": "Whether the user has no access, user access, or admin access to an account.", "type": "string", "enum": [ "accountPermissionUnspecified", "noAccess", "user", "admin" ], "enumDescriptions": [ "", "", "", "" ] } }, "type": "object", "description": "Defines the Google Tag Manager Account access permissions." }, "AccountFeatures": { "type": "object", "id": "AccountFeatures", "properties": { "supportMultipleContainers": { "type": "boolean", "description": "Whether this Account supports multiple Containers." }, "supportUserPermissions": { "type": "boolean", "description": "Whether this Account supports user permissions managed by GTM." } } }, "RevertClientResponse": { "id": "RevertClientResponse", "type": "object", "description": "The result of reverting a client in a workspace.", "properties": { "client": { "description": "Client as it appears in the latest container version since the last workspace synchronization operation. If no client is present, that means the client was deleted in the latest container version.", "$ref": "Client" } } }, "ZoneChildContainer": { "id": "ZoneChildContainer", "properties": { "publicId": { "type": "string", "description": "The child container's public id." }, "nickname": { "type": "string", "description": "The zone's nickname for the child container." } }, "description": "Represents a child container of a Zone.", "type": "object" }, "TeardownTag": { "type": "object", "properties": { "tagName": { "description": "The name of the teardown tag.", "type": "string" }, "stopTeardownOnFailure": { "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": "boolean" } }, "id": "TeardownTag", "description": "Represents a tag that fires after another tag in order to tear down dependencies." }, "ListDestinationsResponse": { "properties": { "destination": { "description": "All Destinations linked to a GTM Container.", "items": { "$ref": "Destination" }, "type": "array" }, "nextPageToken": { "type": "string", "description": "Continuation token for fetching the next page of results." } }, "id": "ListDestinationsResponse", "type": "object" }, "ListEnabledBuiltInVariablesResponse": { "description": "A list of enabled built-in variables.", "properties": { "nextPageToken": { "type": "string", "description": "Continuation token for fetching the next page of results." }, "builtInVariable": { "items": { "$ref": "BuiltInVariable" }, "description": "All GTM BuiltInVariables of a GTM container.", "type": "array" } }, "id": "ListEnabledBuiltInVariablesResponse", "type": "object" }, "Transformation": { "id": "Transformation", "type": "object", "description": "Represents a Google Tag Manager Transformation.", "properties": { "fingerprint": { "description": "The fingerprint of the GTM Transformation as computed at storage time. This value is recomputed whenever the transformation is modified.", "type": "string" }, "accountId": { "description": "GTM Account ID.", "type": "string" }, "notes": { "type": "string", "description": "User notes on how to apply this transformation in the container." }, "path": { "type": "string", "description": "GTM transformation's API relative path." }, "type": { "description": "Transformation type.", "type": "string" }, "parentFolderId": { "type": "string", "description": "Parent folder id." }, "containerId": { "description": "GTM Container ID.", "type": "string" }, "workspaceId": { "description": "GTM Workspace ID.", "type": "string" }, "name": { "description": "Transformation display name.", "type": "string" }, "parameter": { "description": "The transformation's parameters.", "type": "array", "items": { "$ref": "Parameter" } }, "tagManagerUrl": { "description": "Auto generated link to the tag manager UI", "type": "string" }, "transformationId": { "type": "string", "description": "The Transformation ID uniquely identifies the GTM transformation." } } }, "ListClientsResponse": { "properties": { "nextPageToken": { "type": "string", "description": "Continuation token for fetching the next page of results." }, "client": { "type": "array", "items": { "$ref": "Client" }, "description": "All GTM Clients of a GTM Container." } }, "type": "object", "id": "ListClientsResponse" }, "GalleryReference": { "type": "object", "properties": { "owner": { "description": "The name of the owner for the community gallery template.", "type": "string" }, "signature": { "type": "string", "description": "The signature of the community gallery template as computed at import time. This value is recomputed whenever the template is updated from the gallery." }, "host": { "type": "string", "description": "The name of the host for the community gallery template." }, "templateDeveloperId": { "type": "string", "description": "The developer id of the community gallery template. This value is set whenever the template is created from the gallery." }, "isModified": { "type": "boolean", "description": "If a user has manually edited the community gallery template." }, "version": { "description": "The version of the community gallery template.", "type": "string" }, "galleryTemplateId": { "type": "string", "description": "ID for the gallery template that is generated once during first sync and travels with the template redirects." }, "repository": { "description": "The name of the repository for the community gallery template.", "type": "string" } }, "id": "GalleryReference", "description": "Represents the link between a custom template and an entry on the Community Template Gallery site." }, "ListAccountsResponse": { "id": "ListAccountsResponse", "properties": { "nextPageToken": { "type": "string", "description": "Continuation token for fetching the next page of results." }, "account": { "type": "array", "items": { "$ref": "Account" }, "description": "List of GTM Accounts that a user has access to." } }, "description": "List Accounts Response.", "type": "object" }, "ProposedChange": { "id": "ProposedChange", "properties": { "changes": { "items": { "$ref": "Entity" }, "type": "array", "description": "The list of workspace changes to be applied." } }, "type": "object" }, "ListTransformationsResponse": { "type": "object", "properties": { "transformation": { "type": "array", "description": "All GTM Transformations of a GTM Container.", "items": { "$ref": "Transformation" } }, "nextPageToken": { "type": "string", "description": "Continuation token for fetching the next page of results." } }, "id": "ListTransformationsResponse" }, "CustomTemplate": { "description": "Represents a Google Tag Manager Custom Template's contents.", "type": "object", "properties": { "templateData": { "type": "string", "description": "The custom template in text format." }, "containerId": { "description": "GTM Container ID.", "type": "string" }, "workspaceId": { "type": "string", "description": "GTM Workspace ID." }, "name": { "type": "string", "description": "Custom Template display name." }, "tagManagerUrl": { "type": "string", "description": "Auto generated link to the tag manager UI" }, "fingerprint": { "description": "The fingerprint of the GTM Custom Template as computed at storage time. This value is recomputed whenever the template is modified.", "type": "string" }, "accountId": { "type": "string", "description": "GTM Account ID." }, "templateId": { "type": "string", "description": "The Custom Template ID uniquely identifies the GTM custom template." }, "path": { "description": "GTM Custom Template's API relative path.", "type": "string" }, "galleryReference": { "description": "A reference to the Community Template Gallery entry.", "$ref": "GalleryReference" } }, "id": "CustomTemplate" }, "ListEnvironmentsResponse": { "id": "ListEnvironmentsResponse", "type": "object", "properties": { "nextPageToken": { "description": "Continuation token for fetching the next page of results.", "type": "string" }, "environment": { "description": "All Environments of a GTM Container.", "items": { "$ref": "Environment" }, "type": "array" } }, "description": "List Environments Response." }, "ListWorkspacesResponse": { "description": "A list of workspaces in a container.", "properties": { "nextPageToken": { "description": "Continuation token for fetching the next page of results.", "type": "string" }, "workspace": { "description": "All Workspaces of a GTM Container.", "items": { "$ref": "Workspace" }, "type": "array" } }, "type": "object", "id": "ListWorkspacesResponse" }, "FolderEntities": { "description": "Represents a Google Tag Manager Folder's contents.", "properties": { "nextPageToken": { "type": "string", "description": "Continuation token for fetching the next page of results." }, "trigger": { "type": "array", "items": { "$ref": "Trigger" }, "description": "The list of triggers inside the folder." }, "tag": { "description": "The list of tags inside the folder.", "type": "array", "items": { "$ref": "Tag" } }, "variable": { "type": "array", "description": "The list of variables inside the folder.", "items": { "$ref": "Variable" } } }, "type": "object", "id": "FolderEntities" }, "UserPermission": { "description": "Represents a user's permissions to an account and its container.", "type": "object", "id": "UserPermission", "properties": { "accountId": { "type": "string", "description": "The Account ID uniquely identifies the GTM Account." }, "emailAddress": { "description": "User's email address.", "type": "string" }, "accountAccess": { "description": "GTM Account access permissions.", "$ref": "AccountAccess" }, "containerAccess": { "items": { "$ref": "ContainerAccess" }, "type": "array", "description": "GTM Container access permissions." }, "path": { "type": "string", "description": "GTM UserPermission's API relative path." } } }, "ListGtagConfigResponse": { "type": "object", "properties": { "gtagConfig": { "description": "All Google tag configs in a Container.", "type": "array", "items": { "$ref": "GtagConfig" } }, "nextPageToken": { "description": "Continuation token for fetching the next page of results.", "type": "string" } }, "id": "ListGtagConfigResponse" }, "RevertVariableResponse": { "type": "object", "properties": { "variable": { "description": "Variable as it appears in the latest container version since the last workspace synchronization operation. If no variable is present, that means the variable was deleted in the latest container version.", "$ref": "Variable" } }, "id": "RevertVariableResponse", "description": "The result of reverting a variable in a workspace." }, "ListVariablesResponse": { "description": "List Variables Response.", "id": "ListVariablesResponse", "properties": { "nextPageToken": { "type": "string", "description": "Continuation token for fetching the next page of results." }, "variable": { "type": "array", "description": "All GTM Variables of a GTM Container.", "items": { "$ref": "Variable" } } }, "type": "object" }, "SetupTag": { "properties": { "tagName": { "description": "The name of the setup tag.", "type": "string" }, "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" } }, "id": "SetupTag", "description": "Represents a reference to atag that fires before another tag in order to set up dependencies.", "type": "object" }, "GetWorkspaceStatusResponse": { "type": "object", "properties": { "mergeConflict": { "items": { "$ref": "MergeConflict" }, "description": "The merge conflict after sync.", "type": "array" }, "workspaceChange": { "type": "array", "description": "Entities that have been changed in the workspace.", "items": { "$ref": "Entity" } } }, "description": "The changes that have occurred in the workspace since the base container version.", "id": "GetWorkspaceStatusResponse" }, "Client": { "id": "Client", "type": "object", "properties": { "name": { "description": "Client display name.", "type": "string" }, "workspaceId": { "description": "GTM Workspace ID.", "type": "string" }, "path": { "type": "string", "description": "GTM client's API relative path." }, "parameter": { "items": { "$ref": "Parameter" }, "description": "The client's parameters.", "type": "array" }, "type": { "type": "string", "description": "Client type." }, "accountId": { "description": "GTM Account ID.", "type": "string" }, "priority": { "format": "int32", "type": "integer", "description": "Priority determines relative firing order." }, "fingerprint": { "description": "The fingerprint of the GTM Client as computed at storage time. This value is recomputed whenever the client is modified.", "type": "string" }, "containerId": { "type": "string", "description": "GTM Container ID." }, "tagManagerUrl": { "description": "Auto generated link to the tag manager UI", "type": "string" }, "clientId": { "description": "The Client ID uniquely identifies the GTM client.", "type": "string" }, "notes": { "type": "string", "description": "User notes on how to apply this tag in the container." }, "parentFolderId": { "description": "Parent folder id.", "type": "string" } } }, "RevertTagResponse": { "type": "object", "properties": { "tag": { "description": "Tag as it appears in the latest container version since the last workspace synchronization operation. If no tag is present, that means the tag was deleted in the latest container version.", "$ref": "Tag" } }, "description": "The result of reverting a tag in a workspace.", "id": "RevertTagResponse" }, "Destination": { "description": "Represents a Google Tag Destination.", "id": "Destination", "properties": { "destinationLinkId": { "description": "The Destination link ID uniquely identifies the Destination.", "type": "string" }, "tagManagerUrl": { "description": "Auto generated link to the tag manager UI.", "type": "string" }, "name": { "description": "Destination display name.", "type": "string" }, "fingerprint": { "description": "The fingerprint of the Google Tag Destination as computed at storage time. This value is recomputed whenever the destination is modified.", "type": "string" }, "accountId": { "description": "GTM Account ID.", "type": "string" }, "containerId": { "description": "GTM Container ID.", "type": "string" }, "destinationId": { "description": "Destination ID.", "type": "string" }, "path": { "description": "Destination's API relative path.", "type": "string" } }, "type": "object" }, "CreateContainerVersionResponse": { "id": "CreateContainerVersionResponse", "description": "Create container versions response.", "properties": { "newWorkspacePath": { "description": "Auto generated workspace path created as a result of version creation. This field should only be populated if the created version was not a quick preview.", "type": "string" }, "syncStatus": { "$ref": "SyncStatus", "description": "Whether version creation failed when syncing the workspace to the latest container version." }, "compilerError": { "description": "Compiler errors or not.", "type": "boolean" }, "containerVersion": { "description": "The container version created.", "$ref": "ContainerVersion" } }, "type": "object" }, "Variable": { "properties": { "parentFolderId": { "type": "string", "description": "Parent folder id." }, "tagManagerUrl": { "description": "Auto generated link to the tag manager UI", "type": "string" }, "containerId": { "type": "string", "description": "GTM Container ID." }, "parameter": { "description": "The variable's parameters.", "type": "array", "items": { "$ref": "Parameter" } }, "formatValue": { "$ref": "VariableFormatValue", "description": "Option to convert a variable value to other value." }, "fingerprint": { "description": "The fingerprint of the GTM Variable as computed at storage time. This value is recomputed whenever the variable is modified.", "type": "string" }, "notes": { "type": "string", "description": "User notes on how to apply this variable in the container." }, "scheduleEndMs": { "description": "The end timestamp in milliseconds to schedule a variable.", "type": "string", "format": "int64" }, "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.", "type": "array", "items": { "type": "string" } }, "path": { "description": "GTM Variable's API relative path.", "type": "string" }, "variableId": { "description": "The Variable ID uniquely identifies the GTM Variable.", "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." }, "type": { "type": "string", "description": "GTM Variable Type." }, "workspaceId": { "type": "string", "description": "GTM Workspace ID." }, "name": { "description": "Variable display name.", "type": "string" }, "scheduleStartMs": { "format": "int64", "description": "The start timestamp in milliseconds to schedule a variable.", "type": "string" }, "accountId": { "type": "string", "description": "GTM Account ID." } }, "type": "object", "id": "Variable", "description": "Represents a Google Tag Manager Variable." }, "TagConsentSetting": { "id": "TagConsentSetting", "type": "object", "properties": { "consentStatus": { "enumDescriptions": [ "Default value where user has not specified any setting on it.", "Tag doesn't require any additional consent settings.", "Tag requires additional consent settings." ], "type": "string", "enum": [ "notSet", "notNeeded", "needed" ], "description": "The tag's consent status. If set to NEEDED, the runtime will check that the consent types specified by the consent_type field have been granted." }, "consentType": { "$ref": "Parameter", "description": "The type of consents to check for during tag firing if in the consent NEEDED state. This parameter must be of type LIST where each list item is of type STRING." } } }, "MergeConflict": { "description": "Represents a merge conflict.", "properties": { "entityInWorkspace": { "description": "The workspace entity that has conflicting changes compared to the base version. If an entity is deleted in a workspace, it will still appear with a deleted change status.", "$ref": "Entity" }, "entityInBaseVersion": { "description": "The base version entity (since the latest sync operation) that has conflicting changes compared to the workspace. If this field is missing, it means the workspace entity is deleted from the base version.", "$ref": "Entity" } }, "id": "MergeConflict", "type": "object" }, "Zone": { "description": "Represents a Google Tag Manager Zone's contents.", "properties": { "childContainer": { "items": { "$ref": "ZoneChildContainer" }, "description": "Containers that are children of this Zone.", "type": "array" }, "path": { "type": "string", "description": "GTM Zone's API relative path." }, "zoneId": { "description": "The Zone ID uniquely identifies the GTM Zone.", "type": "string" }, "name": { "description": "Zone display name.", "type": "string" }, "fingerprint": { "description": "The fingerprint of the GTM Zone as computed at storage time. This value is recomputed whenever the zone is modified.", "type": "string" }, "tagManagerUrl": { "description": "Auto generated link to the tag manager UI", "type": "string" }, "notes": { "description": "User notes on how to apply this zone in the container.", "type": "string" }, "typeRestriction": { "$ref": "ZoneTypeRestriction", "description": "This Zone's type restrictions." }, "containerId": { "description": "GTM Container ID.", "type": "string" }, "workspaceId": { "description": "GTM Workspace ID.", "type": "string" }, "boundary": { "description": "This Zone's boundary.", "$ref": "ZoneBoundary" }, "accountId": { "type": "string", "description": "GTM Account ID." } }, "id": "Zone", "type": "object" }, "RevertTemplateResponse": { "id": "RevertTemplateResponse", "description": "The result of reverting a template in a workspace.", "properties": { "template": { "$ref": "CustomTemplate", "description": "Template as it appears in the latest container version since the last workspace synchronization operation. If no template is present, that means the template was deleted in the latest container version." } }, "type": "object" }, "ContainerAccess": { "description": "Defines the Google Tag Manager Container access permissions.", "type": "object", "properties": { "containerId": { "description": "GTM Container ID.", "type": "string" }, "permission": { "type": "string", "enum": [ "containerPermissionUnspecified", "noAccess", "read", "edit", "approve", "publish" ], "description": "List of Container permissions.", "enumDescriptions": [ "", "", "", "", "", "" ] } }, "id": "ContainerAccess" }, "Entity": { "id": "Entity", "type": "object", "properties": { "customTemplate": { "$ref": "CustomTemplate", "description": "The custom template being represented by the entity." }, "gtagConfig": { "$ref": "GtagConfig", "description": "The gtag config being represented by the entity." }, "folder": { "description": "The folder being represented by the entity.", "$ref": "Folder" }, "client": { "description": "The client being represented by the entity.", "$ref": "Client" }, "tag": { "$ref": "Tag", "description": "The tag being represented by the entity." }, "builtInVariable": { "description": "The built in variable being represented by the entity.", "$ref": "BuiltInVariable" }, "zone": { "description": "The zone being represented by the entity.", "$ref": "Zone" }, "changeStatus": { "enumDescriptions": [ "", "The entity has never been changed.", "The entity is added to the workspace.", "The entity is deleted from the workspace.", "The entity has been updated in the workspace." ], "type": "string", "enum": [ "changeStatusUnspecified", "none", "added", "deleted", "updated" ], "description": "Represents how the entity has been changed in the workspace." }, "trigger": { "$ref": "Trigger", "description": "The trigger being represented by the entity." }, "transformation": { "$ref": "Transformation", "description": "The transformation being represented by the entity." }, "variable": { "$ref": "Variable", "description": "The variable being represented by the entity." } }, "description": "A workspace entity that may represent a tag, trigger, variable, or folder in addition to its status in the workspace." }, "ListUserPermissionsResponse": { "properties": { "userPermission": { "items": { "$ref": "UserPermission" }, "description": "All GTM UserPermissions of a GTM Account.", "type": "array" }, "nextPageToken": { "type": "string", "description": "Continuation token for fetching the next page of results." } }, "type": "object", "description": "List user permissions response.", "id": "ListUserPermissionsResponse" }, "ListTriggersResponse": { "description": "List triggers response.", "id": "ListTriggersResponse", "properties": { "nextPageToken": { "type": "string", "description": "Continuation token for fetching the next page of results." }, "trigger": { "description": "All GTM Triggers of a GTM Container.", "type": "array", "items": { "$ref": "Trigger" } } }, "type": "object" }, "ZoneBoundary": { "id": "ZoneBoundary", "type": "object", "description": "Represents a Zone's boundaries.", "properties": { "customEvaluationTriggerId": { "description": "Custom evaluation trigger IDs. A zone will evaluate its boundary conditions when any of the listed triggers are true.", "items": { "type": "string" }, "type": "array" }, "condition": { "type": "array", "description": "The conditions that, when conjoined, make up the boundary.", "items": { "$ref": "Condition" } } } }, "RevertFolderResponse": { "id": "RevertFolderResponse", "description": "The result of reverting folder changes in a workspace.", "type": "object", "properties": { "folder": { "$ref": "Folder", "description": "Folder as it appears in the latest container version since the last workspace synchronization operation. If no folder is present, that means the folder was deleted in the latest container version." } } }, "Tag": { "properties": { "parameter": { "description": "The tag's parameters.", "type": "array", "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" }, "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" }, "path": { "type": "string", "description": "GTM Tag's API relative path." }, "firingTriggerId": { "items": { "type": "string" }, "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." }, "containerId": { "type": "string", "description": "GTM Container ID." }, "tagFiringOption": { "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)." ], "type": "string", "enum": [ "tagFiringOptionUnspecified", "unlimited", "oncePerEvent", "oncePerLoad" ] }, "name": { "type": "string", "description": "Tag display name." }, "setupTag": { "type": "array", "items": { "$ref": "SetupTag" }, "description": "The list of setup tags. Currently we only allow one." }, "teardownTag": { "description": "The list of teardown tags. Currently we only allow one.", "items": { "$ref": "TeardownTag" }, "type": "array" }, "workspaceId": { "description": "GTM Workspace ID.", "type": "string" }, "scheduleEndMs": { "format": "int64", "description": "The end timestamp in milliseconds to schedule a tag.", "type": "string" }, "monitoringMetadata": { "description": "A map of key-value pairs of tag metadata to be included in the event data for tag monitoring. Notes: - This parameter must be type MAP. - Each parameter in the map are type TEMPLATE, however cannot contain variable references. ", "$ref": "Parameter" }, "consentSettings": { "description": "Consent settings of a tag.", "$ref": "TagConsentSetting" }, "parentFolderId": { "description": "Parent folder id.", "type": "string" }, "type": { "type": "string", "description": "GTM Tag Type." }, "notes": { "type": "string", "description": "User notes on how to apply this tag in the container." }, "tagManagerUrl": { "description": "Auto generated link to the tag manager UI", "type": "string" }, "paused": { "type": "boolean", "description": "Indicates whether the tag is paused, which prevents the tag from firing." }, "tagId": { "description": "The Tag ID uniquely identifies the GTM Tag.", "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" } }, "scheduleStartMs": { "description": "The start timestamp in milliseconds to schedule a tag.", "format": "int64", "type": "string" }, "monitoringMetadataTagNameKey": { "type": "string", "description": "If non-empty, then the tag display name will be included in the monitoring metadata map using the key specified." }, "accountId": { "type": "string", "description": "GTM Account 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" } }, "id": "Tag", "description": "Represents a Google Tag Manager Tag.", "type": "object" }, "RevertTransformationResponse": { "type": "object", "id": "RevertTransformationResponse", "properties": { "transformation": { "$ref": "Transformation", "description": "Transformation as it appears in the latest container version since the last workspace synchronization operation. If no transformation is present, that means the transformation was deleted in the latest container version." } }, "description": "The result of reverting a transformation in a workspace." }, "Workspace": { "id": "Workspace", "description": "Represents a Google Tag Manager Container Workspace.", "type": "object", "properties": { "tagManagerUrl": { "description": "Auto generated link to the tag manager UI", "type": "string" }, "containerId": { "description": "GTM Container ID.", "type": "string" }, "workspaceId": { "type": "string", "description": "The Workspace ID uniquely identifies the GTM Workspace." }, "accountId": { "type": "string", "description": "GTM Account ID." }, "name": { "description": "Workspace display name.", "type": "string" }, "fingerprint": { "type": "string", "description": "The fingerprint of the GTM Workspace as computed at storage time. This value is recomputed whenever the workspace is modified." }, "description": { "type": "string", "description": "Workspace description." }, "path": { "description": "GTM Workspace's API relative path.", "type": "string" } } }, "BuiltInVariable": { "description": "Built-in variables are a special category of variables that are pre-created and non-customizable. They provide common functionality like accessing properties of the gtm data layer, monitoring clicks, or accessing elements of a page URL.", "properties": { "name": { "description": "Name of the built-in variable to be used to refer to the built-in variable.", "type": "string" }, "path": { "type": "string", "description": "GTM BuiltInVariable's API relative path." }, "containerId": { "description": "GTM Container ID.", "type": "string" }, "workspaceId": { "type": "string", "description": "GTM Workspace ID." }, "type": { "type": "string", "enum": [ "builtInVariableTypeUnspecified", "pageUrl", "pageHostname", "pagePath", "referrer", "event", "clickElement", "clickClasses", "clickId", "clickTarget", "clickUrl", "clickText", "firstPartyServingUrl", "formElement", "formClasses", "formId", "formTarget", "formUrl", "formText", "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", "environmentName", "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", "requestPath", "requestMethod", "clientName", "queryString", "serverPageLocationUrl", "serverPageLocationPath", "serverPageLocationHostname", "visitorRegion", "analyticsClientId", "analyticsSessionId", "analyticsSessionNumber" ], "enumDescriptions": [ "", "", "", "", "", "For web or mobile.", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "For web or mobile.", "", "For web or mobile.", "For web or mobile.", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ], "description": "Type of built-in variable." }, "accountId": { "description": "GTM Account ID.", "type": "string" } }, "id": "BuiltInVariable", "type": "object" }, "QuickPreviewResponse": { "properties": { "containerVersion": { "$ref": "ContainerVersion", "description": "The quick previewed container version." }, "compilerError": { "description": "Were there compiler errors or not.", "type": "boolean" }, "syncStatus": { "$ref": "SyncStatus", "description": "Whether quick previewing failed when syncing the workspace to the latest container version." } }, "type": "object", "description": "Response to quick previewing a workspace.", "id": "QuickPreviewResponse" }, "ListTagsResponse": { "id": "ListTagsResponse", "properties": { "nextPageToken": { "type": "string", "description": "Continuation token for fetching the next page of results." }, "tag": { "type": "array", "items": { "$ref": "Tag" }, "description": "All GTM Tags of a GTM Container." } }, "description": "List Tags Response.", "type": "object" }, "Condition": { "properties": { "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": "array", "items": { "$ref": "Parameter" } }, "type": { "description": "The type of operator for this condition.", "type": "string", "enum": [ "conditionTypeUnspecified", "equals", "contains", "startsWith", "endsWith", "matchRegex", "greater", "greaterOrEquals", "less", "lessOrEquals", "cssSelector", "urlMatches" ], "enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "" ] } }, "id": "Condition", "description": "Represents a predicate.", "type": "object" }, "ListTemplatesResponse": { "properties": { "nextPageToken": { "type": "string", "description": "Continuation token for fetching the next page of results." }, "template": { "items": { "$ref": "CustomTemplate" }, "description": "All GTM Custom Templates of a GTM Container.", "type": "array" } }, "type": "object", "id": "ListTemplatesResponse" }, "ContainerFeatures": { "properties": { "supportTags": { "description": "Whether this Container supports tags.", "type": "boolean" }, "supportTransformations": { "type": "boolean", "description": "Whether this Container supports transformations." }, "supportVersions": { "type": "boolean", "description": "Whether this Container supports Container versions." }, "supportBuiltInVariables": { "type": "boolean", "description": "Whether this Container supports built-in variables" }, "supportEnvironments": { "description": "Whether this Container supports environments.", "type": "boolean" }, "supportZones": { "type": "boolean", "description": "Whether this Container supports zones." }, "supportClients": { "description": "Whether this Container supports clients.", "type": "boolean" }, "supportWorkspaces": { "description": "Whether this Container supports workspaces.", "type": "boolean" }, "supportGtagConfigs": { "description": "Whether this Container supports Google tag config.", "type": "boolean" }, "supportUserPermissions": { "description": "Whether this Container supports user permissions managed by GTM.", "type": "boolean" }, "supportVariables": { "type": "boolean", "description": "Whether this Container supports variables." }, "supportTemplates": { "type": "boolean", "description": "Whether this Container supports templates." }, "supportTriggers": { "type": "boolean", "description": "Whether this Container supports triggers." }, "supportFolders": { "description": "Whether this Container supports folders.", "type": "boolean" } }, "type": "object", "id": "ContainerFeatures" }, "ZoneTypeRestriction": { "id": "ZoneTypeRestriction", "type": "object", "properties": { "whitelistedTypeId": { "type": "array", "items": { "type": "string" }, "description": "List of type public ids that have been whitelisted for use in this Zone." }, "enable": { "type": "boolean", "description": "True if type restrictions have been enabled for this Zone." } }, "description": "Represents a Zone's type restrictions." }, "Account": { "properties": { "path": { "description": "GTM Account's API relative path.", "type": "string" }, "features": { "description": "Read-only Account feature set", "$ref": "AccountFeatures" }, "name": { "description": "Account display name.", "type": "string" }, "fingerprint": { "description": "The fingerprint of the GTM Account as computed at storage time. This value is recomputed whenever the account is modified.", "type": "string" }, "accountId": { "description": "The Account ID uniquely identifies the GTM Account.", "type": "string" }, "tagManagerUrl": { "description": "Auto generated link to the tag manager UI", "type": "string" }, "shareData": { "type": "boolean", "description": "Whether the account shares data anonymously with Google and others. This flag enables benchmarking by sharing your data in an anonymous form. Google will remove all identifiable information about your website, combine the data with hundreds of other anonymous sites and report aggregate trends in the benchmarking service." } }, "description": "Represents a Google Tag Manager Account.", "id": "Account", "type": "object" }, "ListFoldersResponse": { "id": "ListFoldersResponse", "description": "List Folders Response.", "type": "object", "properties": { "nextPageToken": { "description": "Continuation token for fetching the next page of results.", "type": "string" }, "folder": { "description": "All GTM Folders of a GTM Container.", "items": { "$ref": "Folder" }, "type": "array" } } }, "PublishContainerVersionResponse": { "id": "PublishContainerVersionResponse", "properties": { "compilerError": { "type": "boolean", "description": "Compiler errors or not." }, "containerVersion": { "description": "The container version created.", "$ref": "ContainerVersion" } }, "description": "Publish container version response.", "type": "object" }, "VariableFormatValue": { "type": "object", "id": "VariableFormatValue", "properties": { "convertToNumber": { "description": "The option to convert a variable value to a number.", "type": "string", "enum": [ "decimalSeparatorTypeUnspecified", "period", "comma", "automatic" ], "enumDescriptions": [ "", "The option to convert a variable value to a number with a period as the decimal separator.", "The option to convert a variable value to a number with a comma as the decimal separator.", "The option to convert a variable value to a number with automatic decimal separator detection." ] }, "caseConversionType": { "enumDescriptions": [ "", "The option to convert a variable value to lowercase.", "The option to convert a variable value to uppercase." ], "type": "string", "enum": [ "none", "lowercase", "uppercase" ], "description": "The option to convert a string-type variable value to either lowercase or uppercase." }, "convertUndefinedToValue": { "$ref": "Parameter", "description": "The value to convert if a variable value is undefined." }, "convertNullToValue": { "description": "The value to convert if a variable value is null.", "$ref": "Parameter" }, "convertToBoolean": { "type": "boolean", "description": "The option to convert a variable value to a boolean." }, "convertFalseToValue": { "description": "The value to convert if a variable value is false.", "$ref": "Parameter" }, "convertTrueToValue": { "description": "The value to convert if a variable value is true.", "$ref": "Parameter" } } } }, "basePath": "", "ownerName": "Google", "auth": { "oauth2": { "scopes": { "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" }, "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.containerversions": { "description": "Manage 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" } } } }, "kind": "discovery#restDescription", "resources": { "accounts": { "resources": { "user_permissions": { "methods": { "get": { "id": "tagmanager.accounts.user_permissions.get", "parameterOrder": [ "path" ], "scopes": [ "https://www.googleapis.com/auth/tagmanager.manage.users" ], "path": "tagmanager/v2/{+path}", "flatPath": "tagmanager/v2/accounts/{accountsId}/user_permissions/{user_permissionsId}", "response": { "$ref": "UserPermission" }, "parameters": { "path": { "pattern": "^accounts/[^/]+/user_permissions/[^/]+$", "location": "path", "description": "GTM UserPermission's API relative path.", "type": "string", "required": true } }, "description": "Gets a user's Account & Container access.", "httpMethod": "GET" }, "delete": { "httpMethod": "DELETE", "parameterOrder": [ "path" ], "description": "Removes a user from the account, revoking access to it and all of its containers.", "id": "tagmanager.accounts.user_permissions.delete", "path": "tagmanager/v2/{+path}", "parameters": { "path": { "location": "path", "pattern": "^accounts/[^/]+/user_permissions/[^/]+$", "required": true, "type": "string", "description": "GTM UserPermission's API relative path." } }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.manage.users" ], "flatPath": "tagmanager/v2/accounts/{accountsId}/user_permissions/{user_permissionsId}" }, "update": { "httpMethod": "PUT", "flatPath": "tagmanager/v2/accounts/{accountsId}/user_permissions/{user_permissionsId}", "response": { "$ref": "UserPermission" }, "parameters": { "path": { "description": "GTM UserPermission's API relative path.", "type": "string", "required": true, "pattern": "^accounts/[^/]+/user_permissions/[^/]+$", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.manage.users" ], "request": { "$ref": "UserPermission" }, "parameterOrder": [ "path" ], "path": "tagmanager/v2/{+path}", "id": "tagmanager.accounts.user_permissions.update", "description": "Updates a user's Account & Container access." }, "create": { "scopes": [ "https://www.googleapis.com/auth/tagmanager.manage.users" ], "parameterOrder": [ "parent" ], "path": "tagmanager/v2/{+parent}/user_permissions", "request": { "$ref": "UserPermission" }, "id": "tagmanager.accounts.user_permissions.create", "parameters": { "parent": { "pattern": "^accounts/[^/]+$", "type": "string", "description": "GTM Account's API relative path.", "location": "path", "required": true } }, "flatPath": "tagmanager/v2/accounts/{accountsId}/user_permissions", "response": { "$ref": "UserPermission" }, "httpMethod": "POST", "description": "Creates a user's Account & Container access." }, "list": { "parameters": { "parent": { "location": "path", "type": "string", "required": true, "pattern": "^accounts/[^/]+$", "description": "GTM Account's API relative path." }, "pageToken": { "type": "string", "description": "Continuation token for fetching the next page of results.", "location": "query" } }, "httpMethod": "GET", "description": "List all users that have access to the account along with Account and Container user access granted to each of them.", "path": "tagmanager/v2/{+parent}/user_permissions", "scopes": [ "https://www.googleapis.com/auth/tagmanager.manage.users" ], "parameterOrder": [ "parent" ], "id": "tagmanager.accounts.user_permissions.list", "flatPath": "tagmanager/v2/accounts/{accountsId}/user_permissions", "response": { "$ref": "ListUserPermissionsResponse" } } } }, "containers": { "methods": { "lookup": { "parameters": { "destinationId": { "type": "string", "location": "query", "description": "Destination ID linked to a GTM Container, e.g. AW-123456789. Only one of destination_id or tag_id should be set." }, "tagId": { "description": "Tag ID for a GTM Container, e.g. GTM-123456789. Only one of destination_id or tag_id should be set.", "type": "string", "location": "query" } }, "flatPath": "tagmanager/v2/accounts/containers:lookup", "response": { "$ref": "Container" }, "id": "tagmanager.accounts.containers.lookup", "parameterOrder": [], "httpMethod": "GET", "description": "Looks up a Container by destination ID or tag ID.", "path": "tagmanager/v2/accounts/containers:lookup", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ] }, "update": { "parameterOrder": [ "path" ], "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}", "response": { "$ref": "Container" }, "id": "tagmanager.accounts.containers.update", "parameters": { "path": { "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+$", "type": "string", "required": true, "description": "GTM Container's API relative path." }, "fingerprint": { "type": "string", "description": "When provided, this fingerprint must match the fingerprint of the container in storage.", "location": "query" } }, "request": { "$ref": "Container" }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "httpMethod": "PUT", "path": "tagmanager/v2/{+path}", "description": "Updates a Container." }, "get": { "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}", "response": { "$ref": "Container" }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "parameters": { "path": { "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+$", "required": true, "description": "GTM Container's API relative path.", "type": "string" } }, "id": "tagmanager.accounts.containers.get", "parameterOrder": [ "path" ], "httpMethod": "GET", "description": "Gets a Container.", "path": "tagmanager/v2/{+path}" }, "move_tag_id": { "id": "tagmanager.accounts.containers.move_tag_id", "deprecated": true, "description": "Move Tag ID out of a Container.", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}:move_tag_id", "response": { "$ref": "Container" }, "parameters": { "tagId": { "type": "string", "description": "Tag ID to be removed from the current Container.", "location": "query" }, "copyUsers": { "location": "query", "description": "Whether or not to copy users from this tag to the new tag.", "type": "boolean" }, "path": { "type": "string", "description": "GTM Container's API relative path.", "required": true, "pattern": "^accounts/[^/]+/containers/[^/]+$", "location": "path" }, "allowUserPermissionFeatureUpdate": { "location": "query", "description": "Must be set to true to allow features.user_permissions to change from false to true. If this operation causes an update but this bit is false, the operation will fail.", "type": "boolean" }, "copyTermsOfService": { "description": "Must be set to true to accept all terms of service agreements copied from the current tag to the newly created tag. If this bit is false, the operation will fail.", "type": "boolean", "location": "query" }, "copySettings": { "description": "Whether or not to copy tag settings from this tag to the new tag.", "type": "boolean", "location": "query" }, "tagName": { "description": "The name for the newly created tag.", "location": "query", "type": "string" } }, "path": "tagmanager/v2/{+path}:move_tag_id", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "httpMethod": "POST", "parameterOrder": [ "path" ] }, "create": { "id": "tagmanager.accounts.containers.create", "parameterOrder": [ "parent" ], "parameters": { "parent": { "description": "GTM Account's API relative path.", "pattern": "^accounts/[^/]+$", "location": "path", "type": "string", "required": true } }, "flatPath": "tagmanager/v2/accounts/{accountsId}/containers", "response": { "$ref": "Container" }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "httpMethod": "POST", "path": "tagmanager/v2/{+parent}/containers", "request": { "$ref": "Container" }, "description": "Creates a Container." }, "list": { "id": "tagmanager.accounts.containers.list", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers", "response": { "$ref": "ListContainersResponse" }, "parameterOrder": [ "parent" ], "description": "Lists all Containers that belongs to a GTM Account.", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "path": "tagmanager/v2/{+parent}/containers", "httpMethod": "GET", "parameters": { "pageToken": { "type": "string", "description": "Continuation token for fetching the next page of results.", "location": "query" }, "parent": { "required": true, "location": "path", "description": "GTM Account's API relative path.", "pattern": "^accounts/[^/]+$", "type": "string" } } }, "snippet": { "httpMethod": "GET", "parameterOrder": [ "path" ], "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}:snippet", "response": { "$ref": "GetContainerSnippetResponse" }, "path": "tagmanager/v2/{+path}:snippet", "parameters": { "path": { "location": "path", "type": "string", "required": true, "pattern": "^accounts/[^/]+/containers/[^/]+$", "description": "Container snippet's API relative path." } }, "description": "Gets the tagging snippet for a Container.", "id": "tagmanager.accounts.containers.snippet", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ] }, "delete": { "description": "Deletes a Container.", "id": "tagmanager.accounts.containers.delete", "httpMethod": "DELETE", "path": "tagmanager/v2/{+path}", "scopes": [ "https://www.googleapis.com/auth/tagmanager.delete.containers" ], "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}", "parameterOrder": [ "path" ], "parameters": { "path": { "type": "string", "pattern": "^accounts/[^/]+/containers/[^/]+$", "location": "path", "required": true, "description": "GTM Container's API relative path." } } }, "combine": { "parameters": { "allowUserPermissionFeatureUpdate": { "location": "query", "type": "boolean", "description": "Must be set to true to allow features.user_permissions to change from false to true. If this operation causes an update but this bit is false, the operation will fail." }, "settingSource": { "description": "Specify the source of config setting after combine", "location": "query", "enumDescriptions": [ "", "Keep the current container config setting after combine", "Use config setting from the other tag after combine" ], "enum": [ "settingSourceUnspecified", "current", "other" ], "type": "string" }, "path": { "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+$", "required": true, "type": "string", "description": "GTM Container's API relative path." }, "containerId": { "location": "query", "type": "string", "description": "ID of container that will be merged into the current container." } }, "description": "Combines Containers.", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}:combine", "response": { "$ref": "Container" }, "httpMethod": "POST", "id": "tagmanager.accounts.containers.combine", "parameterOrder": [ "path" ], "deprecated": true, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "path": "tagmanager/v2/{+path}:combine" } }, "resources": { "versions": { "methods": { "live": { "id": "tagmanager.accounts.containers.versions.live", "parameterOrder": [ "parent" ], "description": "Gets the live (i.e. published) container version", "parameters": { "parent": { "type": "string", "description": "GTM Container's API relative path.", "required": true, "pattern": "^accounts/[^/]+/containers/[^/]+$", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "path": "tagmanager/v2/{+parent}/versions:live", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/versions:live", "response": { "$ref": "ContainerVersion" }, "httpMethod": "GET" }, "undelete": { "description": "Undeletes a Container Version.", "httpMethod": "POST", "path": "tagmanager/v2/{+path}:undelete", "parameterOrder": [ "path" ], "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/versions/{versionsId}:undelete", "response": { "$ref": "ContainerVersion" }, "id": "tagmanager.accounts.containers.versions.undelete", "parameters": { "path": { "location": "path", "description": "GTM ContainerVersion's API relative path.", "type": "string", "required": true, "pattern": "^accounts/[^/]+/containers/[^/]+/versions/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containerversions" ] }, "get": { "httpMethod": "GET", "parameters": { "containerVersionId": { "type": "string", "description": "The GTM ContainerVersion ID. Specify published to retrieve the currently published version.", "location": "query" }, "path": { "type": "string", "required": true, "description": "GTM ContainerVersion's API relative path.", "pattern": "^accounts/[^/]+/containers/[^/]+/versions/[^/]+$", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.edit.containerversions", "https://www.googleapis.com/auth/tagmanager.readonly" ], "description": "Gets a Container Version.", "parameterOrder": [ "path" ], "id": "tagmanager.accounts.containers.versions.get", "path": "tagmanager/v2/{+path}", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/versions/{versionsId}", "response": { "$ref": "ContainerVersion" } }, "delete": { "path": "tagmanager/v2/{+path}", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containerversions" ], "httpMethod": "DELETE", "description": "Deletes a Container Version.", "parameterOrder": [ "path" ], "parameters": { "path": { "description": "GTM ContainerVersion's API relative path.", "required": true, "type": "string", "pattern": "^accounts/[^/]+/containers/[^/]+/versions/[^/]+$", "location": "path" } }, "id": "tagmanager.accounts.containers.versions.delete", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/versions/{versionsId}" }, "update": { "description": "Updates a Container Version.", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containerversions" ], "id": "tagmanager.accounts.containers.versions.update", "request": { "$ref": "ContainerVersion" }, "httpMethod": "PUT", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/versions/{versionsId}", "response": { "$ref": "ContainerVersion" }, "parameterOrder": [ "path" ], "parameters": { "path": { "required": true, "location": "path", "description": "GTM ContainerVersion's API relative path.", "type": "string", "pattern": "^accounts/[^/]+/containers/[^/]+/versions/[^/]+$" }, "fingerprint": { "description": "When provided, this fingerprint must match the fingerprint of the container version in storage.", "type": "string", "location": "query" } }, "path": "tagmanager/v2/{+path}" }, "set_latest": { "parameters": { "path": { "description": "GTM ContainerVersion's API relative path.", "type": "string", "location": "path", "required": true, "pattern": "^accounts/[^/]+/containers/[^/]+/versions/[^/]+$" } }, "id": "tagmanager.accounts.containers.versions.set_latest", "path": "tagmanager/v2/{+path}:set_latest", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "httpMethod": "POST", "description": "Sets the latest version used for synchronization of workspaces when detecting conflicts and errors.", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/versions/{versionsId}:set_latest", "response": { "$ref": "ContainerVersion" }, "parameterOrder": [ "path" ] }, "publish": { "description": "Publishes a Container Version.", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/versions/{versionsId}:publish", "response": { "$ref": "PublishContainerVersionResponse" }, "path": "tagmanager/v2/{+path}:publish", "scopes": [ "https://www.googleapis.com/auth/tagmanager.publish" ], "httpMethod": "POST", "parameterOrder": [ "path" ], "parameters": { "path": { "required": true, "type": "string", "description": "GTM ContainerVersion's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/versions/[^/]+$" }, "fingerprint": { "type": "string", "location": "query", "description": "When provided, this fingerprint must match the fingerprint of the container version in storage." } }, "id": "tagmanager.accounts.containers.versions.publish" } } }, "destinations": { "methods": { "get": { "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/destinations/{destinationsId}", "response": { "$ref": "Destination" }, "parameters": { "path": { "type": "string", "required": true, "location": "path", "description": "Google Tag Destination's API relative path.", "pattern": "^accounts/[^/]+/containers/[^/]+/destinations/[^/]+$" } }, "path": "tagmanager/v2/{+path}", "httpMethod": "GET", "description": "Gets a Destination.", "parameterOrder": [ "path" ], "id": "tagmanager.accounts.containers.destinations.get", "deprecated": true, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ] }, "list": { "parameterOrder": [ "parent" ], "parameters": { "parent": { "type": "string", "pattern": "^accounts/[^/]+/containers/[^/]+$", "description": "GTM parent Container's API relative path.", "location": "path", "required": true } }, "id": "tagmanager.accounts.containers.destinations.list", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/destinations", "response": { "$ref": "ListDestinationsResponse" }, "httpMethod": "GET", "description": "Lists all Destinations linked to a GTM Container.", "path": "tagmanager/v2/{+parent}/destinations", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ] }, "link": { "parameterOrder": [ "parent" ], "deprecated": true, "description": "Adds a Destination to this Container and removes it from the Container to which it is currently linked.", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/destinations:link", "response": { "$ref": "Destination" }, "httpMethod": "POST", "path": "tagmanager/v2/{+parent}/destinations:link", "id": "tagmanager.accounts.containers.destinations.link", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "parameters": { "parent": { "description": "GTM parent Container's API relative path.", "pattern": "^accounts/[^/]+/containers/[^/]+$", "location": "path", "type": "string", "required": true }, "destinationId": { "type": "string", "description": "Destination ID to be linked to the current container.", "location": "query" }, "allowUserPermissionFeatureUpdate": { "description": "Must be set to true to allow features.user_permissions to change from false to true. If this operation causes an update but this bit is false, the operation will fail.", "type": "boolean", "location": "query" } } } } }, "workspaces": { "methods": { "update": { "httpMethod": "PUT", "path": "tagmanager/v2/{+path}", "parameterOrder": [ "path" ], "id": "tagmanager.accounts.containers.workspaces.update", "parameters": { "fingerprint": { "type": "string", "location": "query", "description": "When provided, this fingerprint must match the fingerprint of the workspace in storage." }, "path": { "required": true, "location": "path", "type": "string", "description": "GTM Workspace's API relative path.", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "description": "Updates a Workspace.", "request": { "$ref": "Workspace" }, "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}", "response": { "$ref": "Workspace" } }, "bulk_update": { "path": "tagmanager/v2/{+path}/bulk_update", "description": "Applies multiple entity changes to a workspace in one call. When creating new entities, their entity IDs must be unique and in correct format. That is, they must start with \"new_\" and followed by number, e.g. \"new_1\", \"new_2\". Example body snippet to create myNewTag under myNewFolder is: ``` \"changes\": [ { \"folder\": { \"folderId\": \"new_1\", \"name\": \"myNewFolder\", ... }, \"changeStatus\": \"added\" }, { \"tag\": { \"tagId\": \"new_2\", \"name\": \"myNewTag\", \"parentFolderId\": \"new_1\", ... }, \"changeStatus\": \"added\" } ] ```", "id": "tagmanager.accounts.containers.workspaces.bulk_update", "request": { "$ref": "ProposedChange" }, "parameters": { "path": { "type": "string", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "required": true, "location": "path", "description": "GTM Workspace's API relative path." } }, "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/bulk_update", "response": { "$ref": "BulkUpdateWorkspaceResponse" }, "httpMethod": "POST", "parameterOrder": [ "path" ], "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ] }, "list": { "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "parameterOrder": [ "parent" ], "path": "tagmanager/v2/{+parent}/workspaces", "id": "tagmanager.accounts.containers.workspaces.list", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces", "response": { "$ref": "ListWorkspacesResponse" }, "description": "Lists all Workspaces that belong to a GTM Container.", "parameters": { "parent": { "required": true, "description": "GTM parent Container's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+$", "type": "string" }, "pageToken": { "description": "Continuation token for fetching the next page of results.", "type": "string", "location": "query" } }, "httpMethod": "GET" }, "quick_preview": { "httpMethod": "POST", "parameters": { "path": { "required": true, "location": "path", "type": "string", "description": "GTM Workspace's API relative path.", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$" } }, "parameterOrder": [ "path" ], "path": "tagmanager/v2/{+path}:quick_preview", "id": "tagmanager.accounts.containers.workspaces.quick_preview", "description": "Quick previews a workspace by creating a fake container version from all entities in the provided workspace.", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containerversions" ], "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}:quick_preview", "response": { "$ref": "QuickPreviewResponse" } }, "get": { "id": "tagmanager.accounts.containers.workspaces.get", "parameters": { "path": { "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "description": "GTM Workspace's API relative path.", "type": "string", "location": "path", "required": true } }, "parameterOrder": [ "path" ], "httpMethod": "GET", "path": "tagmanager/v2/{+path}", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}", "response": { "$ref": "Workspace" }, "description": "Gets a Workspace.", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ] }, "resolve_conflict": { "path": "tagmanager/v2/{+path}:resolve_conflict", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}:resolve_conflict", "description": "Resolves a merge conflict for a workspace entity by updating it to the resolved entity passed in the request.", "httpMethod": "POST", "parameterOrder": [ "path" ], "request": { "$ref": "Entity" }, "parameters": { "fingerprint": { "description": "When provided, this fingerprint must match the fingerprint of the entity_in_workspace in the merge conflict.", "type": "string", "location": "query" }, "path": { "required": true, "location": "path", "description": "GTM Workspace's API relative path.", "type": "string", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$" } }, "id": "tagmanager.accounts.containers.workspaces.resolve_conflict" }, "delete": { "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/tagmanager.delete.containers" ], "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}", "id": "tagmanager.accounts.containers.workspaces.delete", "path": "tagmanager/v2/{+path}", "parameters": { "path": { "type": "string", "description": "GTM Workspace's API relative path.", "required": true, "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "location": "path" } }, "parameterOrder": [ "path" ], "description": "Deletes a Workspace." }, "sync": { "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}:sync", "response": { "$ref": "SyncWorkspaceResponse" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "parameters": { "path": { "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "required": true, "type": "string", "description": "GTM Workspace's API relative path." } }, "description": "Syncs a workspace to the latest container version by updating all unmodified workspace entities and displaying conflicts for modified entities.", "id": "tagmanager.accounts.containers.workspaces.sync", "path": "tagmanager/v2/{+path}:sync", "parameterOrder": [ "path" ] }, "create": { "httpMethod": "POST", "parameters": { "parent": { "pattern": "^accounts/[^/]+/containers/[^/]+$", "location": "path", "required": true, "description": "GTM parent Container's API relative path.", "type": "string" } }, "path": "tagmanager/v2/{+parent}/workspaces", "request": { "$ref": "Workspace" }, "id": "tagmanager.accounts.containers.workspaces.create", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces", "response": { "$ref": "Workspace" }, "description": "Creates a Workspace.", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ] }, "create_version": { "httpMethod": "POST", "path": "tagmanager/v2/{+path}:create_version", "parameterOrder": [ "path" ], "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}:create_version", "response": { "$ref": "CreateContainerVersionResponse" }, "parameters": { "path": { "type": "string", "description": "GTM Workspace's API relative path.", "required": true, "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containerversions" ], "request": { "$ref": "CreateContainerVersionRequestVersionOptions" }, "description": "Creates a Container Version from the entities present in the workspace, deletes the workspace, and sets the base container version to the newly created version.", "id": "tagmanager.accounts.containers.workspaces.create_version" }, "getStatus": { "parameters": { "path": { "description": "GTM Workspace's API relative path.", "type": "string", "required": true, "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "location": "path" } }, "description": "Finds conflicting and modified entities in the workspace.", "path": "tagmanager/v2/{+path}/status", "httpMethod": "GET", "parameterOrder": [ "path" ], "id": "tagmanager.accounts.containers.workspaces.getStatus", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/status", "response": { "$ref": "GetWorkspaceStatusResponse" }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ] } }, "resources": { "gtag_config": { "methods": { "create": { "id": "tagmanager.accounts.containers.workspaces.gtag_config.create", "parameters": { "parent": { "required": true, "location": "path", "description": "Workspace's API relative path.", "type": "string", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$" } }, "parameterOrder": [ "parent" ], "httpMethod": "POST", "path": "tagmanager/v2/{+parent}/gtag_config", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "request": { "$ref": "GtagConfig" }, "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/gtag_config", "response": { "$ref": "GtagConfig" }, "description": "Creates a Google tag config." }, "get": { "httpMethod": "GET", "path": "tagmanager/v2/{+path}", "parameters": { "path": { "type": "string", "required": true, "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/gtag_config/[^/]+$", "description": "Google tag config's API relative path." } }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "description": "Gets a Google tag config.", "parameterOrder": [ "path" ], "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/gtag_config/{gtag_configId}", "response": { "$ref": "GtagConfig" }, "id": "tagmanager.accounts.containers.workspaces.gtag_config.get" }, "list": { "path": "tagmanager/v2/{+parent}/gtag_config", "parameterOrder": [ "parent" ], "id": "tagmanager.accounts.containers.workspaces.gtag_config.list", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/gtag_config", "response": { "$ref": "ListGtagConfigResponse" }, "parameters": { "parent": { "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "type": "string", "required": true, "description": "Workspace's API relative path." }, "pageToken": { "description": "Continuation token for fetching the next page of results.", "location": "query", "type": "string" } }, "description": "Lists all Google tag configs in a Container." }, "update": { "id": "tagmanager.accounts.containers.workspaces.gtag_config.update", "httpMethod": "PUT", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "path": "tagmanager/v2/{+path}", "parameters": { "fingerprint": { "description": "When provided, this fingerprint must match the fingerprint of the config in storage.", "location": "query", "type": "string" }, "path": { "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/gtag_config/[^/]+$", "location": "path", "description": "Google tag config's API relative path.", "required": true, "type": "string" } }, "parameterOrder": [ "path" ], "description": "Updates a Google tag config.", "request": { "$ref": "GtagConfig" }, "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/gtag_config/{gtag_configId}", "response": { "$ref": "GtagConfig" } }, "delete": { "httpMethod": "DELETE", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/gtag_config/{gtag_configId}", "parameterOrder": [ "path" ], "id": "tagmanager.accounts.containers.workspaces.gtag_config.delete", "parameters": { "path": { "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/gtag_config/[^/]+$", "required": true, "description": "Google tag config's API relative path.", "type": "string" } }, "path": "tagmanager/v2/{+path}", "description": "Deletes a Google tag config.", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ] } } }, "triggers": { "methods": { "delete": { "parameters": { "path": { "type": "string", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/triggers/[^/]+$", "description": "GTM Trigger's API relative path.", "location": "path", "required": true } }, "parameterOrder": [ "path" ], "id": "tagmanager.accounts.containers.workspaces.triggers.delete", "description": "Deletes a GTM Trigger.", "httpMethod": "DELETE", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/triggers/{triggersId}", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "path": "tagmanager/v2/{+path}" }, "update": { "parameters": { "fingerprint": { "location": "query", "type": "string", "description": "When provided, this fingerprint must match the fingerprint of the trigger in storage." }, "path": { "type": "string", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/triggers/[^/]+$", "location": "path", "description": "GTM Trigger's API relative path.", "required": true } }, "httpMethod": "PUT", "description": "Updates a GTM Trigger.", "id": "tagmanager.accounts.containers.workspaces.triggers.update", "path": "tagmanager/v2/{+path}", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "request": { "$ref": "Trigger" }, "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/triggers/{triggersId}", "response": { "$ref": "Trigger" }, "parameterOrder": [ "path" ] }, "revert": { "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "httpMethod": "POST", "path": "tagmanager/v2/{+path}:revert", "id": "tagmanager.accounts.containers.workspaces.triggers.revert", "parameterOrder": [ "path" ], "parameters": { "fingerprint": { "description": "When provided, this fingerprint must match the fingerprint of the trigger in storage.", "location": "query", "type": "string" }, "path": { "required": true, "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/triggers/[^/]+$", "location": "path", "description": "GTM Trigger's API relative path.", "type": "string" } }, "description": "Reverts changes to a GTM Trigger in a GTM Workspace.", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/triggers/{triggersId}:revert", "response": { "$ref": "RevertTriggerResponse" } }, "get": { "id": "tagmanager.accounts.containers.workspaces.triggers.get", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "description": "Gets a GTM Trigger.", "path": "tagmanager/v2/{+path}", "httpMethod": "GET", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/triggers/{triggersId}", "response": { "$ref": "Trigger" }, "parameterOrder": [ "path" ], "parameters": { "path": { "description": "GTM Trigger's API relative path.", "required": true, "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/triggers/[^/]+$", "type": "string", "location": "path" } } }, "list": { "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/triggers", "response": { "$ref": "ListTriggersResponse" }, "parameters": { "parent": { "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "type": "string", "location": "path", "required": true, "description": "GTM Workspace's API relative path." }, "pageToken": { "type": "string", "location": "query", "description": "Continuation token for fetching the next page of results." } }, "id": "tagmanager.accounts.containers.workspaces.triggers.list", "httpMethod": "GET", "path": "tagmanager/v2/{+parent}/triggers", "parameterOrder": [ "parent" ], "description": "Lists all GTM Triggers of a Container.", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ] }, "create": { "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/triggers", "response": { "$ref": "Trigger" }, "request": { "$ref": "Trigger" }, "path": "tagmanager/v2/{+parent}/triggers", "parameters": { "parent": { "description": "GTM Workspace's API relative path.", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "type": "string", "required": true, "location": "path" } }, "id": "tagmanager.accounts.containers.workspaces.triggers.create", "parameterOrder": [ "parent" ], "httpMethod": "POST", "description": "Creates a GTM Trigger." } } }, "variables": { "methods": { "delete": { "path": "tagmanager/v2/{+path}", "id": "tagmanager.accounts.containers.workspaces.variables.delete", "parameters": { "path": { "type": "string", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/variables/[^/]+$", "location": "path", "description": "GTM Variable's API relative path.", "required": true } }, "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/variables/{variablesId}", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "description": "Deletes a GTM Variable.", "parameterOrder": [ "path" ], "httpMethod": "DELETE" }, "update": { "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/variables/{variablesId}", "response": { "$ref": "Variable" }, "parameterOrder": [ "path" ], "path": "tagmanager/v2/{+path}", "request": { "$ref": "Variable" }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "description": "Updates a GTM Variable.", "id": "tagmanager.accounts.containers.workspaces.variables.update", "parameters": { "path": { "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/variables/[^/]+$", "description": "GTM Variable's API relative path.", "required": true, "type": "string" }, "fingerprint": { "type": "string", "location": "query", "description": "When provided, this fingerprint must match the fingerprint of the variable in storage." } }, "httpMethod": "PUT" }, "revert": { "id": "tagmanager.accounts.containers.workspaces.variables.revert", "description": "Reverts changes to a GTM Variable in a GTM Workspace.", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/variables/{variablesId}:revert", "response": { "$ref": "RevertVariableResponse" }, "httpMethod": "POST", "path": "tagmanager/v2/{+path}:revert", "parameterOrder": [ "path" ], "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "parameters": { "fingerprint": { "type": "string", "location": "query", "description": "When provided, this fingerprint must match the fingerprint of the variable in storage." }, "path": { "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/variables/[^/]+$", "location": "path", "description": "GTM Variable's API relative path.", "type": "string", "required": true } } }, "list": { "path": "tagmanager/v2/{+parent}/variables", "id": "tagmanager.accounts.containers.workspaces.variables.list", "httpMethod": "GET", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/variables", "response": { "$ref": "ListVariablesResponse" }, "parameters": { "parent": { "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "type": "string", "description": "GTM Workspace's API relative path.", "location": "path", "required": true }, "pageToken": { "description": "Continuation token for fetching the next page of results.", "type": "string", "location": "query" } }, "description": "Lists all GTM Variables of a Container." }, "get": { "httpMethod": "GET", "parameters": { "path": { "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/variables/[^/]+$", "required": true, "description": "GTM Variable's API relative path.", "type": "string" } }, "parameterOrder": [ "path" ], "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/variables/{variablesId}", "response": { "$ref": "Variable" }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "description": "Gets a GTM Variable.", "path": "tagmanager/v2/{+path}", "id": "tagmanager.accounts.containers.workspaces.variables.get" }, "create": { "path": "tagmanager/v2/{+parent}/variables", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/variables", "response": { "$ref": "Variable" }, "parameterOrder": [ "parent" ], "request": { "$ref": "Variable" }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "parameters": { "parent": { "required": true, "description": "GTM Workspace's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "type": "string" } }, "description": "Creates a GTM Variable.", "id": "tagmanager.accounts.containers.workspaces.variables.create", "httpMethod": "POST" } } }, "tags": { "methods": { "get": { "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "id": "tagmanager.accounts.containers.workspaces.tags.get", "path": "tagmanager/v2/{+path}", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/tags/{tagsId}", "response": { "$ref": "Tag" }, "httpMethod": "GET", "parameterOrder": [ "path" ], "parameters": { "path": { "type": "string", "location": "path", "description": "GTM Tag's API relative path.", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/tags/[^/]+$", "required": true } }, "description": "Gets a GTM Tag." }, "delete": { "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/tags/{tagsId}", "path": "tagmanager/v2/{+path}", "parameterOrder": [ "path" ], "id": "tagmanager.accounts.containers.workspaces.tags.delete", "description": "Deletes a GTM Tag.", "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "parameters": { "path": { "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/tags/[^/]+$", "required": true, "type": "string", "location": "path", "description": "GTM Tag's API relative path." } } }, "update": { "parameterOrder": [ "path" ], "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/tags/{tagsId}", "response": { "$ref": "Tag" }, "request": { "$ref": "Tag" }, "id": "tagmanager.accounts.containers.workspaces.tags.update", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "description": "Updates a GTM Tag.", "httpMethod": "PUT", "parameters": { "path": { "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/tags/[^/]+$", "type": "string", "required": true, "location": "path", "description": "GTM Tag's API relative path." }, "fingerprint": { "location": "query", "type": "string", "description": "When provided, this fingerprint must match the fingerprint of the tag in storage." } }, "path": "tagmanager/v2/{+path}" }, "revert": { "id": "tagmanager.accounts.containers.workspaces.tags.revert", "path": "tagmanager/v2/{+path}:revert", "parameterOrder": [ "path" ], "httpMethod": "POST", "description": "Reverts changes to a GTM Tag in a GTM Workspace.", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "parameters": { "path": { "required": true, "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/tags/[^/]+$", "description": "GTM Tag's API relative path.", "type": "string" }, "fingerprint": { "description": "When provided, this fingerprint must match the fingerprint of thetag in storage.", "type": "string", "location": "query" } }, "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/tags/{tagsId}:revert", "response": { "$ref": "RevertTagResponse" } }, "list": { "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/tags", "response": { "$ref": "ListTagsResponse" }, "id": "tagmanager.accounts.containers.workspaces.tags.list", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "path": "tagmanager/v2/{+parent}/tags", "description": "Lists all GTM Tags of a Container.", "parameterOrder": [ "parent" ], "httpMethod": "GET", "parameters": { "parent": { "required": true, "type": "string", "location": "path", "description": "GTM Workspace's API relative path.", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$" }, "pageToken": { "description": "Continuation token for fetching the next page of results.", "location": "query", "type": "string" } } }, "create": { "parameters": { "parent": { "type": "string", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "description": "GTM Workspace's API relative path.", "location": "path", "required": true } }, "parameterOrder": [ "parent" ], "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/tags", "response": { "$ref": "Tag" }, "path": "tagmanager/v2/{+parent}/tags", "request": { "$ref": "Tag" }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "httpMethod": "POST", "id": "tagmanager.accounts.containers.workspaces.tags.create", "description": "Creates a GTM Tag." } } }, "folders": { "methods": { "move_entities_to_folder": { "description": "Moves entities to a GTM Folder. If {folder_id} in the request path equals 0, this will instead move entities out of the folder they currently belong to.", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "httpMethod": "POST", "request": { "$ref": "Folder" }, "parameters": { "tagId": { "type": "string", "location": "query", "description": "The tags to be moved to the folder.", "repeated": true }, "triggerId": { "description": "The triggers to be moved to the folder.", "repeated": true, "location": "query", "type": "string" }, "path": { "type": "string", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/folders/[^/]+$", "location": "path", "description": "GTM Folder's API relative path.", "required": true }, "variableId": { "location": "query", "type": "string", "repeated": true, "description": "The variables to be moved to the folder." } }, "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/folders/{foldersId}:move_entities_to_folder", "path": "tagmanager/v2/{+path}:move_entities_to_folder", "parameterOrder": [ "path" ], "id": "tagmanager.accounts.containers.workspaces.folders.move_entities_to_folder" }, "update": { "httpMethod": "PUT", "description": "Updates a GTM Folder.", "parameters": { "path": { "type": "string", "description": "GTM Folder's API relative path.", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/folders/[^/]+$", "location": "path", "required": true }, "fingerprint": { "type": "string", "description": "When provided, this fingerprint must match the fingerprint of the folder in storage.", "location": "query" } }, "path": "tagmanager/v2/{+path}", "request": { "$ref": "Folder" }, "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/folders/{foldersId}", "response": { "$ref": "Folder" }, "id": "tagmanager.accounts.containers.workspaces.folders.update", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "parameterOrder": [ "path" ] }, "revert": { "path": "tagmanager/v2/{+path}:revert", "parameterOrder": [ "path" ], "parameters": { "path": { "required": true, "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/folders/[^/]+$", "location": "path", "type": "string", "description": "GTM Folder's API relative path." }, "fingerprint": { "description": "When provided, this fingerprint must match the fingerprint of the tag in storage.", "type": "string", "location": "query" } }, "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/folders/{foldersId}:revert", "response": { "$ref": "RevertFolderResponse" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "description": "Reverts changes to a GTM Folder in a GTM Workspace.", "id": "tagmanager.accounts.containers.workspaces.folders.revert" }, "delete": { "path": "tagmanager/v2/{+path}", "description": "Deletes a GTM Folder.", "id": "tagmanager.accounts.containers.workspaces.folders.delete", "httpMethod": "DELETE", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/folders/{foldersId}", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "parameters": { "path": { "type": "string", "required": true, "description": "GTM Folder's API relative path.", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/folders/[^/]+$", "location": "path" } }, "parameterOrder": [ "path" ] }, "entities": { "parameterOrder": [ "path" ], "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/folders/{foldersId}:entities", "response": { "$ref": "FolderEntities" }, "parameters": { "pageToken": { "description": "Continuation token for fetching the next page of results.", "location": "query", "type": "string" }, "path": { "description": "GTM Folder's API relative path.", "type": "string", "required": true, "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/folders/[^/]+$", "location": "path" } }, "description": "List all entities in a GTM Folder.", "path": "tagmanager/v2/{+path}:entities", "httpMethod": "POST", "id": "tagmanager.accounts.containers.workspaces.folders.entities" }, "get": { "id": "tagmanager.accounts.containers.workspaces.folders.get", "parameterOrder": [ "path" ], "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "parameters": { "path": { "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/folders/[^/]+$", "type": "string", "required": true, "description": "GTM Folder's API relative path." } }, "path": "tagmanager/v2/{+path}", "httpMethod": "GET", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/folders/{foldersId}", "response": { "$ref": "Folder" }, "description": "Gets a GTM Folder." }, "list": { "description": "Lists all GTM Folders of a Container.", "parameterOrder": [ "parent" ], "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/folders", "response": { "$ref": "ListFoldersResponse" }, "path": "tagmanager/v2/{+parent}/folders", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "httpMethod": "GET", "id": "tagmanager.accounts.containers.workspaces.folders.list", "parameters": { "pageToken": { "description": "Continuation token for fetching the next page of results.", "location": "query", "type": "string" }, "parent": { "type": "string", "location": "path", "description": "GTM Workspace's API relative path.", "required": true, "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$" } } }, "create": { "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "description": "Creates a GTM Folder.", "parameterOrder": [ "parent" ], "request": { "$ref": "Folder" }, "httpMethod": "POST", "path": "tagmanager/v2/{+parent}/folders", "parameters": { "parent": { "required": true, "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "type": "string", "description": "GTM Workspace's API relative path." } }, "id": "tagmanager.accounts.containers.workspaces.folders.create", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/folders", "response": { "$ref": "Folder" } } } }, "clients": { "methods": { "create": { "request": { "$ref": "Client" }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/clients", "response": { "$ref": "Client" }, "parameters": { "parent": { "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "required": true, "type": "string", "description": "GTM Workspace's API relative path." } }, "description": "Creates a GTM Client.", "id": "tagmanager.accounts.containers.workspaces.clients.create", "httpMethod": "POST", "path": "tagmanager/v2/{+parent}/clients", "parameterOrder": [ "parent" ] }, "get": { "path": "tagmanager/v2/{+path}", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/clients/{clientsId}", "response": { "$ref": "Client" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "description": "Gets a GTM Client.", "id": "tagmanager.accounts.containers.workspaces.clients.get", "parameterOrder": [ "path" ], "parameters": { "path": { "type": "string", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/clients/[^/]+$", "location": "path", "required": true, "description": "GTM Client's API relative path." } } }, "update": { "id": "tagmanager.accounts.containers.workspaces.clients.update", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/clients/{clientsId}", "response": { "$ref": "Client" }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "description": "Updates a GTM Client.", "httpMethod": "PUT", "path": "tagmanager/v2/{+path}", "request": { "$ref": "Client" }, "parameters": { "path": { "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/clients/[^/]+$", "type": "string", "description": "GTM Client's API relative path.", "location": "path", "required": true }, "fingerprint": { "type": "string", "description": "When provided, this fingerprint must match the fingerprint of the client in storage.", "location": "query" } }, "parameterOrder": [ "path" ] }, "revert": { "description": "Reverts changes to a GTM Client in a GTM Workspace.", "path": "tagmanager/v2/{+path}:revert", "httpMethod": "POST", "parameterOrder": [ "path" ], "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/clients/{clientsId}:revert", "response": { "$ref": "RevertClientResponse" }, "parameters": { "path": { "location": "path", "description": "GTM Client's API relative path.", "required": true, "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/clients/[^/]+$", "type": "string" }, "fingerprint": { "type": "string", "description": "When provided, this fingerprint must match the fingerprint of the client in storage.", "location": "query" } }, "id": "tagmanager.accounts.containers.workspaces.clients.revert", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ] }, "list": { "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/clients", "response": { "$ref": "ListClientsResponse" }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "parameterOrder": [ "parent" ], "id": "tagmanager.accounts.containers.workspaces.clients.list", "description": "Lists all GTM Clients of a GTM container workspace.", "parameters": { "pageToken": { "location": "query", "type": "string", "description": "Continuation token for fetching the next page of results." }, "parent": { "required": true, "location": "path", "type": "string", "description": "GTM Workspace's API relative path.", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$" } }, "path": "tagmanager/v2/{+parent}/clients", "httpMethod": "GET" }, "delete": { "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/clients/{clientsId}", "httpMethod": "DELETE", "id": "tagmanager.accounts.containers.workspaces.clients.delete", "path": "tagmanager/v2/{+path}", "parameterOrder": [ "path" ], "parameters": { "path": { "description": "GTM Client's API relative path.", "type": "string", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/clients/[^/]+$", "location": "path", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "description": "Deletes a GTM Client." } } }, "templates": { "methods": { "update": { "parameters": { "fingerprint": { "type": "string", "description": "When provided, this fingerprint must match the fingerprint of the templates in storage.", "location": "query" }, "path": { "description": "GTM Custom Template's API relative path.", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/templates/[^/]+$", "location": "path", "type": "string", "required": true } }, "id": "tagmanager.accounts.containers.workspaces.templates.update", "httpMethod": "PUT", "path": "tagmanager/v2/{+path}", "description": "Updates a GTM Template.", "request": { "$ref": "CustomTemplate" }, "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/templates/{templatesId}", "response": { "$ref": "CustomTemplate" }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "parameterOrder": [ "path" ] }, "revert": { "parameterOrder": [ "path" ], "httpMethod": "POST", "path": "tagmanager/v2/{+path}:revert", "id": "tagmanager.accounts.containers.workspaces.templates.revert", "parameters": { "fingerprint": { "description": "When provided, this fingerprint must match the fingerprint of the template in storage.", "type": "string", "location": "query" }, "path": { "type": "string", "required": true, "location": "path", "description": "GTM Custom Template's API relative path.", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/templates/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "description": "Reverts changes to a GTM Template in a GTM Workspace.", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/templates/{templatesId}:revert", "response": { "$ref": "RevertTemplateResponse" } }, "list": { "parameters": { "parent": { "type": "string", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "description": "GTM Workspace's API relative path.", "location": "path", "required": true }, "pageToken": { "type": "string", "description": "Continuation token for fetching the next page of results.", "location": "query" } }, "id": "tagmanager.accounts.containers.workspaces.templates.list", "path": "tagmanager/v2/{+parent}/templates", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "description": "Lists all GTM Templates of a GTM container workspace.", "parameterOrder": [ "parent" ], "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/templates", "response": { "$ref": "ListTemplatesResponse" } }, "delete": { "httpMethod": "DELETE", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/templates/{templatesId}", "parameterOrder": [ "path" ], "path": "tagmanager/v2/{+path}", "id": "tagmanager.accounts.containers.workspaces.templates.delete", "parameters": { "path": { "required": true, "location": "path", "type": "string", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/templates/[^/]+$", "description": "GTM Custom Template's API relative path." } }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "description": "Deletes a GTM Template." }, "create": { "parameters": { "parent": { "description": "GTM Workspace's API relative path.", "type": "string", "required": true, "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "location": "path" } }, "httpMethod": "POST", "path": "tagmanager/v2/{+parent}/templates", "description": "Creates a GTM Custom Template.", "request": { "$ref": "CustomTemplate" }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "parameterOrder": [ "parent" ], "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/templates", "response": { "$ref": "CustomTemplate" }, "id": "tagmanager.accounts.containers.workspaces.templates.create" }, "import_from_gallery": { "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "description": "Imports a GTM Custom Template from Gallery.", "id": "tagmanager.accounts.containers.workspaces.templates.import_from_gallery", "parameterOrder": [ "parent" ], "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/templates:import_from_gallery", "response": { "$ref": "CustomTemplate" }, "httpMethod": "POST", "path": "tagmanager/v2/{+parent}/templates:import_from_gallery", "parameters": { "gallerySha": { "type": "string", "location": "query", "description": "SHA version of the Gallery template to import. Defaulted to the latest SHA version if not provided." }, "galleryRepository": { "description": "Repository of the Gallery template to import", "location": "query", "type": "string" }, "parent": { "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "type": "string", "required": true, "description": "GTM Workspace's API relative path.", "location": "path" }, "galleryOwner": { "type": "string", "description": "Owner of the Gallery template to import", "location": "query" }, "acknowledgePermissions": { "type": "boolean", "description": "Must be set to true to allow Gallery template to be imported into the workspace. If this bit is false, the import operation will fail.", "location": "query" } } }, "get": { "parameterOrder": [ "path" ], "id": "tagmanager.accounts.containers.workspaces.templates.get", "path": "tagmanager/v2/{+path}", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/templates/{templatesId}", "response": { "$ref": "CustomTemplate" }, "parameters": { "path": { "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/templates/[^/]+$", "type": "string", "required": true, "description": "GTM Custom Template's API relative path." } }, "description": "Gets a GTM Template.", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "httpMethod": "GET" } } }, "built_in_variables": { "methods": { "delete": { "parameters": { "type": { "enumDescriptions": [ "", "", "", "", "", "For web or mobile.", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "For web or mobile.", "", "For web or mobile.", "For web or mobile.", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ], "type": "string", "location": "query", "repeated": true, "enum": [ "builtInVariableTypeUnspecified", "pageUrl", "pageHostname", "pagePath", "referrer", "event", "clickElement", "clickClasses", "clickId", "clickTarget", "clickUrl", "clickText", "firstPartyServingUrl", "formElement", "formClasses", "formId", "formTarget", "formUrl", "formText", "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", "environmentName", "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", "requestPath", "requestMethod", "clientName", "queryString", "serverPageLocationUrl", "serverPageLocationPath", "serverPageLocationHostname", "visitorRegion", "analyticsClientId", "analyticsSessionId", "analyticsSessionNumber" ], "description": "The types of built-in variables to delete." }, "path": { "description": "GTM BuiltInVariable's API relative path.", "location": "path", "type": "string", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/built_in_variables$", "required": true } }, "description": "Deletes one or more GTM Built-In Variables.", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/built_in_variables", "httpMethod": "DELETE", "path": "tagmanager/v2/{+path}", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "parameterOrder": [ "path" ], "id": "tagmanager.accounts.containers.workspaces.built_in_variables.delete" }, "create": { "id": "tagmanager.accounts.containers.workspaces.built_in_variables.create", "description": "Creates one or more GTM Built-In Variables.", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/built_in_variables", "response": { "$ref": "CreateBuiltInVariableResponse" }, "path": "tagmanager/v2/{+parent}/built_in_variables", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "parameters": { "parent": { "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "description": "GTM Workspace's API relative path.", "type": "string", "location": "path", "required": true }, "type": { "type": "string", "repeated": true, "enum": [ "builtInVariableTypeUnspecified", "pageUrl", "pageHostname", "pagePath", "referrer", "event", "clickElement", "clickClasses", "clickId", "clickTarget", "clickUrl", "clickText", "firstPartyServingUrl", "formElement", "formClasses", "formId", "formTarget", "formUrl", "formText", "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", "environmentName", "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", "requestPath", "requestMethod", "clientName", "queryString", "serverPageLocationUrl", "serverPageLocationPath", "serverPageLocationHostname", "visitorRegion", "analyticsClientId", "analyticsSessionId", "analyticsSessionNumber" ], "location": "query", "enumDescriptions": [ "", "", "", "", "", "For web or mobile.", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "For web or mobile.", "", "For web or mobile.", "For web or mobile.", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ], "description": "The types of built-in variables to enable." } }, "parameterOrder": [ "parent" ] }, "revert": { "description": "Reverts changes to a GTM Built-In Variables in a GTM Workspace.", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "path": "tagmanager/v2/{+path}/built_in_variables:revert", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/built_in_variables:revert", "response": { "$ref": "RevertBuiltInVariableResponse" }, "parameterOrder": [ "path" ], "httpMethod": "POST", "id": "tagmanager.accounts.containers.workspaces.built_in_variables.revert", "parameters": { "path": { "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "required": true, "location": "path", "description": "GTM BuiltInVariable's API relative path.", "type": "string" }, "type": { "enumDescriptions": [ "", "", "", "", "", "For web or mobile.", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "For web or mobile.", "", "For web or mobile.", "For web or mobile.", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ], "description": "The type of built-in variable to revert.", "location": "query", "enum": [ "builtInVariableTypeUnspecified", "pageUrl", "pageHostname", "pagePath", "referrer", "event", "clickElement", "clickClasses", "clickId", "clickTarget", "clickUrl", "clickText", "firstPartyServingUrl", "formElement", "formClasses", "formId", "formTarget", "formUrl", "formText", "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", "environmentName", "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", "requestPath", "requestMethod", "clientName", "queryString", "serverPageLocationUrl", "serverPageLocationPath", "serverPageLocationHostname", "visitorRegion", "analyticsClientId", "analyticsSessionId", "analyticsSessionNumber" ], "type": "string" } } }, "list": { "parameters": { "parent": { "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "location": "path", "type": "string", "required": true, "description": "GTM Workspace's API relative path." }, "pageToken": { "type": "string", "location": "query", "description": "Continuation token for fetching the next page of results." } }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "httpMethod": "GET", "id": "tagmanager.accounts.containers.workspaces.built_in_variables.list", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/built_in_variables", "response": { "$ref": "ListEnabledBuiltInVariablesResponse" }, "description": "Lists all the enabled Built-In Variables of a GTM Container.", "path": "tagmanager/v2/{+parent}/built_in_variables", "parameterOrder": [ "parent" ] } } }, "zones": { "methods": { "create": { "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/zones", "response": { "$ref": "Zone" }, "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "parameters": { "parent": { "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "required": true, "description": "GTM Workspace's API relative path.", "type": "string" } }, "request": { "$ref": "Zone" }, "description": "Creates a GTM Zone.", "id": "tagmanager.accounts.containers.workspaces.zones.create", "path": "tagmanager/v2/{+parent}/zones", "httpMethod": "POST" }, "get": { "parameters": { "path": { "type": "string", "description": "GTM Zone's API relative path.", "required": true, "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/zones/[^/]+$", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "httpMethod": "GET", "description": "Gets a GTM Zone.", "id": "tagmanager.accounts.containers.workspaces.zones.get", "parameterOrder": [ "path" ], "path": "tagmanager/v2/{+path}", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/zones/{zonesId}", "response": { "$ref": "Zone" } }, "list": { "id": "tagmanager.accounts.containers.workspaces.zones.list", "parameters": { "pageToken": { "location": "query", "description": "Continuation token for fetching the next page of results.", "type": "string" }, "parent": { "required": true, "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "type": "string", "description": "GTM Workspace's API relative path.", "location": "path" } }, "description": "Lists all GTM Zones of a GTM container workspace.", "path": "tagmanager/v2/{+parent}/zones", "httpMethod": "GET", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/zones", "response": { "$ref": "ListZonesResponse" } }, "update": { "parameters": { "path": { "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/zones/[^/]+$", "type": "string", "required": true, "description": "GTM Zone's API relative path.", "location": "path" }, "fingerprint": { "description": "When provided, this fingerprint must match the fingerprint of the zone in storage.", "type": "string", "location": "query" } }, "path": "tagmanager/v2/{+path}", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/zones/{zonesId}", "response": { "$ref": "Zone" }, "httpMethod": "PUT", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "request": { "$ref": "Zone" }, "parameterOrder": [ "path" ], "description": "Updates a GTM Zone.", "id": "tagmanager.accounts.containers.workspaces.zones.update" }, "revert": { "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "path": "tagmanager/v2/{+path}:revert", "httpMethod": "POST", "parameters": { "path": { "description": "GTM Zone's API relative path.", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/zones/[^/]+$", "location": "path", "type": "string", "required": true }, "fingerprint": { "type": "string", "location": "query", "description": "When provided, this fingerprint must match the fingerprint of the zone in storage." } }, "id": "tagmanager.accounts.containers.workspaces.zones.revert", "description": "Reverts changes to a GTM Zone in a GTM Workspace.", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/zones/{zonesId}:revert", "response": { "$ref": "RevertZoneResponse" }, "parameterOrder": [ "path" ] }, "delete": { "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "description": "Deletes a GTM Zone.", "parameters": { "path": { "type": "string", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/zones/[^/]+$", "required": true, "description": "GTM Zone's API relative path." } }, "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/zones/{zonesId}", "httpMethod": "DELETE", "path": "tagmanager/v2/{+path}", "id": "tagmanager.accounts.containers.workspaces.zones.delete", "parameterOrder": [ "path" ] } } }, "transformations": { "methods": { "create": { "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/transformations", "response": { "$ref": "Transformation" }, "parameters": { "parent": { "required": true, "description": "GTM Workspace's API relative path.", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "location": "path", "type": "string" } }, "request": { "$ref": "Transformation" }, "parameterOrder": [ "parent" ], "httpMethod": "POST", "id": "tagmanager.accounts.containers.workspaces.transformations.create", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "description": "Creates a GTM Transformation.", "path": "tagmanager/v2/{+parent}/transformations" }, "list": { "id": "tagmanager.accounts.containers.workspaces.transformations.list", "path": "tagmanager/v2/{+parent}/transformations", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "parameterOrder": [ "parent" ], "description": "Lists all GTM Transformations of a GTM container workspace.", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/transformations", "response": { "$ref": "ListTransformationsResponse" }, "httpMethod": "GET", "parameters": { "pageToken": { "type": "string", "location": "query", "description": "Continuation token for fetching the next page of results." }, "parent": { "required": true, "description": "GTM Workspace's API relative path.", "location": "path", "type": "string", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$" } } }, "update": { "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/transformations/{transformationsId}", "response": { "$ref": "Transformation" }, "request": { "$ref": "Transformation" }, "description": "Updates a GTM Transformation.", "parameterOrder": [ "path" ], "path": "tagmanager/v2/{+path}", "httpMethod": "PUT", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "id": "tagmanager.accounts.containers.workspaces.transformations.update", "parameters": { "path": { "required": true, "description": "GTM Transformation's API relative path.", "location": "path", "type": "string", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/transformations/[^/]+$" }, "fingerprint": { "type": "string", "location": "query", "description": "When provided, this fingerprint must match the fingerprint of the transformation in storage." } } }, "revert": { "description": "Reverts changes to a GTM Transformation in a GTM Workspace.", "httpMethod": "POST", "id": "tagmanager.accounts.containers.workspaces.transformations.revert", "path": "tagmanager/v2/{+path}:revert", "parameters": { "fingerprint": { "description": "When provided, this fingerprint must match the fingerprint of the transformation in storage.", "location": "query", "type": "string" }, "path": { "description": "GTM Transformation's API relative path.", "required": true, "location": "path", "type": "string", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/transformations/[^/]+$" } }, "parameterOrder": [ "path" ], "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/transformations/{transformationsId}:revert", "response": { "$ref": "RevertTransformationResponse" } }, "delete": { "path": "tagmanager/v2/{+path}", "httpMethod": "DELETE", "id": "tagmanager.accounts.containers.workspaces.transformations.delete", "parameterOrder": [ "path" ], "parameters": { "path": { "required": true, "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/transformations/[^/]+$", "type": "string", "description": "GTM Transformation's API relative path.", "location": "path" } }, "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/transformations/{transformationsId}", "description": "Deletes a GTM Transformation.", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ] }, "get": { "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/transformations/{transformationsId}", "response": { "$ref": "Transformation" }, "parameterOrder": [ "path" ], "httpMethod": "GET", "path": "tagmanager/v2/{+path}", "parameters": { "path": { "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/transformations/[^/]+$", "description": "GTM Transformation's API relative path.", "type": "string", "location": "path", "required": true } }, "id": "tagmanager.accounts.containers.workspaces.transformations.get", "description": "Gets a GTM Transformation." } } } } }, "version_headers": { "methods": { "list": { "id": "tagmanager.accounts.containers.version_headers.list", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/version_headers", "response": { "$ref": "ListContainerVersionsResponse" }, "parameterOrder": [ "parent" ], "description": "Lists all Container Versions of a GTM Container.", "parameters": { "parent": { "type": "string", "description": "GTM Container's API relative path.", "pattern": "^accounts/[^/]+/containers/[^/]+$", "location": "path", "required": true }, "pageToken": { "type": "string", "description": "Continuation token for fetching the next page of results.", "location": "query" }, "includeDeleted": { "type": "boolean", "location": "query", "description": "Also retrieve deleted (archived) versions when true." } }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.edit.containerversions", "https://www.googleapis.com/auth/tagmanager.readonly" ], "path": "tagmanager/v2/{+parent}/version_headers", "httpMethod": "GET" }, "latest": { "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "parameters": { "parent": { "pattern": "^accounts/[^/]+/containers/[^/]+$", "type": "string", "description": "GTM Container's API relative path.", "location": "path", "required": true } }, "path": "tagmanager/v2/{+parent}/version_headers:latest", "parameterOrder": [ "parent" ], "description": "Gets the latest container version header", "httpMethod": "GET", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/version_headers:latest", "response": { "$ref": "ContainerVersionHeader" }, "id": "tagmanager.accounts.containers.version_headers.latest" } } }, "environments": { "methods": { "update": { "description": "Updates a GTM Environment.", "httpMethod": "PUT", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/environments/{environmentsId}", "response": { "$ref": "Environment" }, "path": "tagmanager/v2/{+path}", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "id": "tagmanager.accounts.containers.environments.update", "parameters": { "path": { "description": "GTM Environment's API relative path.", "pattern": "^accounts/[^/]+/containers/[^/]+/environments/[^/]+$", "type": "string", "location": "path", "required": true }, "fingerprint": { "type": "string", "location": "query", "description": "When provided, this fingerprint must match the fingerprint of the environment in storage." } }, "parameterOrder": [ "path" ], "request": { "$ref": "Environment" } }, "list": { "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "parameters": { "pageToken": { "description": "Continuation token for fetching the next page of results.", "type": "string", "location": "query" }, "parent": { "type": "string", "required": true, "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+$", "description": "GTM Container's API relative path." } }, "parameterOrder": [ "parent" ], "description": "Lists all GTM Environments of a GTM Container.", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/environments", "response": { "$ref": "ListEnvironmentsResponse" }, "httpMethod": "GET", "id": "tagmanager.accounts.containers.environments.list", "path": "tagmanager/v2/{+parent}/environments" }, "delete": { "description": "Deletes a GTM Environment.", "parameters": { "path": { "required": true, "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/environments/[^/]+$", "type": "string", "description": "GTM Environment's API relative path." } }, "parameterOrder": [ "path" ], "id": "tagmanager.accounts.containers.environments.delete", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/environments/{environmentsId}", "path": "tagmanager/v2/{+path}", "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ] }, "create": { "id": "tagmanager.accounts.containers.environments.create", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "parameters": { "parent": { "required": true, "location": "path", "description": "GTM Container's API relative path.", "pattern": "^accounts/[^/]+/containers/[^/]+$", "type": "string" } }, "parameterOrder": [ "parent" ], "description": "Creates a GTM Environment.", "httpMethod": "POST", "path": "tagmanager/v2/{+parent}/environments", "request": { "$ref": "Environment" }, "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/environments", "response": { "$ref": "Environment" } }, "get": { "id": "tagmanager.accounts.containers.environments.get", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "description": "Gets a GTM Environment.", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/environments/{environmentsId}", "response": { "$ref": "Environment" }, "path": "tagmanager/v2/{+path}", "httpMethod": "GET", "parameterOrder": [ "path" ], "parameters": { "path": { "required": true, "location": "path", "type": "string", "description": "GTM Environment's API relative path.", "pattern": "^accounts/[^/]+/containers/[^/]+/environments/[^/]+$" } } }, "reauthorize": { "id": "tagmanager.accounts.containers.environments.reauthorize", "parameters": { "path": { "type": "string", "required": true, "pattern": "^accounts/[^/]+/containers/[^/]+/environments/[^/]+$", "location": "path", "description": "GTM Environment's API relative path." } }, "httpMethod": "POST", "request": { "$ref": "Environment" }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.publish" ], "parameterOrder": [ "path" ], "path": "tagmanager/v2/{+path}:reauthorize", "description": "Re-generates the authorization code for a GTM Environment.", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/environments/{environmentsId}:reauthorize", "response": { "$ref": "Environment" } } } } } } }, "methods": { "list": { "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" ], "parameterOrder": [], "path": "tagmanager/v2/accounts", "parameters": { "pageToken": { "description": "Continuation token for fetching the next page of results.", "type": "string", "location": "query" }, "includeGoogleTags": { "description": "Also retrieve accounts associated with Google Tag when true.", "location": "query", "type": "boolean" } }, "description": "Lists all GTM Accounts that a user has access to.", "id": "tagmanager.accounts.list", "flatPath": "tagmanager/v2/accounts", "response": { "$ref": "ListAccountsResponse" } }, "get": { "id": "tagmanager.accounts.get", "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" ], "path": "tagmanager/v2/{+path}", "parameters": { "path": { "location": "path", "description": "GTM Account's API relative path.", "type": "string", "required": true, "pattern": "^accounts/[^/]+$" } }, "description": "Gets a GTM Account.", "parameterOrder": [ "path" ], "flatPath": "tagmanager/v2/accounts/{accountsId}", "response": { "$ref": "Account" } }, "update": { "parameters": { "path": { "required": true, "description": "GTM Account's API relative path.", "pattern": "^accounts/[^/]+$", "type": "string", "location": "path" }, "fingerprint": { "description": "When provided, this fingerprint must match the fingerprint of the account in storage.", "location": "query", "type": "string" } }, "description": "Updates a GTM Account.", "parameterOrder": [ "path" ], "scopes": [ "https://www.googleapis.com/auth/tagmanager.manage.accounts" ], "httpMethod": "PUT", "id": "tagmanager.accounts.update", "path": "tagmanager/v2/{+path}", "request": { "$ref": "Account" }, "flatPath": "tagmanager/v2/accounts/{accountsId}", "response": { "$ref": "Account" } } } } }, "description": "This API allows clients to access and modify container and tag configuration.", "protocol": "rest", "name": "tagmanager", "batchPath": "batch", "parameters": { "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response.", "location": "query" }, "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." }, "prettyPrint": { "location": "query", "type": "boolean", "default": "true", "description": "Returns response with indentations and line breaks." }, "uploadType": { "type": "string", "location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "upload_protocol": { "type": "string", "location": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, "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" ], "location": "query", "description": "Data format for response.", "enum": [ "json", "media", "proto" ], "default": "json" }, "access_token": { "location": "query", "description": "OAuth access token.", "type": "string" }, "$.xgafv": { "enumDescriptions": [ "v1 error format", "v2 error format" ], "enum": [ "1", "2" ], "location": "query", "description": "V1 error format.", "type": "string" }, "quotaUser": { "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.", "type": "string", "location": "query" }, "callback": { "location": "query", "type": "string", "description": "JSONP" }, "oauth_token": { "description": "OAuth 2.0 token for the current user.", "type": "string", "location": "query" } }, "ownerDomain": "google.com", "id": "tagmanager:v2", "mtlsRootUrl": "https://tagmanager.mtls.googleapis.com/", "servicePath": "", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "revision": "20260916", "title": "Tag Manager API" }