# Tag Manager API . accounts . containers . workspaces . built_in_variables

## Instance Methods

Creates one or more GTM Built-In Variables.

Deletes one or more GTM Built-In Variables.

Lists all the enabled Built-In Variables of a GTM Container.

Retrieves the next page of results.

Reverts changes to a GTM Built-In Variables in a GTM Workspace.

### Method Details

`create(parent, type=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
          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.
          },
        ],
      }

`delete(path, type=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
          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 -

`list(parent, pageToken=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.

    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.
          },
        ],
      }

`list_next(previous_request, previous_response)`

    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)`

    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.
      }