API Reference google_api_tag_manager v0.24.0

View Source

Modules

API client metadata for GoogleApi.TagManager.V2.

API calls for all endpoints tagged Accounts.

Handle Tesla connections for GoogleApi.TagManager.V2.

Represents a Google Tag Manager Account.

Defines the Google Tag Manager Account access permissions.

Attributes

  • supportMultipleContainers (type: boolean(), default: nil) - Whether this Account supports multiple Containers.
  • supportUserPermissions (type: boolean(), default: nil) - Whether this Account supports user permissions managed by GTM.

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.

Attributes

  • accountId (type: String.t, default: nil) - GTM Account ID.
  • clientId (type: String.t, default: nil) - The Client ID uniquely identifies the GTM client.
  • containerId (type: String.t, default: nil) - GTM Container ID.
  • fingerprint (type: String.t, default: nil) - The fingerprint of the GTM Client as computed at storage time. This value is recomputed whenever the client is modified.
  • name (type: String.t, default: nil) - Client display name.
  • notes (type: String.t, default: nil) - User notes on how to apply this tag in the container.
  • parameter (type: list(GoogleApi.TagManager.V2.Model.Parameter.t), default: nil) - The client's parameters.
  • parentFolderId (type: String.t, default: nil) - Parent folder id.
  • path (type: String.t, default: nil) - GTM client's API relative path.
  • priority (type: integer(), default: nil) - Priority determines relative firing order.
  • tagManagerUrl (type: String.t, default: nil) - Auto generated link to the tag manager UI
  • type (type: String.t, default: nil) - Client type.
  • workspaceId (type: String.t, default: nil) - GTM Workspace ID.

Represents a predicate.

Represents a Google Tag Manager Container, which specifies the platform tags will run on, manages workspaces, and retains container versions.

Defines the Google Tag Manager Container access permissions.

Attributes

  • supportBuiltInVariables (type: boolean(), default: nil) - Whether this Container supports built-in variables
  • supportClients (type: boolean(), default: nil) - Whether this Container supports clients.
  • supportEnvironments (type: boolean(), default: nil) - Whether this Container supports environments.
  • supportFolders (type: boolean(), default: nil) - Whether this Container supports folders.
  • supportGtagConfigs (type: boolean(), default: nil) - Whether this Container supports Google tag config.
  • supportTags (type: boolean(), default: nil) - Whether this Container supports tags.
  • supportTemplates (type: boolean(), default: nil) - Whether this Container supports templates.
  • supportTransformations (type: boolean(), default: nil) - Whether this Container supports transformations.
  • supportTriggers (type: boolean(), default: nil) - Whether this Container supports triggers.
  • supportUserPermissions (type: boolean(), default: nil) - Whether this Container supports user permissions managed by GTM.
  • supportVariables (type: boolean(), default: nil) - Whether this Container supports variables.
  • supportVersions (type: boolean(), default: nil) - Whether this Container supports Container versions.
  • supportWorkspaces (type: boolean(), default: nil) - Whether this Container supports workspaces.
  • supportZones (type: boolean(), default: nil) - Whether this Container supports zones.

Represents a Google Tag Manager Container Version.

Represents a Google Tag Manager Container Version Header.

Attributes

  • builtInVariable (type: list(GoogleApi.TagManager.V2.Model.BuiltInVariable.t), default: nil) - List of created built-in variables.

Represents a Google Tag Manager Custom Template's contents.

Represents a Google Tag Destination.

A workspace entity that may represent a tag, trigger, variable, or folder in addition to its status in the workspace.

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.

Represents a Google Tag Manager Folder.

Represents a Google Tag Manager Folder's contents.

Represents the link between a custom template and an entry on the Community Template Gallery site.

Attributes

  • containerConfig (type: String.t, default: nil) - Server container config param for manually provisioning a tagging server.
  • snippet (type: String.t, default: nil) - Tagging snippet for a Container.

The changes that have occurred in the workspace since the base container version.

Represents a Google tag configuration.

Attributes

  • client (type: list(GoogleApi.TagManager.V2.Model.Client.t), default: nil) - All GTM Clients of a GTM Container.
  • nextPageToken (type: String.t, default: nil) - Continuation token for fetching the next page of results.

Attributes

  • destination (type: list(GoogleApi.TagManager.V2.Model.Destination.t), default: nil) - All Destinations linked to a GTM Container.
  • nextPageToken (type: String.t, default: nil) - Continuation token for fetching the next page of results.

Attributes

  • gtagConfig (type: list(GoogleApi.TagManager.V2.Model.GtagConfig.t), default: nil) - All Google tag configs in a Container.
  • nextPageToken (type: String.t, default: nil) - Continuation token for fetching the next page of results.

Attributes

  • nextPageToken (type: String.t, default: nil) - Continuation token for fetching the next page of results.
  • template (type: list(GoogleApi.TagManager.V2.Model.CustomTemplate.t), default: nil) - All GTM Custom Templates of a GTM Container.

Attributes

  • nextPageToken (type: String.t, default: nil) - Continuation token for fetching the next page of results.
  • transformation (type: list(GoogleApi.TagManager.V2.Model.Transformation.t), default: nil) - All GTM Transformations of a GTM Container.

A list of workspaces in a container.

Attributes

  • nextPageToken (type: String.t, default: nil) - Continuation token for fetching the next page of results.
  • zone (type: list(GoogleApi.TagManager.V2.Model.Zone.t), default: nil) - All GTM Zones of a GTM Container.

Represents a merge conflict.

Represents a Google Tag Manager Parameter.

Response to quick previewing a workspace.

The result of reverting a built-in variable in a workspace.

The result of reverting a client in a workspace.

The result of reverting folder changes in a workspace.

The result of reverting a tag in a workspace.

The result of reverting a template in a workspace.

The result of reverting a transformation in a workspace.

The result of reverting a trigger in a workspace.

The result of reverting a variable in a workspace.

The result of reverting a zone in a workspace.

Represents a reference to atag that fires before another tag in order to set up dependencies.

The status of a workspace after synchronization.

A response after synchronizing the workspace to the latest container version.

Represents a Google Tag Manager Tag.

Attributes

  • consentStatus (type: String.t, default: nil) - The tag's consent status. If set to NEEDED, the runtime will check that the consent types specified by the consent_type field have been granted.
  • consentType (type: GoogleApi.TagManager.V2.Model.Parameter.t, default: nil) - 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.

Represents a tag that fires after another tag in order to tear down dependencies.

Represents a Google Tag Manager Transformation.

Represents a Google Tag Manager Trigger

Represents a user's permissions to an account and its container.

Represents a Google Tag Manager Variable.

Attributes

  • caseConversionType (type: String.t, default: nil) - The option to convert a string-type variable value to either lowercase or uppercase.
  • convertFalseToValue (type: GoogleApi.TagManager.V2.Model.Parameter.t, default: nil) - The value to convert if a variable value is false.
  • convertNullToValue (type: GoogleApi.TagManager.V2.Model.Parameter.t, default: nil) - The value to convert if a variable value is null.
  • convertTrueToValue (type: GoogleApi.TagManager.V2.Model.Parameter.t, default: nil) - The value to convert if a variable value is true.
  • convertUndefinedToValue (type: GoogleApi.TagManager.V2.Model.Parameter.t, default: nil) - The value to convert if a variable value is undefined.

Represents a Google Tag Manager Container Workspace.

Represents a Google Tag Manager Zone's contents.

Represents a Zone's boundaries.

Represents a child container of a Zone.

Represents a Zone's type restrictions.