blob: f769aaee699f0e0b921d1440ea35a3d3549056cb [file] [log] [blame]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="tagmanager_v2.html">Tag Manager API</a> . <a href="tagmanager_v2.accounts.html">accounts</a> . <a href="tagmanager_v2.accounts.containers.html">containers</a> . <a href="tagmanager_v2.accounts.containers.workspaces.html">workspaces</a> . <a href="tagmanager_v2.accounts.containers.workspaces.built_in_variables.html">built_in_variables</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#create">create(parent, type=None)</a></code></p>
<p class="firstline">Creates one or more GTM Built-In Variables.</p>
<p class="toc_element">
<code><a href="#delete">delete(path, type=None)</a></code></p>
<p class="firstline">Deletes one or more GTM Built-In Variables.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageToken=None)</a></code></p>
<p class="firstline">Lists all the enabled Built-In Variables of a GTM Container.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#revert">revert(path, type=None)</a></code></p>
<p class="firstline">Reverts changes to a GTM Built-In Variables in a GTM Workspace.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(parent, type=None)</code>
<pre>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
advertiserId -
advertisingTrackingEnabled -
ampBrowserLanguage -
ampCanonicalHost -
ampCanonicalPath -
ampCanonicalUrl -
ampClientId -
ampClientMaxScrollX -
ampClientMaxScrollY -
ampClientScreenHeight -
ampClientScreenWidth -
ampClientScrollX -
ampClientScrollY -
ampClientTimestamp -
ampClientTimezone -
ampGtmEvent -
ampPageDownloadTime -
ampPageLoadTime -
ampPageViewId -
ampReferrer -
ampTitle -
ampTotalEngagedTime -
appId -
appName -
appVersionCode -
appVersionName -
builtInVariableTypeUnspecified -
clickClasses -
clickElement -
clickId -
clickTarget -
clickText -
clickUrl -
containerId -
containerVersion -
debugMode -
deviceName -
environmentName -
errorLine -
errorMessage -
errorUrl -
event -
eventName -
firebaseEventParameterCampaign -
firebaseEventParameterCampaignAclid -
firebaseEventParameterCampaignAnid -
firebaseEventParameterCampaignClickTimestamp -
firebaseEventParameterCampaignContent -
firebaseEventParameterCampaignCp1 -
firebaseEventParameterCampaignGclid -
firebaseEventParameterCampaignSource -
firebaseEventParameterCampaignTerm -
firebaseEventParameterCurrency -
firebaseEventParameterDynamicLinkAcceptTime -
firebaseEventParameterDynamicLinkLinkid -
firebaseEventParameterNotificationMessageDeviceTime -
firebaseEventParameterNotificationMessageId -
firebaseEventParameterNotificationMessageName -
firebaseEventParameterNotificationMessageTime -
firebaseEventParameterNotificationTopic -
firebaseEventParameterPreviousAppVersion -
firebaseEventParameterPreviousOsVersion -
firebaseEventParameterPrice -
firebaseEventParameterProductId -
firebaseEventParameterQuantity -
firebaseEventParameterValue -
formClasses -
formElement -
formId -
formTarget -
formText -
formUrl -
historySource -
htmlId -
language -
newHistoryFragment -
newHistoryState -
oldHistoryFragment -
oldHistoryState -
osVersion -
pageHostname -
pagePath -
pageUrl -
platform -
randomNumber -
referrer -
resolution -
sdkVersion -
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 propeties of the gtm data layer, monitoring clicks, or accessing elements of a page URL.
"containerId": "A String", # GTM Container ID.
"workspaceId": "A String", # GTM Workspace ID.
"path": "A String", # GTM BuiltInVariable's API relative path.
"accountId": "A String", # GTM Account ID.
"type": "A String", # Type of built-in variable.
"name": "A String", # Name of the built-in variable to be used to refer to the built-in variable.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(path, type=None)</code>
<pre>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
advertiserId -
advertisingTrackingEnabled -
ampBrowserLanguage -
ampCanonicalHost -
ampCanonicalPath -
ampCanonicalUrl -
ampClientId -
ampClientMaxScrollX -
ampClientMaxScrollY -
ampClientScreenHeight -
ampClientScreenWidth -
ampClientScrollX -
ampClientScrollY -
ampClientTimestamp -
ampClientTimezone -
ampGtmEvent -
ampPageDownloadTime -
ampPageLoadTime -
ampPageViewId -
ampReferrer -
ampTitle -
ampTotalEngagedTime -
appId -
appName -
appVersionCode -
appVersionName -
builtInVariableTypeUnspecified -
clickClasses -
clickElement -
clickId -
clickTarget -
clickText -
clickUrl -
containerId -
containerVersion -
debugMode -
deviceName -
environmentName -
errorLine -
errorMessage -
errorUrl -
event -
eventName -
firebaseEventParameterCampaign -
firebaseEventParameterCampaignAclid -
firebaseEventParameterCampaignAnid -
firebaseEventParameterCampaignClickTimestamp -
firebaseEventParameterCampaignContent -
firebaseEventParameterCampaignCp1 -
firebaseEventParameterCampaignGclid -
firebaseEventParameterCampaignSource -
firebaseEventParameterCampaignTerm -
firebaseEventParameterCurrency -
firebaseEventParameterDynamicLinkAcceptTime -
firebaseEventParameterDynamicLinkLinkid -
firebaseEventParameterNotificationMessageDeviceTime -
firebaseEventParameterNotificationMessageId -
firebaseEventParameterNotificationMessageName -
firebaseEventParameterNotificationMessageTime -
firebaseEventParameterNotificationTopic -
firebaseEventParameterPreviousAppVersion -
firebaseEventParameterPreviousOsVersion -
firebaseEventParameterPrice -
firebaseEventParameterProductId -
firebaseEventParameterQuantity -
firebaseEventParameterValue -
formClasses -
formElement -
formId -
formTarget -
formText -
formUrl -
historySource -
htmlId -
language -
newHistoryFragment -
newHistoryState -
oldHistoryFragment -
oldHistoryState -
osVersion -
pageHostname -
pagePath -
pageUrl -
platform -
randomNumber -
referrer -
resolution -
sdkVersion -
</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageToken=None)</code>
<pre>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.
Returns:
An object of the form:
{ # A list of enabled built-in variables.
"nextPageToken": "A String", # Continuation token for fetching the next page of results.
"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 propeties of the gtm data layer, monitoring clicks, or accessing elements of a page URL.
"containerId": "A String", # GTM Container ID.
"workspaceId": "A String", # GTM Workspace ID.
"path": "A String", # GTM BuiltInVariable's API relative path.
"accountId": "A String", # GTM Account ID.
"type": "A String", # Type of built-in variable.
"name": "A String", # Name of the built-in variable to be used to refer to the built-in variable.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>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.
</pre>
</div>
<div class="method">
<code class="details" id="revert">revert(path, type=None)</code>
<pre>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
advertiserId -
advertisingTrackingEnabled -
ampBrowserLanguage -
ampCanonicalHost -
ampCanonicalPath -
ampCanonicalUrl -
ampClientId -
ampClientMaxScrollX -
ampClientMaxScrollY -
ampClientScreenHeight -
ampClientScreenWidth -
ampClientScrollX -
ampClientScrollY -
ampClientTimestamp -
ampClientTimezone -
ampGtmEvent -
ampPageDownloadTime -
ampPageLoadTime -
ampPageViewId -
ampReferrer -
ampTitle -
ampTotalEngagedTime -
appId -
appName -
appVersionCode -
appVersionName -
builtInVariableTypeUnspecified -
clickClasses -
clickElement -
clickId -
clickTarget -
clickText -
clickUrl -
containerId -
containerVersion -
debugMode -
deviceName -
environmentName -
errorLine -
errorMessage -
errorUrl -
event -
eventName -
firebaseEventParameterCampaign -
firebaseEventParameterCampaignAclid -
firebaseEventParameterCampaignAnid -
firebaseEventParameterCampaignClickTimestamp -
firebaseEventParameterCampaignContent -
firebaseEventParameterCampaignCp1 -
firebaseEventParameterCampaignGclid -
firebaseEventParameterCampaignSource -
firebaseEventParameterCampaignTerm -
firebaseEventParameterCurrency -
firebaseEventParameterDynamicLinkAcceptTime -
firebaseEventParameterDynamicLinkLinkid -
firebaseEventParameterNotificationMessageDeviceTime -
firebaseEventParameterNotificationMessageId -
firebaseEventParameterNotificationMessageName -
firebaseEventParameterNotificationMessageTime -
firebaseEventParameterNotificationTopic -
firebaseEventParameterPreviousAppVersion -
firebaseEventParameterPreviousOsVersion -
firebaseEventParameterPrice -
firebaseEventParameterProductId -
firebaseEventParameterQuantity -
firebaseEventParameterValue -
formClasses -
formElement -
formId -
formTarget -
formText -
formUrl -
historySource -
htmlId -
language -
newHistoryFragment -
newHistoryState -
oldHistoryFragment -
oldHistoryState -
osVersion -
pageHostname -
pagePath -
pageUrl -
platform -
randomNumber -
referrer -
resolution -
sdkVersion -
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.
}</pre>
</div>
</body></html>