{ "schemas": { "ContainerAccess": { "properties": { "containerId": { "description": "GTM Container ID.", "type": "string" }, "permission": { "enumDescriptions": [ "", "", "", "", "", "" ], "type": "string", "enum": [ "containerPermissionUnspecified", "noAccess", "read", "edit", "approve", "publish" ], "description": "List of Container permissions." } }, "description": "Defines the Google Tag Manager Container access permissions.", "type": "object", "id": "ContainerAccess" }, "Environment": { "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", "properties": { "authorizationTimestamp": { "type": "string", "format": "google-datetime", "description": "The last update time-stamp for the authorization code." }, "description": { "description": "The environment description. Can be set or changed only on USER type environments.", "type": "string" }, "accountId": { "description": "GTM Account ID.", "type": "string" }, "enableDebug": { "description": "Whether or not to enable debug by default for the environment.", "type": "boolean" }, "fingerprint": { "description": "The fingerprint of the GTM environment as computed at storage time. This value is recomputed whenever the environment is modified.", "type": "string" }, "authorizationCode": { "description": "The environment authorization code.", "type": "string" }, "type": { "type": "string", "description": "The type of this environment.", "enum": [ "user", "live", "latest", "workspace" ], "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." ] }, "url": { "type": "string", "description": "Default preview page url for the environment." }, "workspaceId": { "type": "string", "description": "Represents a link to a quick preview of a workspace." }, "path": { "description": "GTM Environment's API relative path.", "type": "string" }, "containerId": { "type": "string", "description": "GTM Container ID." }, "environmentId": { "type": "string", "description": "GTM Environment ID uniquely identifies the GTM Environment." }, "tagManagerUrl": { "description": "Auto generated link to the tag manager UI", "type": "string" }, "containerVersionId": { "description": "Represents a link to a container version.", "type": "string" }, "name": { "description": "The environment display name. Can be set or changed only on USER type environments.", "type": "string" } }, "id": "Environment" }, "RevertFolderResponse": { "properties": { "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.", "$ref": "Folder" } }, "type": "object", "id": "RevertFolderResponse", "description": "The result of reverting folder changes in a workspace." }, "ListFoldersResponse": { "type": "object", "description": "List Folders Response.", "id": "ListFoldersResponse", "properties": { "nextPageToken": { "description": "Continuation token for fetching the next page of results.", "type": "string" }, "folder": { "description": "All GTM Folders of a GTM Container.", "type": "array", "items": { "$ref": "Folder" } } } }, "RevertZoneResponse": { "id": "RevertZoneResponse", "type": "object", "description": "The result of reverting a zone in a workspace.", "properties": { "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.", "$ref": "Zone" } } }, "ListDestinationsResponse": { "properties": { "destination": { "description": "All Destinations linked to a GTM Container.", "type": "array", "items": { "$ref": "Destination" } }, "nextPageToken": { "description": "Continuation token for fetching the next page of results.", "type": "string" } }, "id": "ListDestinationsResponse", "type": "object" }, "Tag": { "id": "Tag", "type": "object", "properties": { "setupTag": { "description": "The list of setup tags. Currently we only allow one.", "type": "array", "items": { "$ref": "SetupTag" } }, "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" }, "accountId": { "description": "GTM Account ID.", "type": "string" }, "type": { "description": "GTM Tag Type.", "type": "string" }, "scheduleStartMs": { "format": "int64", "description": "The start timestamp in milliseconds to schedule a tag.", "type": "string" }, "blockingTriggerId": { "description": "Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag will not fire.", "type": "array", "items": { "type": "string" } }, "consentSettings": { "$ref": "TagConsentSetting", "description": "Consent settings of a tag." }, "containerId": { "type": "string", "description": "GTM Container ID." }, "parameter": { "description": "The tag's parameters.", "type": "array", "items": { "$ref": "Parameter" } }, "name": { "description": "Tag display name.", "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" }, "workspaceId": { "type": "string", "description": "GTM Workspace ID." }, "tagFiringOption": { "type": "string", "description": "Option to fire this tag.", "enum": [ "tagFiringOptionUnspecified", "unlimited", "oncePerEvent", "oncePerLoad" ], "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)." ] }, "fingerprint": { "description": "The fingerprint of the GTM Tag as computed at storage time. This value is recomputed whenever the tag is modified.", "type": "string" }, "priority": { "$ref": "Parameter", "description": "User defined numeric priority of the tag. Tags are fired asynchronously in order of priority. Tags with higher numeric value fire first. A tag's priority can be a positive or negative value. The default value is 0." }, "scheduleEndMs": { "type": "string", "format": "int64", "description": "The end timestamp in milliseconds to schedule a tag." }, "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." }, "parentFolderId": { "type": "string", "description": "Parent folder id." }, "notes": { "description": "User notes on how to apply this tag in the container.", "type": "string" }, "path": { "type": "string", "description": "GTM Tag's API relative path." }, "tagId": { "type": "string", "description": "The Tag ID uniquely identifies the GTM Tag." }, "paused": { "description": "Indicates whether the tag is paused, which prevents the tag from firing.", "type": "boolean" }, "teardownTag": { "items": { "$ref": "TeardownTag" }, "description": "The list of teardown tags. Currently we only allow one.", "type": "array" }, "tagManagerUrl": { "description": "Auto generated link to the tag manager UI", "type": "string" }, "monitoringMetadataTagNameKey": { "description": "If non-empty, then the tag display name will be included in the monitoring metadata map using the key specified.", "type": "string" } }, "description": "Represents a Google Tag Manager Tag." }, "Destination": { "properties": { "destinationId": { "type": "string", "description": "Destination ID." }, "path": { "description": "Destination's API relative path.", "type": "string" }, "tagManagerUrl": { "type": "string", "description": "Auto generated link to the tag manager UI." }, "destinationLinkId": { "type": "string", "description": "The Destination link ID uniquely identifies the Destination." }, "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" }, "name": { "type": "string", "description": "Destination display name." }, "containerId": { "type": "string", "description": "GTM Container ID." } }, "type": "object", "id": "Destination", "description": "Represents a Google Tag Destination." }, "VariableFormatValue": { "properties": { "caseConversionType": { "enum": [ "none", "lowercase", "uppercase" ], "description": "The option to convert a string-type variable value to either lowercase or uppercase.", "enumDescriptions": [ "", "The option to convert a variable value to lowercase.", "The option to convert a variable value to uppercase." ], "type": "string" }, "convertFalseToValue": { "$ref": "Parameter", "description": "The value to convert if a variable value is false." }, "convertUndefinedToValue": { "$ref": "Parameter", "description": "The value to convert if a variable value is undefined." }, "convertTrueToValue": { "description": "The value to convert if a variable value is true.", "$ref": "Parameter" }, "convertToBoolean": { "type": "boolean", "description": "The option to convert a variable value to a boolean." }, "convertNullToValue": { "description": "The value to convert if a variable value is null.", "$ref": "Parameter" }, "convertToNumber": { "description": "The option to convert a variable value to a number.", "enum": [ "decimalSeparatorTypeUnspecified", "period", "comma", "automatic" ], "type": "string", "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." ] } }, "type": "object", "id": "VariableFormatValue" }, "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" } }, "id": "ListTemplatesResponse", "type": "object" }, "ListZonesResponse": { "properties": { "zone": { "items": { "$ref": "Zone" }, "type": "array", "description": "All GTM Zones of a GTM Container." }, "nextPageToken": { "description": "Continuation token for fetching the next page of results.", "type": "string" } }, "id": "ListZonesResponse", "type": "object" }, "GetWorkspaceStatusResponse": { "type": "object", "description": "The changes that have occurred in the workspace since the base container version.", "properties": { "mergeConflict": { "type": "array", "description": "The merge conflict after sync.", "items": { "$ref": "MergeConflict" } }, "workspaceChange": { "type": "array", "description": "Entities that have been changed in the workspace.", "items": { "$ref": "Entity" } } }, "id": "GetWorkspaceStatusResponse" }, "ZoneChildContainer": { "id": "ZoneChildContainer", "description": "Represents a child container of a Zone.", "type": "object", "properties": { "publicId": { "description": "The child container's public id.", "type": "string" }, "nickname": { "type": "string", "description": "The zone's nickname for the child container." } } }, "CreateContainerVersionRequestVersionOptions": { "type": "object", "description": "Options for new container versions.", "id": "CreateContainerVersionRequestVersionOptions", "properties": { "name": { "description": "The name of the container version to be created.", "type": "string" }, "notes": { "type": "string", "description": "The notes of the container version to be created." } } }, "AccountAccess": { "type": "object", "id": "AccountAccess", "description": "Defines the Google Tag Manager Account access permissions.", "properties": { "permission": { "enumDescriptions": [ "", "", "", "" ], "type": "string", "enum": [ "accountPermissionUnspecified", "noAccess", "user", "admin" ], "description": "Whether the user has no access, user access, or admin access to an account." } } }, "ListAccountsResponse": { "properties": { "account": { "items": { "$ref": "Account" }, "type": "array", "description": "List of GTM Accounts that a user has access to." }, "nextPageToken": { "description": "Continuation token for fetching the next page of results.", "type": "string" } }, "id": "ListAccountsResponse", "type": "object", "description": "List Accounts Response." }, "TagConsentSetting": { "properties": { "consentStatus": { "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.", "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." ], "enum": [ "notSet", "notNeeded", "needed" ], "type": "string" }, "consentType": { "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.", "$ref": "Parameter" } }, "type": "object", "id": "TagConsentSetting" }, "ZoneTypeRestriction": { "properties": { "enable": { "type": "boolean", "description": "True if type restrictions have been enabled for this Zone." }, "whitelistedTypeId": { "items": { "type": "string" }, "type": "array", "description": "List of type public ids that have been whitelisted for use in this Zone." } }, "id": "ZoneTypeRestriction", "type": "object", "description": "Represents a Zone's type restrictions." }, "ContainerVersionHeader": { "id": "ContainerVersionHeader", "description": "Represents a Google Tag Manager Container Version Header.", "type": "object", "properties": { "numGtagConfigs": { "type": "string", "description": "Number of Google tag configs in the container version." }, "containerVersionId": { "type": "string", "description": "The Container Version ID uniquely identifies the GTM Container Version." }, "numClients": { "type": "string", "description": "Number of clients in the container version." }, "deleted": { "description": "A value of true indicates this container version has been deleted.", "type": "boolean" }, "accountId": { "description": "GTM Account ID.", "type": "string" }, "numVariables": { "description": "Number of variables in the container version.", "type": "string" }, "name": { "type": "string", "description": "Container version display name." }, "containerId": { "description": "GTM Container ID.", "type": "string" }, "path": { "type": "string", "description": "GTM Container Version's API relative path." }, "numCustomTemplates": { "description": "Number of custom templates in the container version.", "type": "string" }, "numTags": { "description": "Number of tags in the container version.", "type": "string" }, "numTransformations": { "description": "Number of transformations in the container version.", "type": "string" }, "numZones": { "description": "Number of zones in the container version.", "type": "string" }, "numTriggers": { "description": "Number of triggers in the container version.", "type": "string" } } }, "GalleryReference": { "properties": { "owner": { "description": "The name of the owner for the community gallery template.", "type": "string" }, "host": { "description": "The name of the host for the community gallery template.", "type": "string" }, "version": { "description": "The version of the community gallery template.", "type": "string" }, "repository": { "description": "The name of the repository for the community gallery template.", "type": "string" }, "isModified": { "description": "If a user has manually edited the community gallery template.", "type": "boolean" }, "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." }, "templateDeveloperId": { "type": "string", "description": "The developer id of the community gallery template. This value is set whenever the template is created from the gallery." }, "galleryTemplateId": { "description": "ID for the gallery template that is generated once during first sync and travels with the template redirects.", "type": "string" } }, "description": "Represents the link between a custom template and an entry on the Community Template Gallery site.", "id": "GalleryReference", "type": "object" }, "PublishContainerVersionResponse": { "properties": { "compilerError": { "description": "Compiler errors or not.", "type": "boolean" }, "containerVersion": { "$ref": "ContainerVersion", "description": "The container version created." } }, "type": "object", "description": "Publish container version response.", "id": "PublishContainerVersionResponse" }, "TeardownTag": { "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", "type": "object", "description": "Represents a tag that fires after another tag in order to tear down dependencies." }, "RevertClientResponse": { "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" } }, "type": "object", "description": "The result of reverting a client in a workspace.", "id": "RevertClientResponse" }, "ProposedChange": { "properties": { "changes": { "description": "The list of workspace changes to be applied.", "type": "array", "items": { "$ref": "Entity" } } }, "id": "ProposedChange", "type": "object" }, "RevertTransformationResponse": { "description": "The result of reverting a transformation in a workspace.", "id": "RevertTransformationResponse", "properties": { "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.", "$ref": "Transformation" } }, "type": "object" }, "RevertVariableResponse": { "id": "RevertVariableResponse", "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" } }, "description": "The result of reverting a variable in a workspace.", "type": "object" }, "RevertTagResponse": { "description": "The result of reverting a tag in a workspace.", "id": "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" } } }, "SetupTag": { "properties": { "tagName": { "type": "string", "description": "The name of the setup tag." }, "stopOnSetupFailure": { "type": "boolean", "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." } }, "description": "Represents a reference to atag that fires before another tag in order to set up dependencies.", "type": "object", "id": "SetupTag" }, "MergeConflict": { "id": "MergeConflict", "type": "object", "description": "Represents a merge conflict.", "properties": { "entityInWorkspace": { "$ref": "Entity", "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." }, "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" } } }, "ListTriggersResponse": { "id": "ListTriggersResponse", "type": "object", "properties": { "trigger": { "type": "array", "items": { "$ref": "Trigger" }, "description": "All GTM Triggers of a GTM Container." }, "nextPageToken": { "description": "Continuation token for fetching the next page of results.", "type": "string" } }, "description": "List triggers response." }, "ListUserPermissionsResponse": { "properties": { "userPermission": { "items": { "$ref": "UserPermission" }, "description": "All GTM UserPermissions of a GTM Account.", "type": "array" }, "nextPageToken": { "description": "Continuation token for fetching the next page of results.", "type": "string" } }, "type": "object", "id": "ListUserPermissionsResponse", "description": "List user permissions response." }, "Workspace": { "properties": { "path": { "type": "string", "description": "GTM Workspace's API relative path." }, "accountId": { "description": "GTM Account ID.", "type": "string" }, "containerId": { "description": "GTM Container ID.", "type": "string" }, "workspaceId": { "description": "The Workspace ID uniquely identifies the GTM Workspace.", "type": "string" }, "description": { "description": "Workspace description.", "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." }, "name": { "description": "Workspace display name.", "type": "string" }, "tagManagerUrl": { "description": "Auto generated link to the tag manager UI", "type": "string" } }, "type": "object", "description": "Represents a Google Tag Manager Container Workspace.", "id": "Workspace" }, "ListTransformationsResponse": { "id": "ListTransformationsResponse", "type": "object", "properties": { "transformation": { "type": "array", "description": "All GTM Transformations of a GTM Container.", "items": { "$ref": "Transformation" } }, "nextPageToken": { "description": "Continuation token for fetching the next page of results.", "type": "string" } } }, "Variable": { "id": "Variable", "type": "object", "properties": { "path": { "description": "GTM Variable's API relative path.", "type": "string" }, "name": { "type": "string", "description": "Variable display name." }, "fingerprint": { "description": "The fingerprint of the GTM Variable as computed at storage time. This value is recomputed whenever the variable is modified.", "type": "string" }, "formatValue": { "$ref": "VariableFormatValue", "description": "Option to convert a variable value to other value." }, "variableId": { "description": "The Variable ID uniquely identifies the GTM Variable.", "type": "string" }, "parentFolderId": { "type": "string", "description": "Parent folder id." }, "tagManagerUrl": { "description": "Auto generated link to the tag manager UI", "type": "string" }, "accountId": { "description": "GTM Account ID.", "type": "string" }, "notes": { "type": "string", "description": "User notes on how to apply this variable in the container." }, "type": { "description": "GTM Variable Type.", "type": "string" }, "containerId": { "type": "string", "description": "GTM Container ID." }, "scheduleStartMs": { "description": "The start timestamp in milliseconds to schedule a variable.", "type": "string", "format": "int64" }, "disablingTriggerId": { "type": "array", "items": { "type": "string" }, "description": "For mobile containers only: A list of trigger IDs for disabling conditional variables; the variable is enabled if one of the enabling trigger is true while all the disabling trigger are false. Treated as an unordered set." }, "parameter": { "type": "array", "items": { "$ref": "Parameter" }, "description": "The variable's parameters." }, "workspaceId": { "description": "GTM Workspace ID.", "type": "string" }, "scheduleEndMs": { "type": "string", "description": "The end timestamp in milliseconds to schedule a variable.", "format": "int64" }, "enablingTriggerId": { "items": { "type": "string" }, "type": "array", "description": "For mobile containers only: A list of trigger IDs for enabling conditional variables; the variable is enabled if one of the enabling triggers is true while all the disabling triggers are false. Treated as an unordered set." } }, "description": "Represents a Google Tag Manager Variable." }, "ContainerVersion": { "type": "object", "id": "ContainerVersion", "description": "Represents a Google Tag Manager Container Version.", "properties": { "variable": { "type": "array", "items": { "$ref": "Variable" }, "description": "The variables in the container that this version was taken from." }, "containerVersionId": { "type": "string", "description": "The Container Version ID uniquely identifies the GTM Container Version." }, "container": { "$ref": "Container", "description": "The container that this version was taken from." }, "transformation": { "items": { "$ref": "Transformation" }, "type": "array", "description": "The transformations in the container that this version was taken from." }, "fingerprint": { "type": "string", "description": "The fingerprint of the GTM Container Version as computed at storage time. This value is recomputed whenever the container version is modified." }, "deleted": { "description": "A value of true indicates this container version has been deleted.", "type": "boolean" }, "customTemplate": { "type": "array", "items": { "$ref": "CustomTemplate" }, "description": "The custom templates in the container that this version was taken from." }, "tag": { "type": "array", "description": "The tags in the container that this version was taken from.", "items": { "$ref": "Tag" } }, "accountId": { "description": "GTM Account ID.", "type": "string" }, "description": { "description": "Container version description.", "type": "string" }, "tagManagerUrl": { "description": "Auto generated link to the tag manager UI", "type": "string" }, "builtInVariable": { "items": { "$ref": "BuiltInVariable" }, "description": "The built-in variables in the container that this version was taken from.", "type": "array" }, "client": { "type": "array", "description": "The clients in the container that this version was taken from.", "items": { "$ref": "Client" } }, "path": { "type": "string", "description": "GTM Container Version's API relative path." }, "name": { "type": "string", "description": "Container version display name." }, "zone": { "items": { "$ref": "Zone" }, "type": "array", "description": "The zones in the container that this version was taken from." }, "containerId": { "description": "GTM Container ID.", "type": "string" }, "trigger": { "items": { "$ref": "Trigger" }, "description": "The triggers in the container that this version was taken from.", "type": "array" }, "gtagConfig": { "items": { "$ref": "GtagConfig" }, "type": "array", "description": "The Google tag configs in the container that this version was taken from." }, "folder": { "description": "The folders in the container that this version was taken from.", "type": "array", "items": { "$ref": "Folder" } } } }, "ListEnabledBuiltInVariablesResponse": { "id": "ListEnabledBuiltInVariablesResponse", "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" } }, "type": "object", "description": "A list of enabled built-in variables." }, "RevertTriggerResponse": { "id": "RevertTriggerResponse", "description": "The result of reverting a trigger in a workspace.", "type": "object", "properties": { "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.", "$ref": "Trigger" } } }, "ListWorkspacesResponse": { "properties": { "nextPageToken": { "type": "string", "description": "Continuation token for fetching the next page of results." }, "workspace": { "type": "array", "items": { "$ref": "Workspace" }, "description": "All Workspaces of a GTM Container." } }, "description": "A list of workspaces in a container.", "type": "object", "id": "ListWorkspacesResponse" }, "FolderEntities": { "description": "Represents a Google Tag Manager Folder's contents.", "id": "FolderEntities", "type": "object", "properties": { "tag": { "description": "The list of tags inside the folder.", "type": "array", "items": { "$ref": "Tag" } }, "trigger": { "items": { "$ref": "Trigger" }, "type": "array", "description": "The list of triggers inside the folder." }, "nextPageToken": { "description": "Continuation token for fetching the next page of results.", "type": "string" }, "variable": { "type": "array", "items": { "$ref": "Variable" }, "description": "The list of variables inside the folder." } } }, "Trigger": { "description": "Represents a Google Tag Manager Trigger", "id": "Trigger", "type": "object", "properties": { "visiblePercentageMin": { "description": "A visibility trigger minimum percent visibility. Only valid for AMP Visibility trigger.", "$ref": "Parameter" }, "visibilitySelector": { "$ref": "Parameter", "description": "A visibility trigger CSS selector (i.e. \"#id\"). Only valid for AMP Visibility trigger." }, "name": { "description": "Trigger display name.", "type": "string" }, "filter": { "type": "array", "items": { "$ref": "Condition" }, "description": "The trigger will only fire iff all Conditions are true." }, "limit": { "description": "Limit of the number of GTM events this Timer Trigger will fire. If no limit is set, we will continue to fire GTM events until the user leaves the page. Only valid for Timer triggers.", "$ref": "Parameter" }, "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" }, "fingerprint": { "description": "The fingerprint of the GTM Trigger as computed at storage time. This value is recomputed whenever the trigger is modified.", "type": "string" }, "maxTimerLengthSeconds": { "$ref": "Parameter", "description": "Max time to fire Timer Events (in seconds). Only valid for AMP Timer trigger." }, "intervalSeconds": { "description": "Time between Timer Events to fire (in seconds). Only valid for AMP Timer trigger.", "$ref": "Parameter" }, "interval": { "description": "Time between triggering recurring Timer Events (in milliseconds). Only valid for Timer triggers.", "$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." }, "uniqueTriggerId": { "description": "Globally unique id of the trigger that auto-generates this (a Form Submit, Link Click or Timer listener) if any. Used to make incompatible auto-events work together with trigger filtering based on trigger ids. This value is populated during output generation since the tags implied by triggers don't exist until then. Only valid for Form Submit, Link Click and Timer triggers.", "$ref": "Parameter" }, "type": { "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" ], "type": "string", "description": "Defines the data layer event that causes this trigger.", "enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ] }, "totalTimeMinMilliseconds": { "description": "A visibility trigger minimum total visible time (in milliseconds). Only valid for AMP Visibility trigger.", "$ref": "Parameter" }, "eventName": { "description": "Name of the GTM event that is fired. Only valid for Timer triggers.", "$ref": "Parameter" }, "visiblePercentageMax": { "$ref": "Parameter", "description": "A visibility trigger maximum percent visibility. Only valid for AMP Visibility trigger." }, "continuousTimeMinMilliseconds": { "description": "A visibility trigger minimum continuous visible time (in milliseconds). Only valid for AMP Visibility trigger.", "$ref": "Parameter" }, "path": { "type": "string", "description": "GTM Trigger's API relative path." }, "parameter": { "description": "Additional parameters.", "type": "array", "items": { "$ref": "Parameter" } }, "selector": { "$ref": "Parameter", "description": "A click trigger CSS selector (i.e. \"a\", \"button\" etc.). Only valid for AMP Click trigger." }, "horizontalScrollPercentageList": { "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.", "$ref": "Parameter" }, "notes": { "type": "string", "description": "User notes on how to apply this trigger in the container." }, "customEventFilter": { "type": "array", "description": "Used in the case of custom event, which is fired iff all Conditions are true.", "items": { "$ref": "Condition" } }, "parentFolderId": { "description": "Parent folder id.", "type": "string" }, "workspaceId": { "description": "GTM Workspace ID.", "type": "string" }, "autoEventFilter": { "items": { "$ref": "Condition" }, "description": "Used in the case of auto event tracking.", "type": "array" }, "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" }, "tagManagerUrl": { "description": "Auto generated link to the tag manager UI", "type": "string" }, "accountId": { "type": "string", "description": "GTM Account ID." }, "containerId": { "description": "GTM Container ID.", "type": "string" }, "checkValidation": { "description": "Whether or not we should only fire tags if the form submit or link click event is not cancelled by some other event handler (e.g. because of validation). Only valid for Form Submission and Link Click triggers.", "$ref": "Parameter" } } }, "CreateBuiltInVariableResponse": { "id": "CreateBuiltInVariableResponse", "properties": { "builtInVariable": { "type": "array", "description": "List of created built-in variables.", "items": { "$ref": "BuiltInVariable" } } }, "type": "object" }, "RevertTemplateResponse": { "type": "object", "properties": { "template": { "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.", "$ref": "CustomTemplate" } }, "description": "The result of reverting a template in a workspace.", "id": "RevertTemplateResponse" }, "ListEnvironmentsResponse": { "properties": { "environment": { "description": "All Environments of a GTM Container.", "items": { "$ref": "Environment" }, "type": "array" }, "nextPageToken": { "type": "string", "description": "Continuation token for fetching the next page of results." } }, "id": "ListEnvironmentsResponse", "type": "object", "description": "List Environments Response." }, "BuiltInVariable": { "id": "BuiltInVariable", "type": "object", "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": { "containerId": { "type": "string", "description": "GTM Container ID." }, "workspaceId": { "type": "string", "description": "GTM Workspace ID." }, "name": { "type": "string", "description": "Name of the built-in variable to be used to refer to the built-in variable." }, "accountId": { "description": "GTM Account ID.", "type": "string" }, "type": { "enumDescriptions": [ "", "", "", "", "", "For web or mobile.", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "For web or mobile.", "", "For web or mobile.", "For web or mobile.", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ], "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": "Type of built-in variable.", "type": "string" }, "path": { "description": "GTM BuiltInVariable's API relative path.", "type": "string" } } }, "Transformation": { "properties": { "name": { "description": "Transformation display name.", "type": "string" }, "accountId": { "description": "GTM Account ID.", "type": "string" }, "notes": { "type": "string", "description": "User notes on how to apply this transformation in the container." }, "type": { "type": "string", "description": "Transformation type." }, "workspaceId": { "description": "GTM Workspace ID.", "type": "string" }, "parameter": { "type": "array", "description": "The transformation's parameters.", "items": { "$ref": "Parameter" } }, "path": { "description": "GTM transformation's API relative path.", "type": "string" }, "tagManagerUrl": { "description": "Auto generated link to the tag manager UI", "type": "string" }, "transformationId": { "description": "The Transformation ID uniquely identifies the GTM transformation.", "type": "string" }, "parentFolderId": { "type": "string", "description": "Parent folder id." }, "containerId": { "type": "string", "description": "GTM Container ID." }, "fingerprint": { "description": "The fingerprint of the GTM Transformation as computed at storage time. This value is recomputed whenever the transformation is modified.", "type": "string" } }, "type": "object", "id": "Transformation", "description": "Represents a Google Tag Manager Transformation." }, "CreateContainerVersionResponse": { "id": "CreateContainerVersionResponse", "properties": { "syncStatus": { "$ref": "SyncStatus", "description": "Whether version creation failed when syncing the workspace to the latest container version." }, "containerVersion": { "$ref": "ContainerVersion", "description": "The container version created." }, "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" }, "compilerError": { "type": "boolean", "description": "Compiler errors or not." } }, "type": "object", "description": "Create container versions response." }, "Zone": { "type": "object", "properties": { "name": { "description": "Zone display name.", "type": "string" }, "workspaceId": { "description": "GTM Workspace ID.", "type": "string" }, "boundary": { "$ref": "ZoneBoundary", "description": "This Zone's boundary." }, "path": { "description": "GTM Zone's API relative path.", "type": "string" }, "childContainer": { "type": "array", "items": { "$ref": "ZoneChildContainer" }, "description": "Containers that are children of this Zone." }, "accountId": { "type": "string", "description": "GTM Account ID." }, "tagManagerUrl": { "description": "Auto generated link to the tag manager UI", "type": "string" }, "fingerprint": { "type": "string", "description": "The fingerprint of the GTM Zone as computed at storage time. This value is recomputed whenever the zone is modified." }, "containerId": { "description": "GTM Container ID.", "type": "string" }, "zoneId": { "description": "The Zone ID uniquely identifies the GTM Zone.", "type": "string" }, "notes": { "description": "User notes on how to apply this zone in the container.", "type": "string" }, "typeRestriction": { "description": "This Zone's type restrictions.", "$ref": "ZoneTypeRestriction" } }, "description": "Represents a Google Tag Manager Zone's contents.", "id": "Zone" }, "QuickPreviewResponse": { "id": "QuickPreviewResponse", "description": "Response to quick previewing a workspace.", "type": "object", "properties": { "syncStatus": { "description": "Whether quick previewing failed when syncing the workspace to the latest container version.", "$ref": "SyncStatus" }, "compilerError": { "description": "Were there compiler errors or not.", "type": "boolean" }, "containerVersion": { "$ref": "ContainerVersion", "description": "The quick previewed container version." } } }, "GtagConfig": { "id": "GtagConfig", "properties": { "type": { "description": "Google tag config type.", "type": "string" }, "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." }, "containerId": { "type": "string", "description": "Google tag container ID." }, "path": { "type": "string", "description": "Google tag config's API relative path." }, "workspaceId": { "description": "Google tag workspace ID. Only used by GTM containers. Set to 0 otherwise.", "type": "string" }, "parameter": { "description": "The Google tag config's parameters.", "type": "array", "items": { "$ref": "Parameter" } }, "accountId": { "description": "Google tag account ID.", "type": "string" }, "tagManagerUrl": { "type": "string", "description": "Auto generated link to the tag manager UI" }, "gtagConfigId": { "type": "string", "description": "The ID uniquely identifies the Google tag config." } }, "type": "object", "description": "Represents a Google tag configuration." }, "Entity": { "type": "object", "description": "A workspace entity that may represent a tag, trigger, variable, or folder in addition to its status in the workspace.", "properties": { "tag": { "description": "The tag being represented by the entity.", "$ref": "Tag" }, "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." ], "enum": [ "changeStatusUnspecified", "none", "added", "deleted", "updated" ], "type": "string", "description": "Represents how the entity has been changed in the workspace." }, "customTemplate": { "$ref": "CustomTemplate", "description": "The custom template being represented by the entity." }, "builtInVariable": { "$ref": "BuiltInVariable", "description": "The built in variable being represented by the entity." }, "client": { "$ref": "Client", "description": "The client being represented by the entity." }, "variable": { "description": "The variable being represented by the entity.", "$ref": "Variable" }, "folder": { "description": "The folder being represented by the entity.", "$ref": "Folder" }, "transformation": { "description": "The transformation being represented by the entity.", "$ref": "Transformation" }, "trigger": { "$ref": "Trigger", "description": "The trigger being represented by the entity." }, "zone": { "$ref": "Zone", "description": "The zone being represented by the entity." }, "gtagConfig": { "description": "The gtag config being represented by the entity.", "$ref": "GtagConfig" } }, "id": "Entity" }, "SyncStatus": { "properties": { "mergeConflict": { "type": "boolean", "description": "Synchornization operation detected a merge conflict." }, "syncError": { "description": "An error occurred during the synchronization operation.", "type": "boolean" } }, "type": "object", "description": "The status of a workspace after synchronization.", "id": "SyncStatus" }, "ContainerFeatures": { "id": "ContainerFeatures", "properties": { "supportBuiltInVariables": { "description": "Whether this Container supports built-in variables", "type": "boolean" }, "supportWorkspaces": { "description": "Whether this Container supports workspaces.", "type": "boolean" }, "supportVariables": { "type": "boolean", "description": "Whether this Container supports variables." }, "supportTriggers": { "description": "Whether this Container supports triggers.", "type": "boolean" }, "supportTags": { "type": "boolean", "description": "Whether this Container supports tags." }, "supportTransformations": { "type": "boolean", "description": "Whether this Container supports transformations." }, "supportGtagConfigs": { "description": "Whether this Container supports Google tag config.", "type": "boolean" }, "supportTemplates": { "description": "Whether this Container supports templates.", "type": "boolean" }, "supportFolders": { "description": "Whether this Container supports folders.", "type": "boolean" }, "supportEnvironments": { "description": "Whether this Container supports environments.", "type": "boolean" }, "supportZones": { "type": "boolean", "description": "Whether this Container supports zones." }, "supportVersions": { "description": "Whether this Container supports Container versions.", "type": "boolean" }, "supportUserPermissions": { "type": "boolean", "description": "Whether this Container supports user permissions managed by GTM." }, "supportClients": { "type": "boolean", "description": "Whether this Container supports clients." } }, "type": "object" }, "SyncWorkspaceResponse": { "properties": { "syncStatus": { "$ref": "SyncStatus", "description": "Indicates whether synchronization caused a merge conflict or sync error." }, "mergeConflict": { "type": "array", "items": { "$ref": "MergeConflict" }, "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", "id": "SyncWorkspaceResponse", "description": "A response after synchronizing the workspace to the latest container version." }, "ListVariablesResponse": { "description": "List Variables Response.", "type": "object", "id": "ListVariablesResponse", "properties": { "variable": { "description": "All GTM Variables of a GTM Container.", "items": { "$ref": "Variable" }, "type": "array" }, "nextPageToken": { "description": "Continuation token for fetching the next page of results.", "type": "string" } } }, "ListClientsResponse": { "id": "ListClientsResponse", "properties": { "client": { "items": { "$ref": "Client" }, "description": "All GTM Clients of a GTM Container.", "type": "array" }, "nextPageToken": { "type": "string", "description": "Continuation token for fetching the next page of results." } }, "type": "object" }, "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" } } }, "UserPermission": { "type": "object", "properties": { "emailAddress": { "description": "User's email address.", "type": "string" }, "accountId": { "type": "string", "description": "The Account ID uniquely identifies the GTM Account." }, "containerAccess": { "type": "array", "description": "GTM Container access permissions.", "items": { "$ref": "ContainerAccess" } }, "path": { "description": "GTM UserPermission's API relative path.", "type": "string" }, "accountAccess": { "$ref": "AccountAccess", "description": "GTM Account access permissions." } }, "description": "Represents a user's permissions to an account and its container.", "id": "UserPermission" }, "CustomTemplate": { "description": "Represents a Google Tag Manager Custom Template's contents.", "id": "CustomTemplate", "properties": { "accountId": { "description": "GTM Account ID.", "type": "string" }, "tagManagerUrl": { "description": "Auto generated link to the tag manager UI", "type": "string" }, "containerId": { "type": "string", "description": "GTM Container ID." }, "fingerprint": { "type": "string", "description": "The fingerprint of the GTM Custom Template as computed at storage time. This value is recomputed whenever the template is modified." }, "name": { "type": "string", "description": "Custom Template display name." }, "galleryReference": { "description": "A reference to the Community Template Gallery entry.", "$ref": "GalleryReference" }, "templateId": { "description": "The Custom Template ID uniquely identifies the GTM custom template.", "type": "string" }, "workspaceId": { "type": "string", "description": "GTM Workspace ID." }, "templateData": { "type": "string", "description": "The custom template in text format." }, "path": { "description": "GTM Custom Template's API relative path.", "type": "string" } }, "type": "object" }, "ListContainersResponse": { "type": "object", "properties": { "container": { "description": "All Containers of a GTM Account.", "items": { "$ref": "Container" }, "type": "array" }, "nextPageToken": { "type": "string", "description": "Continuation token for fetching the next page of results." } }, "id": "ListContainersResponse", "description": "List Containers Response." }, "RevertBuiltInVariableResponse": { "description": "The result of reverting a built-in variable in a workspace.", "id": "RevertBuiltInVariableResponse", "properties": { "enabled": { "type": "boolean", "description": "Whether the built-in variable is enabled after reversion." } }, "type": "object" }, "ListGtagConfigResponse": { "properties": { "nextPageToken": { "description": "Continuation token for fetching the next page of results.", "type": "string" }, "gtagConfig": { "items": { "$ref": "GtagConfig" }, "description": "All Google tag configs in a Container.", "type": "array" } }, "id": "ListGtagConfigResponse", "type": "object" }, "Account": { "description": "Represents a Google Tag Manager Account.", "properties": { "fingerprint": { "description": "The fingerprint of the GTM Account as computed at storage time. This value is recomputed whenever the account is modified.", "type": "string" }, "name": { "type": "string", "description": "Account display name." }, "accountId": { "description": "The Account ID uniquely identifies the GTM Account.", "type": "string" }, "features": { "$ref": "AccountFeatures", "description": "Read-only Account feature set" }, "shareData": { "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.", "type": "boolean" }, "path": { "type": "string", "description": "GTM Account's API relative path." }, "tagManagerUrl": { "description": "Auto generated link to the tag manager UI", "type": "string" } }, "id": "Account", "type": "object" }, "Parameter": { "type": "object", "id": "Parameter", "description": "Represents a Google Tag Manager Parameter.", "properties": { "key": { "description": "The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.", "type": "string" }, "list": { "items": { "$ref": "Parameter" }, "description": "This list parameter's parameters (keys will be ignored).", "type": "array" }, "isWeakReference": { "type": "boolean", "description": "Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations." }, "map": { "items": { "$ref": "Parameter" }, "type": "array", "description": "This map parameter's parameters (must have keys; keys must be unique)." }, "type": { "type": "string", "description": "The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name ", "enumDescriptions": [ "", "May include variable references.", "", "", "", "", "", "" ], "enum": [ "typeUnspecified", "template", "integer", "boolean", "list", "map", "triggerReference", "tagReference" ] }, "value": { "description": "A parameter's value (may contain variable references). as appropriate to the specified type.", "type": "string" } } }, "ListTagsResponse": { "description": "List Tags Response.", "id": "ListTagsResponse", "type": "object", "properties": { "tag": { "description": "All GTM Tags of a GTM Container.", "type": "array", "items": { "$ref": "Tag" } }, "nextPageToken": { "type": "string", "description": "Continuation token for fetching the next page of results." } } }, "ZoneBoundary": { "properties": { "condition": { "description": "The conditions that, when conjoined, make up the boundary.", "type": "array", "items": { "$ref": "Condition" } }, "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" } }, "type": "object", "id": "ZoneBoundary", "description": "Represents a Zone's boundaries." }, "Folder": { "type": "object", "properties": { "path": { "type": "string", "description": "GTM Folder's API relative path." }, "name": { "description": "Folder display name.", "type": "string" }, "workspaceId": { "description": "GTM Workspace ID.", "type": "string" }, "tagManagerUrl": { "description": "Auto generated link to the tag manager UI", "type": "string" }, "folderId": { "description": "The Folder ID uniquely identifies the GTM Folder.", "type": "string" }, "notes": { "description": "User notes on how to apply this folder in the container.", "type": "string" }, "fingerprint": { "type": "string", "description": "The fingerprint of the GTM Folder as computed at storage time. This value is recomputed whenever the folder is modified." }, "containerId": { "type": "string", "description": "GTM Container ID." }, "accountId": { "type": "string", "description": "GTM Account ID." } }, "description": "Represents a Google Tag Manager Folder.", "id": "Folder" }, "Condition": { "type": "object", "id": "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. ", "items": { "$ref": "Parameter" }, "type": "array" }, "type": { "description": "The type of operator for this condition.", "type": "string", "enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "" ], "enum": [ "conditionTypeUnspecified", "equals", "contains", "startsWith", "endsWith", "matchRegex", "greater", "greaterOrEquals", "less", "lessOrEquals", "cssSelector", "urlMatches" ] } }, "description": "Represents a predicate." }, "Container": { "type": "object", "description": "Represents a Google Tag Manager Container, which specifies the platform tags will run on, manages workspaces, and retains container versions.", "properties": { "fingerprint": { "type": "string", "description": "The fingerprint of the GTM Container as computed at storage time. This value is recomputed whenever the account is modified." }, "path": { "description": "GTM Container's API relative path.", "type": "string" }, "name": { "type": "string", "description": "Container display name." }, "accountId": { "type": "string", "description": "GTM Account ID." }, "domainName": { "description": "List of domain names associated with the Container.", "items": { "type": "string" }, "type": "array" }, "usageContext": { "items": { "enum": [ "usageContextUnspecified", "web", "android", "ios", "androidSdk5", "iosSdk5", "amp", "server" ], "type": "string", "enumDescriptions": [ "", "", "", "", "", "", "", "" ] }, "description": "List of Usage Contexts for the Container. Valid values include: web, android, or ios.", "type": "array" }, "tagManagerUrl": { "description": "Auto generated link to the tag manager UI", "type": "string" }, "features": { "description": "Read-only Container feature set.", "$ref": "ContainerFeatures" }, "containerId": { "description": "The Container ID uniquely identifies the GTM Container.", "type": "string" }, "tagIds": { "type": "array", "items": { "type": "string" }, "description": "All Tag IDs that refer to this Container." }, "taggingServerUrls": { "items": { "type": "string" }, "description": "List of server-side container URLs for the Container. If multiple URLs are provided, all URL paths must match.", "type": "array" }, "notes": { "description": "Container Notes.", "type": "string" }, "publicId": { "type": "string", "description": "Container Public ID." } }, "id": "Container" }, "Client": { "type": "object", "properties": { "tagManagerUrl": { "type": "string", "description": "Auto generated link to the tag manager UI" }, "parameter": { "items": { "$ref": "Parameter" }, "description": "The client's parameters.", "type": "array" }, "priority": { "description": "Priority determines relative firing order.", "format": "int32", "type": "integer" }, "fingerprint": { "type": "string", "description": "The fingerprint of the GTM Client as computed at storage time. This value is recomputed whenever the client is modified." }, "parentFolderId": { "type": "string", "description": "Parent folder id." }, "name": { "description": "Client display name.", "type": "string" }, "notes": { "description": "User notes on how to apply this tag in the container.", "type": "string" }, "path": { "type": "string", "description": "GTM client's API relative path." }, "containerId": { "description": "GTM Container ID.", "type": "string" }, "accountId": { "type": "string", "description": "GTM Account ID." }, "clientId": { "type": "string", "description": "The Client ID uniquely identifies the GTM client." }, "workspaceId": { "description": "GTM Workspace ID.", "type": "string" }, "type": { "description": "Client type.", "type": "string" } }, "id": "Client" }, "AccountFeatures": { "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." } }, "type": "object" }, "GetContainerSnippetResponse": { "properties": { "snippet": { "description": "Tagging snippet for a Container.", "type": "string" }, "containerConfig": { "type": "string", "description": "Server container config param for manually provisioning a tagging server." } }, "id": "GetContainerSnippetResponse", "type": "object" }, "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", "id": "ListContainerVersionsResponse", "description": "List container versions response." } }, "description": "This API allows clients to access and modify container and tag configuration.", "mtlsRootUrl": "https://tagmanager.mtls.googleapis.com/", "canonicalName": "Tag Manager", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "ownerName": "Google", "servicePath": "", "name": "tagmanager", "title": "Tag Manager API", "baseUrl": "https://tagmanager.googleapis.com/", "batchPath": "batch", "resources": { "accounts": { "methods": { "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}", "response": { "$ref": "Account" }, "description": "Gets a GTM Account.", "parameterOrder": [ "path" ], "parameters": { "path": { "pattern": "^accounts/[^/]+$", "description": "GTM Account's API relative path.", "required": true, "location": "path", "type": "string" } }, "flatPath": "tagmanager/v2/accounts/{accountsId}", "httpMethod": "GET", "id": "tagmanager.accounts.get" }, "update": { "path": "tagmanager/v2/{+path}", "description": "Updates a GTM Account.", "httpMethod": "PUT", "id": "tagmanager.accounts.update", "flatPath": "tagmanager/v2/accounts/{accountsId}", "request": { "$ref": "Account" }, "parameterOrder": [ "path" ], "parameters": { "path": { "type": "string", "description": "GTM Account's API relative path.", "location": "path", "required": true, "pattern": "^accounts/[^/]+$" }, "fingerprint": { "type": "string", "description": "When provided, this fingerprint must match the fingerprint of the account in storage.", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.manage.accounts" ], "response": { "$ref": "Account" } }, "list": { "description": "Lists all GTM Accounts that a user has access to.", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.manage.accounts", "https://www.googleapis.com/auth/tagmanager.readonly" ], "parameters": { "includeGoogleTags": { "location": "query", "type": "boolean", "description": "Also retrieve accounts associated with Google Tag when true." }, "pageToken": { "type": "string", "description": "Continuation token for fetching the next page of results.", "location": "query" } }, "flatPath": "tagmanager/v2/accounts", "httpMethod": "GET", "path": "tagmanager/v2/accounts", "parameterOrder": [], "response": { "$ref": "ListAccountsResponse" }, "id": "tagmanager.accounts.list" } }, "resources": { "containers": { "methods": { "get": { "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "parameters": { "path": { "type": "string", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+$", "description": "GTM Container's API relative path.", "required": true } }, "description": "Gets a Container.", "id": "tagmanager.accounts.containers.get", "parameterOrder": [ "path" ], "response": { "$ref": "Container" }, "httpMethod": "GET", "path": "tagmanager/v2/{+path}", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}" }, "update": { "parameters": { "path": { "location": "path", "description": "GTM Container's API relative path.", "type": "string", "pattern": "^accounts/[^/]+/containers/[^/]+$", "required": true }, "fingerprint": { "location": "query", "description": "When provided, this fingerprint must match the fingerprint of the container in storage.", "type": "string" } }, "request": { "$ref": "Container" }, "path": "tagmanager/v2/{+path}", "response": { "$ref": "Container" }, "httpMethod": "PUT", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}", "description": "Updates a Container.", "parameterOrder": [ "path" ], "id": "tagmanager.accounts.containers.update" }, "lookup": { "parameters": { "destinationId": { "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.", "type": "string" }, "tagId": { "type": "string", "location": "query", "description": "Tag ID for a GTM Container, e.g. GTM-123456789. Only one of destination_id or tag_id should be set." } }, "id": "tagmanager.accounts.containers.lookup", "httpMethod": "GET", "response": { "$ref": "Container" }, "parameterOrder": [], "description": "Looks up a Container by destination ID or tag ID.", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "path": "tagmanager/v2/accounts/containers:lookup", "flatPath": "tagmanager/v2/accounts/containers:lookup" }, "list": { "id": "tagmanager.accounts.containers.list", "parameters": { "parent": { "required": true, "description": "GTM Account's API relative path.", "pattern": "^accounts/[^/]+$", "location": "path", "type": "string" }, "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" ], "path": "tagmanager/v2/{+parent}/containers", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers", "response": { "$ref": "ListContainersResponse" }, "httpMethod": "GET", "parameterOrder": [ "parent" ], "description": "Lists all Containers that belongs to a GTM Account." }, "move_tag_id": { "response": { "$ref": "Container" }, "parameterOrder": [ "path" ], "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}:move_tag_id", "parameters": { "copyUsers": { "type": "boolean", "description": "Whether or not to copy users from this tag to the new tag.", "location": "query" }, "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" }, "copySettings": { "location": "query", "type": "boolean", "description": "Whether or not to copy tag settings from this tag to the new tag." }, "tagId": { "location": "query", "type": "string", "description": "Tag ID to be removed from the current Container." }, "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.", "location": "query", "type": "boolean" }, "tagName": { "location": "query", "type": "string", "description": "The name for the newly created tag." }, "path": { "location": "path", "type": "string", "description": "GTM Container's API relative path.", "required": true, "pattern": "^accounts/[^/]+/containers/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "id": "tagmanager.accounts.containers.move_tag_id", "path": "tagmanager/v2/{+path}:move_tag_id", "deprecated": true, "httpMethod": "POST", "description": "Move Tag ID out of a Container." }, "combine": { "id": "tagmanager.accounts.containers.combine", "parameterOrder": [ "path" ], "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}:combine", "deprecated": true, "response": { "$ref": "Container" }, "httpMethod": "POST", "path": "tagmanager/v2/{+path}:combine", "parameters": { "containerId": { "location": "query", "description": "ID of container that will be merged into the current container.", "type": "string" }, "settingSource": { "type": "string", "location": "query", "enumDescriptions": [ "", "Keep the current container config setting after combine", "Use config setting from the other tag after combine" ], "enum": [ "settingSourceUnspecified", "current", "other" ], "description": "Specify the source of config setting after combine" }, "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.", "location": "query", "type": "boolean" }, "path": { "location": "path", "description": "GTM Container's API relative path.", "type": "string", "pattern": "^accounts/[^/]+/containers/[^/]+$", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "description": "Combines Containers." }, "snippet": { "parameterOrder": [ "path" ], "parameters": { "path": { "type": "string", "description": "Container snippet's API relative path.", "required": true, "pattern": "^accounts/[^/]+/containers/[^/]+$", "location": "path" } }, "description": "Gets the tagging snippet for a Container.", "path": "tagmanager/v2/{+path}:snippet", "id": "tagmanager.accounts.containers.snippet", "response": { "$ref": "GetContainerSnippetResponse" }, "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}:snippet" }, "delete": { "scopes": [ "https://www.googleapis.com/auth/tagmanager.delete.containers" ], "parameterOrder": [ "path" ], "path": "tagmanager/v2/{+path}", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}", "httpMethod": "DELETE", "description": "Deletes a Container.", "parameters": { "path": { "pattern": "^accounts/[^/]+/containers/[^/]+$", "type": "string", "required": true, "description": "GTM Container's API relative path.", "location": "path" } }, "id": "tagmanager.accounts.containers.delete" }, "create": { "parameterOrder": [ "parent" ], "description": "Creates a Container.", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "parameters": { "parent": { "required": true, "location": "path", "type": "string", "description": "GTM Account's API relative path.", "pattern": "^accounts/[^/]+$" } }, "response": { "$ref": "Container" }, "path": "tagmanager/v2/{+parent}/containers", "httpMethod": "POST", "id": "tagmanager.accounts.containers.create", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers", "request": { "$ref": "Container" } } }, "resources": { "version_headers": { "methods": { "list": { "parameterOrder": [ "parent" ], "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/version_headers", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.edit.containerversions", "https://www.googleapis.com/auth/tagmanager.readonly" ], "response": { "$ref": "ListContainerVersionsResponse" }, "description": "Lists all Container Versions of a GTM Container.", "id": "tagmanager.accounts.containers.version_headers.list", "path": "tagmanager/v2/{+parent}/version_headers", "parameters": { "pageToken": { "description": "Continuation token for fetching the next page of results.", "location": "query", "type": "string" }, "includeDeleted": { "type": "boolean", "location": "query", "description": "Also retrieve deleted (archived) versions when true." }, "parent": { "type": "string", "required": true, "pattern": "^accounts/[^/]+/containers/[^/]+$", "location": "path", "description": "GTM Container's API relative path." } } }, "latest": { "response": { "$ref": "ContainerVersionHeader" }, "parameters": { "parent": { "pattern": "^accounts/[^/]+/containers/[^/]+$", "description": "GTM Container's API relative path.", "required": true, "type": "string", "location": "path" } }, "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/version_headers:latest", "id": "tagmanager.accounts.containers.version_headers.latest", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "httpMethod": "GET", "description": "Gets the latest container version header", "path": "tagmanager/v2/{+parent}/version_headers:latest", "parameterOrder": [ "parent" ] } } }, "environments": { "methods": { "list": { "parameterOrder": [ "parent" ], "response": { "$ref": "ListEnvironmentsResponse" }, "httpMethod": "GET", "id": "tagmanager.accounts.containers.environments.list", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/environments", "description": "Lists all GTM Environments of a GTM Container.", "parameters": { "pageToken": { "description": "Continuation token for fetching the next page of results.", "location": "query", "type": "string" }, "parent": { "description": "GTM Container's API relative path.", "type": "string", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+$", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "path": "tagmanager/v2/{+parent}/environments" }, "reauthorize": { "response": { "$ref": "Environment" }, "parameterOrder": [ "path" ], "id": "tagmanager.accounts.containers.environments.reauthorize", "path": "tagmanager/v2/{+path}:reauthorize", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/environments/{environmentsId}:reauthorize", "parameters": { "path": { "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/environments/[^/]+$", "type": "string", "description": "GTM Environment's API relative path.", "required": true } }, "description": "Re-generates the authorization code for a GTM Environment.", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/tagmanager.publish" ], "request": { "$ref": "Environment" } }, "create": { "request": { "$ref": "Environment" }, "description": "Creates a GTM Environment.", "path": "tagmanager/v2/{+parent}/environments", "httpMethod": "POST", "parameterOrder": [ "parent" ], "id": "tagmanager.accounts.containers.environments.create", "parameters": { "parent": { "pattern": "^accounts/[^/]+/containers/[^/]+$", "description": "GTM Container's API relative path.", "location": "path", "type": "string", "required": true } }, "response": { "$ref": "Environment" }, "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/environments", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ] }, "get": { "parameters": { "path": { "pattern": "^accounts/[^/]+/containers/[^/]+/environments/[^/]+$", "location": "path", "required": true, "type": "string", "description": "GTM Environment's API relative path." } }, "response": { "$ref": "Environment" }, "description": "Gets a GTM Environment.", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/environments/{environmentsId}", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "id": "tagmanager.accounts.containers.environments.get", "path": "tagmanager/v2/{+path}", "httpMethod": "GET", "parameterOrder": [ "path" ] }, "update": { "response": { "$ref": "Environment" }, "parameters": { "path": { "required": true, "pattern": "^accounts/[^/]+/containers/[^/]+/environments/[^/]+$", "description": "GTM Environment's API relative path.", "location": "path", "type": "string" }, "fingerprint": { "location": "query", "type": "string", "description": "When provided, this fingerprint must match the fingerprint of the environment in storage." } }, "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/environments/{environmentsId}", "parameterOrder": [ "path" ], "id": "tagmanager.accounts.containers.environments.update", "description": "Updates a GTM Environment.", "httpMethod": "PUT", "path": "tagmanager/v2/{+path}", "request": { "$ref": "Environment" }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ] }, "delete": { "path": "tagmanager/v2/{+path}", "description": "Deletes a GTM Environment.", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/environments/{environmentsId}", "parameters": { "path": { "location": "path", "description": "GTM Environment's API relative path.", "required": true, "pattern": "^accounts/[^/]+/containers/[^/]+/environments/[^/]+$", "type": "string" } }, "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "parameterOrder": [ "path" ], "id": "tagmanager.accounts.containers.environments.delete" } } }, "workspaces": { "resources": { "clients": { "methods": { "get": { "response": { "$ref": "Client" }, "httpMethod": "GET", "path": "tagmanager/v2/{+path}", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/clients/{clientsId}", "id": "tagmanager.accounts.containers.workspaces.clients.get", "description": "Gets a GTM Client.", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "parameters": { "path": { "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/clients/[^/]+$", "description": "GTM Client's API relative path.", "required": true, "type": "string", "location": "path" } }, "parameterOrder": [ "path" ] }, "list": { "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}/clients", "parameters": { "pageToken": { "type": "string", "description": "Continuation token for fetching the next page of results.", "location": "query" }, "parent": { "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "type": "string", "required": true, "description": "GTM Workspace's API relative path." } }, "path": "tagmanager/v2/{+parent}/clients", "response": { "$ref": "ListClientsResponse" }, "description": "Lists all GTM Clients of a GTM container workspace.", "parameterOrder": [ "parent" ], "id": "tagmanager.accounts.containers.workspaces.clients.list", "httpMethod": "GET" }, "create": { "description": "Creates a GTM Client.", "response": { "$ref": "Client" }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "httpMethod": "POST", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/clients", "parameterOrder": [ "parent" ], "request": { "$ref": "Client" }, "id": "tagmanager.accounts.containers.workspaces.clients.create", "path": "tagmanager/v2/{+parent}/clients", "parameters": { "parent": { "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "type": "string", "description": "GTM Workspace's API relative path.", "required": true, "location": "path" } } }, "revert": { "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/clients/{clientsId}:revert", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "parameters": { "path": { "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/clients/[^/]+$", "type": "string", "required": true, "description": "GTM Client's API relative path." }, "fingerprint": { "location": "query", "description": "When provided, this fingerprint must match the fingerprint of the client in storage.", "type": "string" } }, "response": { "$ref": "RevertClientResponse" }, "path": "tagmanager/v2/{+path}:revert", "description": "Reverts changes to a GTM Client in a GTM Workspace.", "parameterOrder": [ "path" ], "httpMethod": "POST", "id": "tagmanager.accounts.containers.workspaces.clients.revert" }, "update": { "path": "tagmanager/v2/{+path}", "parameters": { "fingerprint": { "type": "string", "location": "query", "description": "When provided, this fingerprint must match the fingerprint of the client in storage." }, "path": { "location": "path", "type": "string", "required": true, "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/clients/[^/]+$", "description": "GTM Client's API relative path." } }, "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/clients/{clientsId}", "request": { "$ref": "Client" }, "description": "Updates a GTM Client.", "id": "tagmanager.accounts.containers.workspaces.clients.update", "response": { "$ref": "Client" }, "parameterOrder": [ "path" ], "httpMethod": "PUT", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ] }, "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" ], "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "parameters": { "path": { "required": true, "type": "string", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/clients/[^/]+$", "description": "GTM Client's API relative path.", "location": "path" } }, "description": "Deletes a GTM Client." } } }, "triggers": { "methods": { "get": { "response": { "$ref": "Trigger" }, "id": "tagmanager.accounts.containers.workspaces.triggers.get", "path": "tagmanager/v2/{+path}", "httpMethod": "GET", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/triggers/{triggersId}", "parameterOrder": [ "path" ], "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "description": "Gets a GTM Trigger.", "parameters": { "path": { "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/triggers/[^/]+$", "required": true, "type": "string", "description": "GTM Trigger's API relative path." } } }, "update": { "id": "tagmanager.accounts.containers.workspaces.triggers.update", "httpMethod": "PUT", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/triggers/{triggersId}", "request": { "$ref": "Trigger" }, "parameters": { "path": { "description": "GTM Trigger's API relative path.", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/triggers/[^/]+$", "type": "string", "required": true, "location": "path" }, "fingerprint": { "description": "When provided, this fingerprint must match the fingerprint of the trigger in storage.", "type": "string", "location": "query" } }, "path": "tagmanager/v2/{+path}", "response": { "$ref": "Trigger" }, "parameterOrder": [ "path" ], "description": "Updates a GTM Trigger." }, "delete": { "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/triggers/{triggersId}", "path": "tagmanager/v2/{+path}", "id": "tagmanager.accounts.containers.workspaces.triggers.delete", "httpMethod": "DELETE", "parameterOrder": [ "path" ], "parameters": { "path": { "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/triggers/[^/]+$", "required": true, "type": "string", "description": "GTM Trigger's API relative path." } }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "description": "Deletes a GTM Trigger." }, "list": { "id": "tagmanager.accounts.containers.workspaces.triggers.list", "description": "Lists all GTM Triggers of a Container.", "parameterOrder": [ "parent" ], "httpMethod": "GET", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/triggers", "parameters": { "pageToken": { "description": "Continuation token for fetching the next page of results.", "location": "query", "type": "string" }, "parent": { "required": true, "description": "GTM Workspace's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "type": "string" } }, "response": { "$ref": "ListTriggersResponse" }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "path": "tagmanager/v2/{+parent}/triggers" }, "create": { "parameters": { "parent": { "required": true, "type": "string", "description": "GTM Workspace's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$" } }, "id": "tagmanager.accounts.containers.workspaces.triggers.create", "request": { "$ref": "Trigger" }, "path": "tagmanager/v2/{+parent}/triggers", "parameterOrder": [ "parent" ], "response": { "$ref": "Trigger" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/triggers", "description": "Creates a GTM Trigger." }, "revert": { "parameters": { "path": { "type": "string", "required": true, "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/triggers/[^/]+$", "description": "GTM Trigger's API relative path.", "location": "path" }, "fingerprint": { "type": "string", "location": "query", "description": "When provided, this fingerprint must match the fingerprint of the trigger in storage." } }, "description": "Reverts changes to a GTM Trigger in a GTM Workspace.", "parameterOrder": [ "path" ], "path": "tagmanager/v2/{+path}:revert", "response": { "$ref": "RevertTriggerResponse" }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "httpMethod": "POST", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/triggers/{triggersId}:revert", "id": "tagmanager.accounts.containers.workspaces.triggers.revert" } } }, "gtag_config": { "methods": { "get": { "description": "Gets a Google tag config.", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/gtag_config/{gtag_configId}", "httpMethod": "GET", "response": { "$ref": "GtagConfig" }, "parameterOrder": [ "path" ], "path": "tagmanager/v2/{+path}", "parameters": { "path": { "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/gtag_config/[^/]+$", "type": "string", "required": true, "description": "Google tag config's API relative path.", "location": "path" } }, "id": "tagmanager.accounts.containers.workspaces.gtag_config.get", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ] }, "list": { "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "parameters": { "parent": { "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "location": "path", "description": "Workspace's API relative path.", "type": "string", "required": true }, "pageToken": { "location": "query", "type": "string", "description": "Continuation token for fetching the next page of results." } }, "parameterOrder": [ "parent" ], "id": "tagmanager.accounts.containers.workspaces.gtag_config.list", "description": "Lists all Google tag configs in a Container.", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/gtag_config", "httpMethod": "GET", "path": "tagmanager/v2/{+parent}/gtag_config", "response": { "$ref": "ListGtagConfigResponse" } }, "update": { "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "response": { "$ref": "GtagConfig" }, "description": "Updates a Google tag config.", "id": "tagmanager.accounts.containers.workspaces.gtag_config.update", "httpMethod": "PUT", "parameterOrder": [ "path" ], "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/gtag_config/{gtag_configId}", "parameters": { "fingerprint": { "location": "query", "type": "string", "description": "When provided, this fingerprint must match the fingerprint of the config in storage." }, "path": { "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/gtag_config/[^/]+$", "description": "Google tag config's API relative path.", "required": true, "type": "string" } }, "request": { "$ref": "GtagConfig" }, "path": "tagmanager/v2/{+path}" }, "delete": { "parameters": { "path": { "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/gtag_config/[^/]+$", "description": "Google tag config's API relative path.", "required": true, "type": "string", "location": "path" } }, "parameterOrder": [ "path" ], "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/gtag_config/{gtag_configId}", "description": "Deletes a Google tag config.", "path": "tagmanager/v2/{+path}", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "id": "tagmanager.accounts.containers.workspaces.gtag_config.delete", "httpMethod": "DELETE" }, "create": { "path": "tagmanager/v2/{+parent}/gtag_config", "httpMethod": "POST", "parameterOrder": [ "parent" ], "id": "tagmanager.accounts.containers.workspaces.gtag_config.create", "description": "Creates a Google tag config.", "request": { "$ref": "GtagConfig" }, "response": { "$ref": "GtagConfig" }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "parameters": { "parent": { "required": true, "type": "string", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "location": "path", "description": "Workspace's API relative path." } }, "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/gtag_config" } } }, "built_in_variables": { "methods": { "list": { "id": "tagmanager.accounts.containers.workspaces.built_in_variables.list", "parameterOrder": [ "parent" ], "parameters": { "pageToken": { "location": "query", "description": "Continuation token for fetching the next page of results.", "type": "string" }, "parent": { "required": true, "type": "string", "description": "GTM Workspace's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$" } }, "path": "tagmanager/v2/{+parent}/built_in_variables", "description": "Lists all the enabled Built-In Variables of a GTM Container.", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/built_in_variables", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "httpMethod": "GET", "response": { "$ref": "ListEnabledBuiltInVariablesResponse" } }, "create": { "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/built_in_variables", "parameterOrder": [ "parent" ], "parameters": { "type": { "description": "The types of built-in variables to enable.", "location": "query", "repeated": true, "enumDescriptions": [ "", "", "", "", "", "For web or mobile.", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "For web or mobile.", "", "For web or mobile.", "For web or mobile.", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ], "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" ] }, "parent": { "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "type": "string", "required": true, "description": "GTM Workspace's API relative path.", "location": "path" } }, "response": { "$ref": "CreateBuiltInVariableResponse" }, "id": "tagmanager.accounts.containers.workspaces.built_in_variables.create", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "httpMethod": "POST", "path": "tagmanager/v2/{+parent}/built_in_variables", "description": "Creates one or more GTM Built-In Variables." }, "delete": { "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/built_in_variables", "description": "Deletes one or more GTM Built-In Variables.", "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "path": "tagmanager/v2/{+path}", "parameterOrder": [ "path" ], "id": "tagmanager.accounts.containers.workspaces.built_in_variables.delete", "parameters": { "path": { "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/built_in_variables$", "location": "path", "description": "GTM BuiltInVariable's API relative path.", "type": "string", "required": true }, "type": { "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.", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ], "type": "string", "description": "The types of built-in variables to delete.", "location": "query", "repeated": true } } }, "revert": { "id": "tagmanager.accounts.containers.workspaces.built_in_variables.revert", "httpMethod": "POST", "description": "Reverts changes to a GTM Built-In Variables in a GTM Workspace.", "parameterOrder": [ "path" ], "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "response": { "$ref": "RevertBuiltInVariableResponse" }, "path": "tagmanager/v2/{+path}/built_in_variables:revert", "parameters": { "type": { "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 type of built-in variable to revert.", "enumDescriptions": [ "", "", "", "", "", "For web or mobile.", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "For web or mobile.", "", "For web or mobile.", "For web or mobile.", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ], "type": "string", "location": "query" }, "path": { "location": "path", "type": "string", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "description": "GTM BuiltInVariable's API relative path.", "required": true } }, "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/built_in_variables:revert" } } }, "zones": { "methods": { "create": { "id": "tagmanager.accounts.containers.workspaces.zones.create", "parameterOrder": [ "parent" ], "request": { "$ref": "Zone" }, "httpMethod": "POST", "description": "Creates a GTM Zone.", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "parameters": { "parent": { "location": "path", "description": "GTM Workspace's API relative path.", "type": "string", "required": true, "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$" } }, "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/zones", "path": "tagmanager/v2/{+parent}/zones", "response": { "$ref": "Zone" } }, "revert": { "parameterOrder": [ "path" ], "response": { "$ref": "RevertZoneResponse" }, "description": "Reverts changes to a GTM Zone in a GTM Workspace.", "httpMethod": "POST", "path": "tagmanager/v2/{+path}:revert", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/zones/{zonesId}:revert", "parameters": { "fingerprint": { "type": "string", "location": "query", "description": "When provided, this fingerprint must match the fingerprint of the zone in storage." }, "path": { "description": "GTM Zone's API relative path.", "type": "string", "required": true, "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/zones/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "id": "tagmanager.accounts.containers.workspaces.zones.revert" }, "get": { "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "parameterOrder": [ "path" ], "response": { "$ref": "Zone" }, "description": "Gets a GTM Zone.", "parameters": { "path": { "required": true, "description": "GTM Zone's API relative path.", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/zones/[^/]+$", "type": "string", "location": "path" } }, "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/zones/{zonesId}", "httpMethod": "GET", "path": "tagmanager/v2/{+path}", "id": "tagmanager.accounts.containers.workspaces.zones.get" }, "list": { "response": { "$ref": "ListZonesResponse" }, "parameters": { "pageToken": { "description": "Continuation token for fetching the next page of results.", "type": "string", "location": "query" }, "parent": { "type": "string", "location": "path", "description": "GTM Workspace's API relative path.", "required": true, "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$" } }, "description": "Lists all GTM Zones of a GTM container workspace.", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/zones", "id": "tagmanager.accounts.containers.workspaces.zones.list", "parameterOrder": [ "parent" ], "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "path": "tagmanager/v2/{+parent}/zones" }, "delete": { "parameters": { "path": { "required": true, "type": "string", "location": "path", "description": "GTM Zone's API relative path.", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/zones/[^/]+$" } }, "description": "Deletes a GTM Zone.", "path": "tagmanager/v2/{+path}", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/zones/{zonesId}", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "httpMethod": "DELETE", "id": "tagmanager.accounts.containers.workspaces.zones.delete", "parameterOrder": [ "path" ] }, "update": { "path": "tagmanager/v2/{+path}", "id": "tagmanager.accounts.containers.workspaces.zones.update", "request": { "$ref": "Zone" }, "description": "Updates a GTM Zone.", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "parameters": { "path": { "description": "GTM Zone's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/zones/[^/]+$", "type": "string", "required": true }, "fingerprint": { "location": "query", "description": "When provided, this fingerprint must match the fingerprint of the zone in storage.", "type": "string" } }, "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/zones/{zonesId}", "httpMethod": "PUT", "parameterOrder": [ "path" ], "response": { "$ref": "Zone" } } } }, "variables": { "methods": { "get": { "httpMethod": "GET", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/variables/{variablesId}", "parameterOrder": [ "path" ], "id": "tagmanager.accounts.containers.workspaces.variables.get", "response": { "$ref": "Variable" }, "path": "tagmanager/v2/{+path}", "description": "Gets a GTM Variable.", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "parameters": { "path": { "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/variables/[^/]+$", "type": "string", "location": "path", "description": "GTM Variable's API relative path.", "required": true } } }, "update": { "parameters": { "fingerprint": { "location": "query", "type": "string", "description": "When provided, this fingerprint must match the fingerprint of the variable in storage." }, "path": { "type": "string", "required": true, "description": "GTM Variable's API relative path.", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/variables/[^/]+$", "location": "path" } }, "parameterOrder": [ "path" ], "description": "Updates a GTM Variable.", "request": { "$ref": "Variable" }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "path": "tagmanager/v2/{+path}", "response": { "$ref": "Variable" }, "httpMethod": "PUT", "id": "tagmanager.accounts.containers.workspaces.variables.update", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/variables/{variablesId}" }, "delete": { "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "id": "tagmanager.accounts.containers.workspaces.variables.delete", "parameters": { "path": { "location": "path", "required": true, "type": "string", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/variables/[^/]+$", "description": "GTM Variable's API relative path." } }, "description": "Deletes a GTM Variable.", "httpMethod": "DELETE", "parameterOrder": [ "path" ], "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/variables/{variablesId}", "path": "tagmanager/v2/{+path}" }, "list": { "httpMethod": "GET", "description": "Lists all GTM Variables of a Container.", "parameterOrder": [ "parent" ], "response": { "$ref": "ListVariablesResponse" }, "id": "tagmanager.accounts.containers.workspaces.variables.list", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "path": "tagmanager/v2/{+parent}/variables", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/variables", "parameters": { "pageToken": { "location": "query", "description": "Continuation token for fetching the next page of results.", "type": "string" }, "parent": { "location": "path", "type": "string", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "description": "GTM Workspace's API relative path.", "required": true } } }, "create": { "parameters": { "parent": { "required": true, "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "description": "GTM Workspace's API relative path.", "type": "string", "location": "path" } }, "request": { "$ref": "Variable" }, "path": "tagmanager/v2/{+parent}/variables", "id": "tagmanager.accounts.containers.workspaces.variables.create", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "response": { "$ref": "Variable" }, "httpMethod": "POST", "description": "Creates a GTM Variable.", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/variables", "parameterOrder": [ "parent" ] }, "revert": { "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/variables/{variablesId}:revert", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "description": "Reverts changes to a GTM Variable in a GTM Workspace.", "response": { "$ref": "RevertVariableResponse" }, "parameterOrder": [ "path" ], "httpMethod": "POST", "parameters": { "fingerprint": { "type": "string", "description": "When provided, this fingerprint must match the fingerprint of the variable in storage.", "location": "query" }, "path": { "type": "string", "required": true, "description": "GTM Variable's API relative path.", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/variables/[^/]+$", "location": "path" } }, "id": "tagmanager.accounts.containers.workspaces.variables.revert", "path": "tagmanager/v2/{+path}:revert" } } }, "templates": { "methods": { "create": { "description": "Creates a GTM Custom Template.", "parameters": { "parent": { "type": "string", "required": true, "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "description": "GTM Workspace's API relative path.", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "response": { "$ref": "CustomTemplate" }, "id": "tagmanager.accounts.containers.workspaces.templates.create", "parameterOrder": [ "parent" ], "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/templates", "httpMethod": "POST", "path": "tagmanager/v2/{+parent}/templates", "request": { "$ref": "CustomTemplate" } }, "revert": { "httpMethod": "POST", "parameterOrder": [ "path" ], "path": "tagmanager/v2/{+path}:revert", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/templates/{templatesId}:revert", "parameters": { "path": { "description": "GTM Custom Template's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/templates/[^/]+$", "type": "string", "required": true }, "fingerprint": { "location": "query", "description": "When provided, this fingerprint must match the fingerprint of the template in storage.", "type": "string" } }, "description": "Reverts changes to a GTM Template in a GTM Workspace.", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "response": { "$ref": "RevertTemplateResponse" }, "id": "tagmanager.accounts.containers.workspaces.templates.revert" }, "get": { "description": "Gets a GTM Template.", "httpMethod": "GET", "response": { "$ref": "CustomTemplate" }, "path": "tagmanager/v2/{+path}", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/templates/{templatesId}", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "id": "tagmanager.accounts.containers.workspaces.templates.get", "parameters": { "path": { "required": true, "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/templates/[^/]+$", "location": "path", "type": "string", "description": "GTM Custom Template's API relative path." } }, "parameterOrder": [ "path" ] }, "list": { "httpMethod": "GET", "description": "Lists all GTM Templates of a GTM container workspace.", "path": "tagmanager/v2/{+parent}/templates", "id": "tagmanager.accounts.containers.workspaces.templates.list", "response": { "$ref": "ListTemplatesResponse" }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "parameterOrder": [ "parent" ], "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/templates", "parameters": { "parent": { "location": "path", "type": "string", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "description": "GTM Workspace's API relative path.", "required": true }, "pageToken": { "type": "string", "description": "Continuation token for fetching the next page of results.", "location": "query" } } }, "update": { "parameters": { "path": { "type": "string", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/templates/[^/]+$", "required": true, "description": "GTM Custom Template's API relative path.", "location": "path" }, "fingerprint": { "location": "query", "description": "When provided, this fingerprint must match the fingerprint of the templates in storage.", "type": "string" } }, "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/templates/{templatesId}", "request": { "$ref": "CustomTemplate" }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "response": { "$ref": "CustomTemplate" }, "id": "tagmanager.accounts.containers.workspaces.templates.update", "description": "Updates a GTM Template.", "path": "tagmanager/v2/{+path}", "parameterOrder": [ "path" ], "httpMethod": "PUT" }, "delete": { "description": "Deletes a GTM Template.", "httpMethod": "DELETE", "path": "tagmanager/v2/{+path}", "id": "tagmanager.accounts.containers.workspaces.templates.delete", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "parameters": { "path": { "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/templates/[^/]+$", "type": "string", "description": "GTM Custom Template's API relative path.", "location": "path", "required": true } }, "parameterOrder": [ "path" ], "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/templates/{templatesId}" }, "import_from_gallery": { "httpMethod": "POST", "parameters": { "gallerySha": { "location": "query", "description": "SHA version of the Gallery template to import. Defaulted to the latest SHA version if not provided.", "type": "string" }, "galleryRepository": { "type": "string", "location": "query", "description": "Repository of the Gallery template to import" }, "galleryOwner": { "location": "query", "type": "string", "description": "Owner of the Gallery template to import" }, "parent": { "required": true, "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "location": "path", "type": "string", "description": "GTM Workspace's API relative path." }, "acknowledgePermissions": { "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", "type": "boolean" } }, "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/templates:import_from_gallery", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "description": "Imports a GTM Custom Template from Gallery.", "path": "tagmanager/v2/{+parent}/templates:import_from_gallery", "response": { "$ref": "CustomTemplate" }, "id": "tagmanager.accounts.containers.workspaces.templates.import_from_gallery", "parameterOrder": [ "parent" ] } } }, "tags": { "methods": { "get": { "path": "tagmanager/v2/{+path}", "parameters": { "path": { "description": "GTM Tag's API relative path.", "location": "path", "required": true, "type": "string", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/tags/[^/]+$" } }, "description": "Gets a GTM Tag.", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/tags/{tagsId}", "id": "tagmanager.accounts.containers.workspaces.tags.get", "response": { "$ref": "Tag" }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "parameterOrder": [ "path" ], "httpMethod": "GET" }, "delete": { "description": "Deletes a GTM Tag.", "path": "tagmanager/v2/{+path}", "id": "tagmanager.accounts.containers.workspaces.tags.delete", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/tags/{tagsId}", "httpMethod": "DELETE", "parameterOrder": [ "path" ], "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "parameters": { "path": { "description": "GTM Tag's API relative path.", "type": "string", "required": true, "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/tags/[^/]+$" } } }, "update": { "parameters": { "path": { "type": "string", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/tags/[^/]+$", "required": true, "description": "GTM Tag's API relative path." }, "fingerprint": { "location": "query", "description": "When provided, this fingerprint must match the fingerprint of the tag in storage.", "type": "string" } }, "id": "tagmanager.accounts.containers.workspaces.tags.update", "description": "Updates a GTM Tag.", "path": "tagmanager/v2/{+path}", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "response": { "$ref": "Tag" }, "parameterOrder": [ "path" ], "request": { "$ref": "Tag" }, "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/tags/{tagsId}", "httpMethod": "PUT" }, "create": { "description": "Creates a GTM Tag.", "httpMethod": "POST", "id": "tagmanager.accounts.containers.workspaces.tags.create", "path": "tagmanager/v2/{+parent}/tags", "parameterOrder": [ "parent" ], "request": { "$ref": "Tag" }, "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/tags", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "response": { "$ref": "Tag" }, "parameters": { "parent": { "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "location": "path", "required": true, "type": "string", "description": "GTM Workspace's API relative path." } } }, "revert": { "parameterOrder": [ "path" ], "parameters": { "path": { "description": "GTM Tag's API relative path.", "required": true, "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/tags/[^/]+$", "type": "string", "location": "path" }, "fingerprint": { "location": "query", "description": "When provided, this fingerprint must match the fingerprint of thetag in storage.", "type": "string" } }, "response": { "$ref": "RevertTagResponse" }, "path": "tagmanager/v2/{+path}:revert", "description": "Reverts changes to a GTM Tag in a GTM Workspace.", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "id": "tagmanager.accounts.containers.workspaces.tags.revert", "httpMethod": "POST", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/tags/{tagsId}:revert" }, "list": { "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "response": { "$ref": "ListTagsResponse" }, "parameters": { "pageToken": { "location": "query", "type": "string", "description": "Continuation token for fetching the next page of results." }, "parent": { "location": "path", "description": "GTM Workspace's API relative path.", "required": true, "type": "string", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$" } }, "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/tags", "path": "tagmanager/v2/{+parent}/tags", "description": "Lists all GTM Tags of a Container.", "id": "tagmanager.accounts.containers.workspaces.tags.list", "httpMethod": "GET", "parameterOrder": [ "parent" ] } } }, "transformations": { "methods": { "delete": { "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/transformations/{transformationsId}", "parameterOrder": [ "path" ], "path": "tagmanager/v2/{+path}", "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "description": "Deletes a GTM Transformation.", "parameters": { "path": { "required": true, "description": "GTM Transformation's API relative path.", "location": "path", "type": "string", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/transformations/[^/]+$" } }, "id": "tagmanager.accounts.containers.workspaces.transformations.delete" }, "update": { "request": { "$ref": "Transformation" }, "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/transformations/{transformationsId}", "parameterOrder": [ "path" ], "response": { "$ref": "Transformation" }, "path": "tagmanager/v2/{+path}", "id": "tagmanager.accounts.containers.workspaces.transformations.update", "parameters": { "fingerprint": { "type": "string", "location": "query", "description": "When provided, this fingerprint must match the fingerprint of the transformation in storage." }, "path": { "description": "GTM Transformation's API relative path.", "required": true, "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/transformations/[^/]+$", "location": "path", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "httpMethod": "PUT", "description": "Updates a GTM Transformation." }, "list": { "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/transformations", "path": "tagmanager/v2/{+parent}/transformations", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "response": { "$ref": "ListTransformationsResponse" }, "parameters": { "pageToken": { "description": "Continuation token for fetching the next page of results.", "type": "string", "location": "query" }, "parent": { "description": "GTM Workspace's API relative path.", "required": true, "type": "string", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "location": "path" } }, "id": "tagmanager.accounts.containers.workspaces.transformations.list", "httpMethod": "GET", "parameterOrder": [ "parent" ], "description": "Lists all GTM Transformations of a GTM container workspace." }, "create": { "response": { "$ref": "Transformation" }, "httpMethod": "POST", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/transformations", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "path": "tagmanager/v2/{+parent}/transformations", "parameters": { "parent": { "type": "string", "required": true, "description": "GTM Workspace's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$" } }, "request": { "$ref": "Transformation" }, "parameterOrder": [ "parent" ], "id": "tagmanager.accounts.containers.workspaces.transformations.create", "description": "Creates a GTM Transformation." }, "revert": { "parameters": { "fingerprint": { "location": "query", "description": "When provided, this fingerprint must match the fingerprint of the transformation in storage.", "type": "string" }, "path": { "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/transformations/[^/]+$", "required": true, "description": "GTM Transformation's API relative path.", "type": "string", "location": "path" } }, "description": "Reverts changes to a GTM Transformation in a GTM Workspace.", "path": "tagmanager/v2/{+path}:revert", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/transformations/{transformationsId}:revert", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "parameterOrder": [ "path" ], "id": "tagmanager.accounts.containers.workspaces.transformations.revert", "response": { "$ref": "RevertTransformationResponse" } }, "get": { "parameterOrder": [ "path" ], "description": "Gets a GTM Transformation.", "parameters": { "path": { "type": "string", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/transformations/[^/]+$", "description": "GTM Transformation's API relative path.", "required": true, "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "httpMethod": "GET", "path": "tagmanager/v2/{+path}", "id": "tagmanager.accounts.containers.workspaces.transformations.get", "response": { "$ref": "Transformation" }, "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/transformations/{transformationsId}" } } }, "folders": { "methods": { "delete": { "httpMethod": "DELETE", "parameterOrder": [ "path" ], "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "id": "tagmanager.accounts.containers.workspaces.folders.delete", "description": "Deletes a GTM Folder.", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/folders/{foldersId}", "path": "tagmanager/v2/{+path}", "parameters": { "path": { "required": true, "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/folders/[^/]+$", "type": "string", "description": "GTM Folder's API relative path.", "location": "path" } } }, "update": { "request": { "$ref": "Folder" }, "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/folders/{foldersId}", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "parameterOrder": [ "path" ], "response": { "$ref": "Folder" }, "parameters": { "path": { "required": true, "type": "string", "description": "GTM Folder's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/folders/[^/]+$" }, "fingerprint": { "description": "When provided, this fingerprint must match the fingerprint of the folder in storage.", "location": "query", "type": "string" } }, "httpMethod": "PUT", "path": "tagmanager/v2/{+path}", "id": "tagmanager.accounts.containers.workspaces.folders.update", "description": "Updates a GTM Folder." }, "get": { "httpMethod": "GET", "response": { "$ref": "Folder" }, "parameterOrder": [ "path" ], "id": "tagmanager.accounts.containers.workspaces.folders.get", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/folders/{foldersId}", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "description": "Gets a GTM Folder.", "path": "tagmanager/v2/{+path}", "parameters": { "path": { "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/folders/[^/]+$", "required": true, "description": "GTM Folder's API relative path.", "type": "string", "location": "path" } } }, "move_entities_to_folder": { "path": "tagmanager/v2/{+path}:move_entities_to_folder", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "request": { "$ref": "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.", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/folders/{foldersId}:move_entities_to_folder", "id": "tagmanager.accounts.containers.workspaces.folders.move_entities_to_folder", "parameters": { "path": { "required": true, "description": "GTM Folder's API relative path.", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/folders/[^/]+$", "location": "path", "type": "string" }, "triggerId": { "location": "query", "repeated": true, "description": "The triggers to be moved to the folder.", "type": "string" }, "tagId": { "description": "The tags to be moved to the folder.", "location": "query", "repeated": true, "type": "string" }, "variableId": { "location": "query", "repeated": true, "type": "string", "description": "The variables to be moved to the folder." } }, "parameterOrder": [ "path" ] }, "create": { "description": "Creates a GTM Folder.", "id": "tagmanager.accounts.containers.workspaces.folders.create", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "parameters": { "parent": { "location": "path", "description": "GTM Workspace's API relative path.", "type": "string", "required": true, "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$" } }, "response": { "$ref": "Folder" }, "httpMethod": "POST", "request": { "$ref": "Folder" }, "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/folders", "path": "tagmanager/v2/{+parent}/folders" }, "revert": { "description": "Reverts changes to a GTM Folder in a GTM Workspace.", "httpMethod": "POST", "id": "tagmanager.accounts.containers.workspaces.folders.revert", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "parameterOrder": [ "path" ], "response": { "$ref": "RevertFolderResponse" }, "path": "tagmanager/v2/{+path}:revert", "parameters": { "path": { "location": "path", "description": "GTM Folder's API relative path.", "required": true, "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/folders/[^/]+$", "type": "string" }, "fingerprint": { "location": "query", "description": "When provided, this fingerprint must match the fingerprint of the tag in storage.", "type": "string" } }, "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/folders/{foldersId}:revert" }, "entities": { "parameterOrder": [ "path" ], "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/folders/{foldersId}:entities", "id": "tagmanager.accounts.containers.workspaces.folders.entities", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "response": { "$ref": "FolderEntities" }, "path": "tagmanager/v2/{+path}:entities", "parameters": { "pageToken": { "description": "Continuation token for fetching the next page of results.", "type": "string", "location": "query" }, "path": { "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/folders/[^/]+$", "type": "string", "required": true, "description": "GTM Folder's API relative path." } }, "httpMethod": "POST", "description": "List all entities in a GTM Folder." }, "list": { "response": { "$ref": "ListFoldersResponse" }, "parameters": { "pageToken": { "type": "string", "description": "Continuation token for fetching the next page of results.", "location": "query" }, "parent": { "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "type": "string", "description": "GTM Workspace's API relative path.", "required": true, "location": "path" } }, "parameterOrder": [ "parent" ], "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/folders", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "id": "tagmanager.accounts.containers.workspaces.folders.list", "description": "Lists all GTM Folders of a Container.", "path": "tagmanager/v2/{+parent}/folders", "httpMethod": "GET" } } } }, "methods": { "quick_preview": { "response": { "$ref": "QuickPreviewResponse" }, "id": "tagmanager.accounts.containers.workspaces.quick_preview", "parameterOrder": [ "path" ], "path": "tagmanager/v2/{+path}:quick_preview", "description": "Quick previews a workspace by creating a fake container version from all entities in the provided workspace.", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}:quick_preview", "httpMethod": "POST", "parameters": { "path": { "description": "GTM Workspace's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "required": true, "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containerversions" ] }, "update": { "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "httpMethod": "PUT", "request": { "$ref": "Workspace" }, "id": "tagmanager.accounts.containers.workspaces.update", "description": "Updates a Workspace.", "path": "tagmanager/v2/{+path}", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}", "parameterOrder": [ "path" ], "parameters": { "path": { "required": true, "type": "string", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "description": "GTM Workspace's API relative path." }, "fingerprint": { "type": "string", "description": "When provided, this fingerprint must match the fingerprint of the workspace in storage.", "location": "query" } }, "response": { "$ref": "Workspace" } }, "bulk_update": { "path": "tagmanager/v2/{+path}/bulk_update", "parameterOrder": [ "path" ], "httpMethod": "POST", "response": { "$ref": "BulkUpdateWorkspaceResponse" }, "parameters": { "path": { "description": "GTM Workspace's API relative path.", "required": true, "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "type": "string", "location": "path" } }, "id": "tagmanager.accounts.containers.workspaces.bulk_update", "request": { "$ref": "ProposedChange" }, "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\" } ] ```", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/bulk_update", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ] }, "get": { "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}", "httpMethod": "GET", "response": { "$ref": "Workspace" }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "path": "tagmanager/v2/{+path}", "id": "tagmanager.accounts.containers.workspaces.get", "parameterOrder": [ "path" ], "description": "Gets a Workspace.", "parameters": { "path": { "description": "GTM Workspace's API relative path.", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "required": true, "type": "string", "location": "path" } } }, "create_version": { "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.", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containerversions" ], "httpMethod": "POST", "parameterOrder": [ "path" ], "id": "tagmanager.accounts.containers.workspaces.create_version", "parameters": { "path": { "type": "string", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "required": true, "description": "GTM Workspace's API relative path.", "location": "path" } }, "response": { "$ref": "CreateContainerVersionResponse" }, "request": { "$ref": "CreateContainerVersionRequestVersionOptions" }, "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}:create_version", "path": "tagmanager/v2/{+path}:create_version" }, "getStatus": { "parameterOrder": [ "path" ], "parameters": { "path": { "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "type": "string", "required": true, "description": "GTM Workspace's API relative path.", "location": "path" } }, "id": "tagmanager.accounts.containers.workspaces.getStatus", "path": "tagmanager/v2/{+path}/status", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "response": { "$ref": "GetWorkspaceStatusResponse" }, "httpMethod": "GET", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/status", "description": "Finds conflicting and modified entities in the workspace." }, "delete": { "parameters": { "path": { "required": true, "type": "string", "location": "path", "description": "GTM Workspace's API relative path.", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$" } }, "parameterOrder": [ "path" ], "description": "Deletes a Workspace.", "path": "tagmanager/v2/{+path}", "scopes": [ "https://www.googleapis.com/auth/tagmanager.delete.containers" ], "httpMethod": "DELETE", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}", "id": "tagmanager.accounts.containers.workspaces.delete" }, "resolve_conflict": { "path": "tagmanager/v2/{+path}:resolve_conflict", "parameters": { "path": { "required": true, "description": "GTM Workspace's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "type": "string" }, "fingerprint": { "location": "query", "type": "string", "description": "When provided, this fingerprint must match the fingerprint of the entity_in_workspace in the merge conflict." } }, "parameterOrder": [ "path" ], "description": "Resolves a merge conflict for a workspace entity by updating it to the resolved entity passed in the request.", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}:resolve_conflict", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "id": "tagmanager.accounts.containers.workspaces.resolve_conflict", "httpMethod": "POST", "request": { "$ref": "Entity" } }, "create": { "parameters": { "parent": { "type": "string", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+$", "required": true, "description": "GTM parent Container's API relative path." } }, "parameterOrder": [ "parent" ], "id": "tagmanager.accounts.containers.workspaces.create", "request": { "$ref": "Workspace" }, "response": { "$ref": "Workspace" }, "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "description": "Creates a Workspace.", "path": "tagmanager/v2/{+parent}/workspaces" }, "list": { "parameterOrder": [ "parent" ], "httpMethod": "GET", "path": "tagmanager/v2/{+parent}/workspaces", "id": "tagmanager.accounts.containers.workspaces.list", "parameters": { "parent": { "required": true, "pattern": "^accounts/[^/]+/containers/[^/]+$", "description": "GTM parent Container's API relative path.", "location": "path", "type": "string" }, "pageToken": { "type": "string", "description": "Continuation token for fetching the next page of results.", "location": "query" } }, "description": "Lists all Workspaces that belong to a GTM Container.", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "response": { "$ref": "ListWorkspacesResponse" } }, "sync": { "path": "tagmanager/v2/{+path}:sync", "parameters": { "path": { "location": "path", "type": "string", "required": true, "description": "GTM Workspace's API relative path.", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$" } }, "id": "tagmanager.accounts.containers.workspaces.sync", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}:sync", "description": "Syncs a workspace to the latest container version by updating all unmodified workspace entities and displaying conflicts for modified entities.", "parameterOrder": [ "path" ], "response": { "$ref": "SyncWorkspaceResponse" }, "httpMethod": "POST" } } }, "destinations": { "methods": { "get": { "httpMethod": "GET", "description": "Gets a Destination.", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/destinations/{destinationsId}", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "deprecated": true, "response": { "$ref": "Destination" }, "path": "tagmanager/v2/{+path}", "parameterOrder": [ "path" ], "id": "tagmanager.accounts.containers.destinations.get", "parameters": { "path": { "required": true, "pattern": "^accounts/[^/]+/containers/[^/]+/destinations/[^/]+$", "location": "path", "type": "string", "description": "Google Tag Destination's API relative path." } } }, "list": { "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "httpMethod": "GET", "id": "tagmanager.accounts.containers.destinations.list", "path": "tagmanager/v2/{+parent}/destinations", "parameters": { "parent": { "type": "string", "pattern": "^accounts/[^/]+/containers/[^/]+$", "location": "path", "description": "GTM parent Container's API relative path.", "required": true } }, "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/destinations", "parameterOrder": [ "parent" ], "description": "Lists all Destinations linked to a GTM Container.", "response": { "$ref": "ListDestinationsResponse" } }, "link": { "deprecated": true, "description": "Adds a Destination to this Container and removes it from the Container to which it is currently linked.", "id": "tagmanager.accounts.containers.destinations.link", "httpMethod": "POST", "parameterOrder": [ "parent" ], "path": "tagmanager/v2/{+parent}/destinations:link", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "response": { "$ref": "Destination" }, "parameters": { "destinationId": { "type": "string", "description": "Destination ID to be linked to the current container.", "location": "query" }, "parent": { "pattern": "^accounts/[^/]+/containers/[^/]+$", "type": "string", "location": "path", "description": "GTM parent Container's API relative path.", "required": true }, "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" } }, "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/destinations:link" } } }, "versions": { "methods": { "get": { "response": { "$ref": "ContainerVersion" }, "parameters": { "containerVersionId": { "type": "string", "description": "The GTM ContainerVersion ID. Specify published to retrieve the currently published version.", "location": "query" }, "path": { "description": "GTM ContainerVersion's API relative path.", "required": true, "pattern": "^accounts/[^/]+/containers/[^/]+/versions/[^/]+$", "type": "string", "location": "path" } }, "id": "tagmanager.accounts.containers.versions.get", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/versions/{versionsId}", "description": "Gets a Container Version.", "path": "tagmanager/v2/{+path}", "parameterOrder": [ "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" ], "httpMethod": "GET" }, "set_latest": { "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers" ], "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/versions/{versionsId}:set_latest", "parameterOrder": [ "path" ], "parameters": { "path": { "type": "string", "required": true, "description": "GTM ContainerVersion's API relative path.", "pattern": "^accounts/[^/]+/containers/[^/]+/versions/[^/]+$", "location": "path" } }, "path": "tagmanager/v2/{+path}:set_latest", "response": { "$ref": "ContainerVersion" }, "description": "Sets the latest version used for synchronization of workspaces when detecting conflicts and errors.", "id": "tagmanager.accounts.containers.versions.set_latest", "httpMethod": "POST" }, "undelete": { "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/versions/{versionsId}:undelete", "id": "tagmanager.accounts.containers.versions.undelete", "description": "Undeletes a Container Version.", "parameterOrder": [ "path" ], "response": { "$ref": "ContainerVersion" }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containerversions" ], "httpMethod": "POST", "parameters": { "path": { "required": true, "pattern": "^accounts/[^/]+/containers/[^/]+/versions/[^/]+$", "location": "path", "type": "string", "description": "GTM ContainerVersion's API relative path." } }, "path": "tagmanager/v2/{+path}:undelete" }, "publish": { "parameters": { "path": { "required": true, "description": "GTM ContainerVersion's API relative path.", "location": "path", "type": "string", "pattern": "^accounts/[^/]+/containers/[^/]+/versions/[^/]+$" }, "fingerprint": { "type": "string", "description": "When provided, this fingerprint must match the fingerprint of the container version in storage.", "location": "query" } }, "response": { "$ref": "PublishContainerVersionResponse" }, "id": "tagmanager.accounts.containers.versions.publish", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/versions/{versionsId}:publish", "scopes": [ "https://www.googleapis.com/auth/tagmanager.publish" ], "path": "tagmanager/v2/{+path}:publish", "parameterOrder": [ "path" ], "httpMethod": "POST", "description": "Publishes a Container Version." }, "update": { "path": "tagmanager/v2/{+path}", "parameterOrder": [ "path" ], "httpMethod": "PUT", "request": { "$ref": "ContainerVersion" }, "description": "Updates a Container Version.", "id": "tagmanager.accounts.containers.versions.update", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containerversions" ], "parameters": { "fingerprint": { "location": "query", "description": "When provided, this fingerprint must match the fingerprint of the container version in storage.", "type": "string" }, "path": { "pattern": "^accounts/[^/]+/containers/[^/]+/versions/[^/]+$", "type": "string", "location": "path", "required": true, "description": "GTM ContainerVersion's API relative path." } }, "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/versions/{versionsId}", "response": { "$ref": "ContainerVersion" } }, "delete": { "parameterOrder": [ "path" ], "id": "tagmanager.accounts.containers.versions.delete", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/versions/{versionsId}", "httpMethod": "DELETE", "path": "tagmanager/v2/{+path}", "parameters": { "path": { "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/versions/[^/]+$", "required": true, "type": "string", "description": "GTM ContainerVersion's API relative path." } }, "description": "Deletes a Container Version.", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containerversions" ] }, "live": { "parameters": { "parent": { "description": "GTM Container's API relative path.", "location": "path", "type": "string", "required": true, "pattern": "^accounts/[^/]+/containers/[^/]+$" } }, "id": "tagmanager.accounts.containers.versions.live", "description": "Gets the live (i.e. published) container version", "parameterOrder": [ "parent" ], "path": "tagmanager/v2/{+parent}/versions:live", "scopes": [ "https://www.googleapis.com/auth/tagmanager.edit.containers", "https://www.googleapis.com/auth/tagmanager.readonly" ], "response": { "$ref": "ContainerVersion" }, "httpMethod": "GET", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/versions:live" } } } } }, "user_permissions": { "methods": { "create": { "path": "tagmanager/v2/{+parent}/user_permissions", "request": { "$ref": "UserPermission" }, "parameters": { "parent": { "description": "GTM Account's API relative path.", "required": true, "type": "string", "pattern": "^accounts/[^/]+$", "location": "path" } }, "id": "tagmanager.accounts.user_permissions.create", "parameterOrder": [ "parent" ], "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/tagmanager.manage.users" ], "flatPath": "tagmanager/v2/accounts/{accountsId}/user_permissions", "description": "Creates a user's Account & Container access.", "response": { "$ref": "UserPermission" } }, "list": { "description": "List all users that have access to the account along with Account and Container user access granted to each of them.", "flatPath": "tagmanager/v2/accounts/{accountsId}/user_permissions", "httpMethod": "GET", "parameterOrder": [ "parent" ], "path": "tagmanager/v2/{+parent}/user_permissions", "response": { "$ref": "ListUserPermissionsResponse" }, "id": "tagmanager.accounts.user_permissions.list", "parameters": { "parent": { "pattern": "^accounts/[^/]+$", "description": "GTM Account's API relative path.", "type": "string", "required": true, "location": "path" }, "pageToken": { "type": "string", "description": "Continuation token for fetching the next page of results.", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/tagmanager.manage.users" ] }, "delete": { "parameterOrder": [ "path" ], "path": "tagmanager/v2/{+path}", "scopes": [ "https://www.googleapis.com/auth/tagmanager.manage.users" ], "httpMethod": "DELETE", "flatPath": "tagmanager/v2/accounts/{accountsId}/user_permissions/{user_permissionsId}", "id": "tagmanager.accounts.user_permissions.delete", "parameters": { "path": { "pattern": "^accounts/[^/]+/user_permissions/[^/]+$", "required": true, "description": "GTM UserPermission's API relative path.", "type": "string", "location": "path" } }, "description": "Removes a user from the account, revoking access to it and all of its containers." }, "update": { "description": "Updates a user's Account & Container access.", "parameters": { "path": { "location": "path", "pattern": "^accounts/[^/]+/user_permissions/[^/]+$", "type": "string", "required": true, "description": "GTM UserPermission's API relative path." } }, "id": "tagmanager.accounts.user_permissions.update", "flatPath": "tagmanager/v2/accounts/{accountsId}/user_permissions/{user_permissionsId}", "request": { "$ref": "UserPermission" }, "path": "tagmanager/v2/{+path}", "scopes": [ "https://www.googleapis.com/auth/tagmanager.manage.users" ], "response": { "$ref": "UserPermission" }, "parameterOrder": [ "path" ], "httpMethod": "PUT" }, "get": { "parameters": { "path": { "location": "path", "pattern": "^accounts/[^/]+/user_permissions/[^/]+$", "type": "string", "required": true, "description": "GTM UserPermission's API relative path." } }, "flatPath": "tagmanager/v2/accounts/{accountsId}/user_permissions/{user_permissionsId}", "response": { "$ref": "UserPermission" }, "id": "tagmanager.accounts.user_permissions.get", "path": "tagmanager/v2/{+path}", "description": "Gets a user's Account & Container access.", "httpMethod": "GET", "parameterOrder": [ "path" ], "scopes": [ "https://www.googleapis.com/auth/tagmanager.manage.users" ] } } } } } }, "ownerDomain": "google.com", "basePath": "", "protocol": "rest", "discoveryVersion": "v1", "rootUrl": "https://tagmanager.googleapis.com/", "version": "v2", "id": "tagmanager:v2", "documentationLink": "https://developers.google.com/tag-manager", "parameters": { "access_token": { "location": "query", "description": "OAuth access token.", "type": "string" }, "prettyPrint": { "description": "Returns response with indentations and line breaks.", "type": "boolean", "location": "query", "default": "true" }, "fields": { "description": "Selector specifying which fields to include in a partial response.", "location": "query", "type": "string" }, "alt": { "description": "Data format for response.", "default": "json", "location": "query", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "enum": [ "json", "media", "proto" ], "type": "string" }, "uploadType": { "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "type": "string", "location": "query" }, "$.xgafv": { "description": "V1 error format.", "location": "query", "enumDescriptions": [ "v1 error format", "v2 error format" ], "type": "string", "enum": [ "1", "2" ] }, "callback": { "type": "string", "location": "query", "description": "JSONP" }, "quotaUser": { "location": "query", "type": "string", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user.", "location": "query" }, "key": { "location": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", "type": "string" }, "upload_protocol": { "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query", "type": "string" } }, "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/tagmanager.manage.accounts": { "description": "View and manage your Google Tag Manager accounts" }, "https://www.googleapis.com/auth/tagmanager.edit.containerversions": { "description": "Manage your Google Tag Manager container versions" }, "https://www.googleapis.com/auth/tagmanager.delete.containers": { "description": "Delete your Google Tag Manager containers" }, "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.readonly": { "description": "View your Google Tag Manager container and its subcomponents" }, "https://www.googleapis.com/auth/tagmanager.publish": { "description": "Publish your Google Tag Manager container versions" }, "https://www.googleapis.com/auth/tagmanager.manage.users": { "description": "Manage user permissions of your Google Tag Manager account and container" } } } }, "revision": "20261102", "kind": "discovery#restDescription" }