Close httplib2 connections.
create(parent, type=None, x__xgafv=None)
Creates one or more GTM Built-In Variables.
delete(path, type=None, x__xgafv=None)
Deletes one or more GTM Built-In Variables.
list(parent, pageToken=None, x__xgafv=None)
Lists all the enabled Built-In Variables of a GTM Container.
Retrieves the next page of results.
revert(path, type=None, x__xgafv=None)
Reverts changes to a GTM Built-In Variables in a GTM Workspace.
close()
Close httplib2 connections.
create(parent, type=None, x__xgafv=None)
Creates one or more GTM Built-In Variables.
Args:
parent: string, GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id} (required)
type: string, The types of built-in variables to enable. (repeated)
Allowed values
builtInVariableTypeUnspecified -
pageUrl -
pageHostname -
pagePath -
referrer -
event - For web or mobile.
clickElement -
clickClasses -
clickId -
clickTarget -
clickUrl -
clickText -
firstPartyServingUrl -
formElement -
formClasses -
formId -
formTarget -
formUrl -
formText -
errorMessage -
errorUrl -
errorLine -
newHistoryUrl -
oldHistoryUrl -
newHistoryFragment -
oldHistoryFragment -
newHistoryState -
oldHistoryState -
historySource -
containerVersion - For web or mobile.
debugMode -
randomNumber - For web or mobile.
containerId - For web or mobile.
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 -
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"builtInVariable": [ # List of created built-in variables.
{ # 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.
"accountId": "A String", # GTM Account ID.
"containerId": "A String", # GTM Container ID.
"name": "A String", # Name of the built-in variable to be used to refer to the built-in variable.
"path": "A String", # GTM BuiltInVariable's API relative path.
"type": "A String", # Type of built-in variable. @required.tagmanager.accounts.containers.workspaces.built_in_variable.update @mutable tagmanager.accounts.containers.workspaces.built_in_variable.update
"workspaceId": "A String", # GTM Workspace ID.
},
],
}
delete(path, type=None, x__xgafv=None)
Deletes one or more GTM Built-In Variables.
Args:
path: string, GTM BuiltInVariable's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/built_in_variables (required)
type: string, The types of built-in variables to delete. (repeated)
Allowed values
builtInVariableTypeUnspecified -
pageUrl -
pageHostname -
pagePath -
referrer -
event - For web or mobile.
clickElement -
clickClasses -
clickId -
clickTarget -
clickUrl -
clickText -
firstPartyServingUrl -
formElement -
formClasses -
formId -
formTarget -
formUrl -
formText -
errorMessage -
errorUrl -
errorLine -
newHistoryUrl -
oldHistoryUrl -
newHistoryFragment -
oldHistoryFragment -
newHistoryState -
oldHistoryState -
historySource -
containerVersion - For web or mobile.
debugMode -
randomNumber - For web or mobile.
containerId - For web or mobile.
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 -
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
list(parent, pageToken=None, x__xgafv=None)
Lists all the enabled Built-In Variables of a GTM Container.
Args:
parent: string, GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id} (required)
pageToken: string, Continuation token for fetching the next page of results.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A list of enabled built-in variables.
"builtInVariable": [ # All GTM BuiltInVariables of a GTM container.
{ # 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.
"accountId": "A String", # GTM Account ID.
"containerId": "A String", # GTM Container ID.
"name": "A String", # Name of the built-in variable to be used to refer to the built-in variable.
"path": "A String", # GTM BuiltInVariable's API relative path.
"type": "A String", # Type of built-in variable. @required.tagmanager.accounts.containers.workspaces.built_in_variable.update @mutable tagmanager.accounts.containers.workspaces.built_in_variable.update
"workspaceId": "A String", # GTM Workspace ID.
},
],
"nextPageToken": "A String", # Continuation token for fetching the next page of results.
}
list_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
revert(path, type=None, x__xgafv=None)
Reverts changes to a GTM Built-In Variables in a GTM Workspace.
Args:
path: string, GTM BuiltInVariable's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/built_in_variables (required)
type: string, The type of built-in variable to revert.
Allowed values
builtInVariableTypeUnspecified -
pageUrl -
pageHostname -
pagePath -
referrer -
event - For web or mobile.
clickElement -
clickClasses -
clickId -
clickTarget -
clickUrl -
clickText -
firstPartyServingUrl -
formElement -
formClasses -
formId -
formTarget -
formUrl -
formText -
errorMessage -
errorUrl -
errorLine -
newHistoryUrl -
oldHistoryUrl -
newHistoryFragment -
oldHistoryFragment -
newHistoryState -
oldHistoryState -
historySource -
containerVersion - For web or mobile.
debugMode -
randomNumber - For web or mobile.
containerId - For web or mobile.
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 -
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The result of reverting a built-in variable in a workspace.
"enabled": True or False, # Whether the built-in variable is enabled after reversion.
}