Copyright | (c) 2015-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
- Service Configuration
- OAuth Scopes
- ListVariablesResponse
- ListFoldersResponse
- ListEnvironmentsResponse
- PublishContainerVersionResponse
- ContainerVersionHeader
- TeardownTag
- ListTriggersResponse
- Macro
- Tag
- CreateContainerVersionResponse
- CreateContainerVersionRequestVersionOptions
- UserAccess
- Environment
- AccountAccess
- TriggerType
- ContainerEnabledBuiltInVariableItem
- ContainerUsageContextItem
- ConditionType
- ListAccountsResponse
- AccountAccessPermissionItem
- TagTagFiringOption
- Rule
- Folder
- Variable
- ParameterType
- Account
- ListContainerVersionsResponse
- Container
- ListAccountUsersResponse
- ContainerAccessPermissionItem
- ContainerVersion
- EnvironmentType
- SetupTag
- ListContainersResponse
- Trigger
- ListTagsResponse
- FolderEntities
- Condition
- ContainerAccess
- Parameter
- tagManagerService :: ServiceConfig
- tagManagerReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/tagmanager.readonly"]
- tagManagerEditContainersScope :: Proxy '["https://www.googleapis.com/auth/tagmanager.edit.containers"]
- tagManagerManageAccountsScope :: Proxy '["https://www.googleapis.com/auth/tagmanager.manage.accounts"]
- tagManagerDeleteContainersScope :: Proxy '["https://www.googleapis.com/auth/tagmanager.delete.containers"]
- tagManagerManageUsersScope :: Proxy '["https://www.googleapis.com/auth/tagmanager.manage.users"]
- tagManagerPublishScope :: Proxy '["https://www.googleapis.com/auth/tagmanager.publish"]
- tagManagerEditContainerversionsScope :: Proxy '["https://www.googleapis.com/auth/tagmanager.edit.containerversions"]
- data ListVariablesResponse
- listVariablesResponse :: ListVariablesResponse
- lvrVariables :: Lens' ListVariablesResponse [Variable]
- data ListFoldersResponse
- listFoldersResponse :: ListFoldersResponse
- lfrFolders :: Lens' ListFoldersResponse [Folder]
- data ListEnvironmentsResponse
- listEnvironmentsResponse :: ListEnvironmentsResponse
- lerEnvironments :: Lens' ListEnvironmentsResponse [Environment]
- data PublishContainerVersionResponse
- publishContainerVersionResponse :: PublishContainerVersionResponse
- pcvrCompilerError :: Lens' PublishContainerVersionResponse (Maybe Bool)
- pcvrContainerVersion :: Lens' PublishContainerVersionResponse (Maybe ContainerVersion)
- data ContainerVersionHeader
- containerVersionHeader :: ContainerVersionHeader
- cvhNumTags :: Lens' ContainerVersionHeader (Maybe Text)
- cvhNumMacros :: Lens' ContainerVersionHeader (Maybe Text)
- cvhContainerId :: Lens' ContainerVersionHeader (Maybe Text)
- cvhContainerVersionId :: Lens' ContainerVersionHeader (Maybe Text)
- cvhAccountId :: Lens' ContainerVersionHeader (Maybe Text)
- cvhName :: Lens' ContainerVersionHeader (Maybe Text)
- cvhNumTriggers :: Lens' ContainerVersionHeader (Maybe Text)
- cvhDeleted :: Lens' ContainerVersionHeader (Maybe Bool)
- cvhNumRules :: Lens' ContainerVersionHeader (Maybe Text)
- cvhNumVariables :: Lens' ContainerVersionHeader (Maybe Text)
- data TeardownTag
- teardownTag :: TeardownTag
- ttStopTeardownOnFailure :: Lens' TeardownTag (Maybe Bool)
- ttTagName :: Lens' TeardownTag (Maybe Text)
- data ListTriggersResponse
- listTriggersResponse :: ListTriggersResponse
- ltrTriggers :: Lens' ListTriggersResponse [Trigger]
- data Macro
- macro :: Macro
- mScheduleEndMs :: Lens' Macro (Maybe Int64)
- mParentFolderId :: Lens' Macro (Maybe Text)
- mContainerId :: Lens' Macro (Maybe Text)
- mDisablingRuleId :: Lens' Macro [Text]
- mFingerprint :: Lens' Macro (Maybe Text)
- mAccountId :: Lens' Macro (Maybe Text)
- mName :: Lens' Macro (Maybe Text)
- mEnablingRuleId :: Lens' Macro [Text]
- mMacroId :: Lens' Macro (Maybe Text)
- mType :: Lens' Macro (Maybe Text)
- mScheduleStartMs :: Lens' Macro (Maybe Int64)
- mNotes :: Lens' Macro (Maybe Text)
- mParameter :: Lens' Macro [Parameter]
- data Tag
- tag :: Tag
- tBlockingTriggerId :: Lens' Tag [Text]
- tScheduleEndMs :: Lens' Tag (Maybe Int64)
- tParentFolderId :: Lens' Tag (Maybe Text)
- tLiveOnly :: Lens' Tag (Maybe Bool)
- tContainerId :: Lens' Tag (Maybe Text)
- tPriority :: Lens' Tag (Maybe Parameter)
- tTeardownTag :: Lens' Tag [TeardownTag]
- tFingerprint :: Lens' Tag (Maybe Text)
- tTagFiringOption :: Lens' Tag (Maybe TagTagFiringOption)
- tAccountId :: Lens' Tag (Maybe Text)
- tTagId :: Lens' Tag (Maybe Text)
- tName :: Lens' Tag (Maybe Text)
- tBlockingRuleId :: Lens' Tag [Text]
- tSetupTag :: Lens' Tag [SetupTag]
- tFiringTriggerId :: Lens' Tag [Text]
- tType :: Lens' Tag (Maybe Text)
- tScheduleStartMs :: Lens' Tag (Maybe Int64)
- tNotes :: Lens' Tag (Maybe Text)
- tFiringRuleId :: Lens' Tag [Text]
- tParameter :: Lens' Tag [Parameter]
- data CreateContainerVersionResponse
- createContainerVersionResponse :: CreateContainerVersionResponse
- ccvrCompilerError :: Lens' CreateContainerVersionResponse (Maybe Bool)
- ccvrContainerVersion :: Lens' CreateContainerVersionResponse (Maybe ContainerVersion)
- data CreateContainerVersionRequestVersionOptions
- createContainerVersionRequestVersionOptions :: CreateContainerVersionRequestVersionOptions
- ccvrvoName :: Lens' CreateContainerVersionRequestVersionOptions (Maybe Text)
- ccvrvoQuickPreview :: Lens' CreateContainerVersionRequestVersionOptions (Maybe Bool)
- ccvrvoNotes :: Lens' CreateContainerVersionRequestVersionOptions (Maybe Text)
- data UserAccess
- userAccess :: UserAccess
- uaAccountAccess :: Lens' UserAccess (Maybe AccountAccess)
- uaAccountId :: Lens' UserAccess (Maybe Text)
- uaEmailAddress :: Lens' UserAccess (Maybe Text)
- uaContainerAccess :: Lens' UserAccess [ContainerAccess]
- uaPermissionId :: Lens' UserAccess (Maybe Text)
- data Environment
- environment :: Environment
- eContainerId :: Lens' Environment (Maybe Text)
- eFingerprint :: Lens' Environment (Maybe Text)
- eContainerVersionId :: Lens' Environment (Maybe Text)
- eURL :: Lens' Environment (Maybe Text)
- eAuthorizationCode :: Lens' Environment (Maybe Text)
- eAccountId :: Lens' Environment (Maybe Text)
- eName :: Lens' Environment (Maybe Text)
- eEnableDebug :: Lens' Environment (Maybe Bool)
- eEnvironmentId :: Lens' Environment (Maybe Text)
- eType :: Lens' Environment (Maybe EnvironmentType)
- eAuthorizationTimestampMs :: Lens' Environment (Maybe Int64)
- eDescription :: Lens' Environment (Maybe Text)
- data AccountAccess
- accountAccess :: AccountAccess
- aaPermission :: Lens' AccountAccess [AccountAccessPermissionItem]
- data TriggerType
- data ContainerEnabledBuiltInVariableItem
- = CEBIVIAdvertiserId
- | CEBIVIAdvertisingTrackingEnabled
- | CEBIVIAppId
- | CEBIVIAppName
- | CEBIVIAppVersionCode
- | CEBIVIAppVersionName
- | CEBIVIClickClasses
- | CEBIVIClickElement
- | CEBIVIClickId
- | CEBIVIClickTarget
- | CEBIVIClickText
- | CEBIVIClickURL
- | CEBIVIContainerId
- | CEBIVIContainerVersion
- | CEBIVIDebugMode
- | CEBIVIDeviceName
- | CEBIVIEnvironmentName
- | CEBIVIErrorLine
- | CEBIVIErrorMessage
- | CEBIVIErrorURL
- | CEBIVIEvent
- | CEBIVIFormClasses
- | CEBIVIFormElement
- | CEBIVIFormId
- | CEBIVIFormTarget
- | CEBIVIFormText
- | CEBIVIFormURL
- | CEBIVIHistorySource
- | CEBIVIHTMLId
- | CEBIVILanguage
- | CEBIVINewHistoryFragment
- | CEBIVINewHistoryState
- | CEBIVIOldHistoryFragment
- | CEBIVIOldHistoryState
- | CEBIVIOSVersion
- | CEBIVIPageHostname
- | CEBIVIPagePath
- | CEBIVIPageURL
- | CEBIVIPlatform
- | CEBIVIRandomNumber
- | CEBIVIReferrer
- | CEBIVIResolution
- | CEBIVISdkVersion
- data ContainerUsageContextItem
- = Android
- | ANDROIdSDK5
- | Ios
- | IOSSDK5
- | Web
- data ConditionType
- data ListAccountsResponse
- listAccountsResponse :: ListAccountsResponse
- larAccounts :: Lens' ListAccountsResponse [Account]
- data AccountAccessPermissionItem
- data TagTagFiringOption
- data Rule
- rule :: Rule
- rContainerId :: Lens' Rule (Maybe Text)
- rFingerprint :: Lens' Rule (Maybe Text)
- rRuleId :: Lens' Rule (Maybe Text)
- rAccountId :: Lens' Rule (Maybe Text)
- rName :: Lens' Rule (Maybe Text)
- rNotes :: Lens' Rule (Maybe Text)
- rCondition :: Lens' Rule [Condition]
- data Folder
- folder :: Folder
- fContainerId :: Lens' Folder (Maybe Text)
- fFingerprint :: Lens' Folder (Maybe Text)
- fFolderId :: Lens' Folder (Maybe Text)
- fAccountId :: Lens' Folder (Maybe Text)
- fName :: Lens' Folder (Maybe Text)
- data Variable
- variable :: Variable
- vScheduleEndMs :: Lens' Variable (Maybe Int64)
- vParentFolderId :: Lens' Variable (Maybe Text)
- vContainerId :: Lens' Variable (Maybe Text)
- vFingerprint :: Lens' Variable (Maybe Text)
- vVariableId :: Lens' Variable (Maybe Text)
- vAccountId :: Lens' Variable (Maybe Text)
- vDisablingTriggerId :: Lens' Variable [Text]
- vName :: Lens' Variable (Maybe Text)
- vType :: Lens' Variable (Maybe Text)
- vScheduleStartMs :: Lens' Variable (Maybe Int64)
- vNotes :: Lens' Variable (Maybe Text)
- vEnablingTriggerId :: Lens' Variable [Text]
- vParameter :: Lens' Variable [Parameter]
- data ParameterType
- data Account
- account :: Account
- aaShareData :: Lens' Account (Maybe Bool)
- aaFingerprint :: Lens' Account (Maybe Text)
- aaAccountId :: Lens' Account (Maybe Text)
- aaName :: Lens' Account (Maybe Text)
- data ListContainerVersionsResponse
- listContainerVersionsResponse :: ListContainerVersionsResponse
- lcvrContainerVersionHeader :: Lens' ListContainerVersionsResponse [ContainerVersionHeader]
- lcvrContainerVersion :: Lens' ListContainerVersionsResponse [ContainerVersion]
- data Container
- container :: Container
- cPublicId :: Lens' Container (Maybe Text)
- cUsageContext :: Lens' Container [ContainerUsageContextItem]
- cEnabledBuiltInVariable :: Lens' Container [ContainerEnabledBuiltInVariableItem]
- cContainerId :: Lens' Container (Maybe Text)
- cFingerprint :: Lens' Container (Maybe Text)
- cTimeZoneCountryId :: Lens' Container (Maybe Text)
- cAccountId :: Lens' Container (Maybe Text)
- cDomainName :: Lens' Container [Text]
- cName :: Lens' Container (Maybe Text)
- cNotes :: Lens' Container (Maybe Text)
- cTimeZoneId :: Lens' Container (Maybe Text)
- data ListAccountUsersResponse
- listAccountUsersResponse :: ListAccountUsersResponse
- laurUserAccess :: Lens' ListAccountUsersResponse [UserAccess]
- data ContainerAccessPermissionItem
- data ContainerVersion
- containerVersion :: ContainerVersion
- cvMacro :: Lens' ContainerVersion [Macro]
- cvTag :: Lens' ContainerVersion [Tag]
- cvContainerId :: Lens' ContainerVersion (Maybe Text)
- cvFingerprint :: Lens' ContainerVersion (Maybe Text)
- cvContainerVersionId :: Lens' ContainerVersion (Maybe Text)
- cvRule :: Lens' ContainerVersion [Rule]
- cvFolder :: Lens' ContainerVersion [Folder]
- cvVariable :: Lens' ContainerVersion [Variable]
- cvAccountId :: Lens' ContainerVersion (Maybe Text)
- cvName :: Lens' ContainerVersion (Maybe Text)
- cvContainer :: Lens' ContainerVersion (Maybe Container)
- cvDeleted :: Lens' ContainerVersion (Maybe Bool)
- cvTrigger :: Lens' ContainerVersion [Trigger]
- cvNotes :: Lens' ContainerVersion (Maybe Text)
- data EnvironmentType
- data SetupTag
- setupTag :: SetupTag
- stTagName :: Lens' SetupTag (Maybe Text)
- stStopOnSetupFailure :: Lens' SetupTag (Maybe Bool)
- data ListContainersResponse
- listContainersResponse :: ListContainersResponse
- lcrContainers :: Lens' ListContainersResponse [Container]
- data Trigger
- trigger :: Trigger
- triCustomEventFilter :: Lens' Trigger [Condition]
- triParentFolderId :: Lens' Trigger (Maybe Text)
- triContainerId :: Lens' Trigger (Maybe Text)
- triTriggerId :: Lens' Trigger (Maybe Text)
- triCheckValidation :: Lens' Trigger (Maybe Parameter)
- triFingerprint :: Lens' Trigger (Maybe Text)
- triAutoEventFilter :: Lens' Trigger [Condition]
- triUniqueTriggerId :: Lens' Trigger (Maybe Parameter)
- triAccountId :: Lens' Trigger (Maybe Text)
- triName :: Lens' Trigger (Maybe Text)
- triInterval :: Lens' Trigger (Maybe Parameter)
- triEnableAllVideos :: Lens' Trigger (Maybe Parameter)
- triWaitForTagsTimeout :: Lens' Trigger (Maybe Parameter)
- triLimit :: Lens' Trigger (Maybe Parameter)
- triFilter :: Lens' Trigger [Condition]
- triType :: Lens' Trigger (Maybe TriggerType)
- triVideoPercentageList :: Lens' Trigger (Maybe Parameter)
- triEventName :: Lens' Trigger (Maybe Parameter)
- triWaitForTags :: Lens' Trigger (Maybe Parameter)
- data ListTagsResponse
- listTagsResponse :: ListTagsResponse
- ltrTags :: Lens' ListTagsResponse [Tag]
- data FolderEntities
- folderEntities :: FolderEntities
- feTag :: Lens' FolderEntities [Tag]
- feVariable :: Lens' FolderEntities [Variable]
- feTrigger :: Lens' FolderEntities [Trigger]
- data Condition
- condition :: Condition
- cType :: Lens' Condition (Maybe ConditionType)
- cParameter :: Lens' Condition [Parameter]
- data ContainerAccess
- containerAccess :: ContainerAccess
- caContainerId :: Lens' ContainerAccess (Maybe Text)
- caPermission :: Lens' ContainerAccess [ContainerAccessPermissionItem]
- data Parameter
- parameter :: Parameter
- pList :: Lens' Parameter [Parameter]
- pValue :: Lens' Parameter (Maybe Text)
- pMap :: Lens' Parameter [Parameter]
- pKey :: Lens' Parameter (Maybe Text)
- pType :: Lens' Parameter (Maybe ParameterType)
Service Configuration
tagManagerService :: ServiceConfig Source #
Default request referring to version v1
of the Tag Manager API. This contains the host and root path used as a starting point for constructing service requests.
OAuth Scopes
tagManagerReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/tagmanager.readonly"] Source #
View your Google Tag Manager containers
tagManagerEditContainersScope :: Proxy '["https://www.googleapis.com/auth/tagmanager.edit.containers"] Source #
Manage your Google Tag Manager containers
tagManagerManageAccountsScope :: Proxy '["https://www.googleapis.com/auth/tagmanager.manage.accounts"] Source #
Manage your Google Tag Manager accounts
tagManagerDeleteContainersScope :: Proxy '["https://www.googleapis.com/auth/tagmanager.delete.containers"] Source #
Delete your Google Tag Manager containers
tagManagerManageUsersScope :: Proxy '["https://www.googleapis.com/auth/tagmanager.manage.users"] Source #
Manage user permissions of your Google Tag Manager data
tagManagerPublishScope :: Proxy '["https://www.googleapis.com/auth/tagmanager.publish"] Source #
Publish your Google Tag Manager containers
tagManagerEditContainerversionsScope :: Proxy '["https://www.googleapis.com/auth/tagmanager.edit.containerversions"] Source #
Manage your Google Tag Manager container versions
ListVariablesResponse
data ListVariablesResponse Source #
List Variables Response.
See: listVariablesResponse
smart constructor.
listVariablesResponse :: ListVariablesResponse Source #
Creates a value of ListVariablesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lvrVariables :: Lens' ListVariablesResponse [Variable] Source #
All GTM Variables of a GTM Container.
ListFoldersResponse
data ListFoldersResponse Source #
List Folders Response.
See: listFoldersResponse
smart constructor.
listFoldersResponse :: ListFoldersResponse Source #
Creates a value of ListFoldersResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lfrFolders :: Lens' ListFoldersResponse [Folder] Source #
All GTM Folders of a GTM Container.
ListEnvironmentsResponse
data ListEnvironmentsResponse Source #
List Environments Response.
See: listEnvironmentsResponse
smart constructor.
listEnvironmentsResponse :: ListEnvironmentsResponse Source #
Creates a value of ListEnvironmentsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lerEnvironments :: Lens' ListEnvironmentsResponse [Environment] Source #
All Environments of a GTM Container.
PublishContainerVersionResponse
data PublishContainerVersionResponse Source #
Publish container version response.
See: publishContainerVersionResponse
smart constructor.
publishContainerVersionResponse :: PublishContainerVersionResponse Source #
Creates a value of PublishContainerVersionResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pcvrCompilerError :: Lens' PublishContainerVersionResponse (Maybe Bool) Source #
Compiler errors or not.
pcvrContainerVersion :: Lens' PublishContainerVersionResponse (Maybe ContainerVersion) Source #
The container version created.
ContainerVersionHeader
data ContainerVersionHeader Source #
Represents a Google Tag Manager Container Version Header.
See: containerVersionHeader
smart constructor.
containerVersionHeader :: ContainerVersionHeader Source #
Creates a value of ContainerVersionHeader
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cvhNumTags :: Lens' ContainerVersionHeader (Maybe Text) Source #
Number of tags in the container version.
cvhNumMacros :: Lens' ContainerVersionHeader (Maybe Text) Source #
Number of macros in the container version.
cvhContainerId :: Lens' ContainerVersionHeader (Maybe Text) Source #
GTM Container ID.
cvhContainerVersionId :: Lens' ContainerVersionHeader (Maybe Text) Source #
The Container Version ID uniquely identifies the GTM Container Version.
cvhAccountId :: Lens' ContainerVersionHeader (Maybe Text) Source #
GTM Account ID.
cvhNumTriggers :: Lens' ContainerVersionHeader (Maybe Text) Source #
Number of triggers in the container version.
cvhDeleted :: Lens' ContainerVersionHeader (Maybe Bool) Source #
A value of true indicates this container version has been deleted.
cvhNumRules :: Lens' ContainerVersionHeader (Maybe Text) Source #
Number of rules in the container version.
cvhNumVariables :: Lens' ContainerVersionHeader (Maybe Text) Source #
Number of variables in the container version.
TeardownTag
data TeardownTag Source #
teardownTag :: TeardownTag Source #
Creates a value of TeardownTag
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ttStopTeardownOnFailure :: Lens' TeardownTag (Maybe Bool) Source #
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.
ListTriggersResponse
data ListTriggersResponse Source #
List triggers response.
See: listTriggersResponse
smart constructor.
listTriggersResponse :: ListTriggersResponse Source #
Creates a value of ListTriggersResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ltrTriggers :: Lens' ListTriggersResponse [Trigger] Source #
All GTM Triggers of a GTM Container.
Macro
Represents a Google Tag Manager Macro.
See: macro
smart constructor.
Creates a value of Macro
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mScheduleEndMs :: Lens' Macro (Maybe Int64) Source #
The end timestamp in milliseconds to schedule a macro.
mDisablingRuleId :: Lens' Macro [Text] Source #
For mobile containers only: A list of rule IDs for disabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set.
mFingerprint :: Lens' Macro (Maybe Text) Source #
The fingerprint of the GTM Macro as computed at storage time. This value is recomputed whenever the macro is modified.
mEnablingRuleId :: Lens' Macro [Text] Source #
For mobile containers only: A list of rule IDs for enabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set.
mScheduleStartMs :: Lens' Macro (Maybe Int64) Source #
The start timestamp in milliseconds to schedule a macro.
Tag
Represents a Google Tag Manager Tag.
See: tag
smart constructor.
Creates a value of Tag
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tBlockingTriggerId :: Lens' Tag [Text] Source #
Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag will not fire.
tScheduleEndMs :: Lens' Tag (Maybe Int64) Source #
The end timestamp in milliseconds to schedule a tag.
tLiveOnly :: Lens' Tag (Maybe Bool) Source #
If set to true, this tag will only fire in the live environment (e.g. not in preview or debug mode).
tPriority :: Lens' Tag (Maybe Parameter) Source #
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.
tTeardownTag :: Lens' Tag [TeardownTag] Source #
The list of teardown tags. Currently we only allow one.
tFingerprint :: Lens' Tag (Maybe Text) Source #
The fingerprint of the GTM Tag as computed at storage time. This value is recomputed whenever the tag is modified.
tTagFiringOption :: Lens' Tag (Maybe TagTagFiringOption) Source #
Option to fire this tag.
tBlockingRuleId :: Lens' Tag [Text] Source #
Blocking rule IDs. If any of the listed rules evaluate to true, the tag will not fire.
tFiringTriggerId :: Lens' Tag [Text] Source #
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.
tScheduleStartMs :: Lens' Tag (Maybe Int64) Source #
The start timestamp in milliseconds to schedule a tag.
tFiringRuleId :: Lens' Tag [Text] Source #
Firing rule IDs. A tag will fire when any of the listed rules are true and all of its blockingRuleIds (if any specified) are false.
CreateContainerVersionResponse
data CreateContainerVersionResponse Source #
Create container versions response.
See: createContainerVersionResponse
smart constructor.
createContainerVersionResponse :: CreateContainerVersionResponse Source #
Creates a value of CreateContainerVersionResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ccvrCompilerError :: Lens' CreateContainerVersionResponse (Maybe Bool) Source #
Compiler errors or not.
ccvrContainerVersion :: Lens' CreateContainerVersionResponse (Maybe ContainerVersion) Source #
The container version created.
CreateContainerVersionRequestVersionOptions
data CreateContainerVersionRequestVersionOptions Source #
Options for new container versions.
See: createContainerVersionRequestVersionOptions
smart constructor.
createContainerVersionRequestVersionOptions :: CreateContainerVersionRequestVersionOptions Source #
Creates a value of CreateContainerVersionRequestVersionOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ccvrvoName :: Lens' CreateContainerVersionRequestVersionOptions (Maybe Text) Source #
The name of the container version to be created.
ccvrvoQuickPreview :: Lens' CreateContainerVersionRequestVersionOptions (Maybe Bool) Source #
The creation of this version may be for quick preview and shouldn't be saved.
ccvrvoNotes :: Lens' CreateContainerVersionRequestVersionOptions (Maybe Text) Source #
The notes of the container version to be created.
UserAccess
data UserAccess Source #
Represents a user's permissions to an account and its container.
See: userAccess
smart constructor.
userAccess :: UserAccess Source #
Creates a value of UserAccess
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
uaAccountAccess :: Lens' UserAccess (Maybe AccountAccess) Source #
GTM Account access permissions.
uaAccountId :: Lens' UserAccess (Maybe Text) Source #
GTM Account ID.
uaEmailAddress :: Lens' UserAccess (Maybe Text) Source #
User's email address.
uaContainerAccess :: Lens' UserAccess [ContainerAccess] Source #
GTM Container access permissions.
uaPermissionId :: Lens' UserAccess (Maybe Text) Source #
Account Permission ID.
Environment
data Environment Source #
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.
See: environment
smart constructor.
environment :: Environment Source #
Creates a value of Environment
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eContainerId :: Lens' Environment (Maybe Text) Source #
GTM Container ID.
eFingerprint :: Lens' Environment (Maybe Text) Source #
The fingerprint of the GTM environment as computed at storage time. This value is recomputed whenever the environment is modified.
eAuthorizationCode :: Lens' Environment (Maybe Text) Source #
The environment authorization code.
eAccountId :: Lens' Environment (Maybe Text) Source #
GTM Account ID.
eName :: Lens' Environment (Maybe Text) Source #
The environment display name. Can be set or changed only on USER type environments.
eEnableDebug :: Lens' Environment (Maybe Bool) Source #
Whether or not to enable debug by default on for the environment.
eEnvironmentId :: Lens' Environment (Maybe Text) Source #
GTM Environment ID uniquely identifies the GTM Environment.
eType :: Lens' Environment (Maybe EnvironmentType) Source #
The type of this environment.
eAuthorizationTimestampMs :: Lens' Environment (Maybe Int64) Source #
The last update time-stamp for the authorization code.
eDescription :: Lens' Environment (Maybe Text) Source #
The environment description. Can be set or changed only on USER type environments.
AccountAccess
data AccountAccess Source #
Defines the Google Tag Manager Account access permissions.
See: accountAccess
smart constructor.
accountAccess :: AccountAccess Source #
Creates a value of AccountAccess
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aaPermission :: Lens' AccountAccess [AccountAccessPermissionItem] Source #
List of Account permissions. Valid account permissions are read and manage.
TriggerType
data TriggerType Source #
Defines the data layer event that causes this trigger.
AjaxSubmission | ajaxSubmission |
Always | always |
Click | click |
CustomEvent | customEvent |
DomReady | domReady |
FormSubmission | formSubmission |
HistoryChange | historyChange |
JsError | jsError |
LinkClick | linkClick |
Pageview | pageview |
Timer | timer |
WindowLoaded | windowLoaded |
YouTube | youTube |
ContainerEnabledBuiltInVariableItem
data ContainerEnabledBuiltInVariableItem Source #
ContainerUsageContextItem
data ContainerUsageContextItem Source #
Android | android |
ANDROIdSDK5 | androidSdk5 |
Ios | ios |
IOSSDK5 | iosSdk5 |
Web | web |
ConditionType
data ConditionType Source #
The type of operator for this condition.
Contains | contains |
CssSelector | cssSelector |
EndsWith | endsWith |
Equals | equals |
Greater | greater |
GreaterOrEquals | greaterOrEquals |
Less | less |
LessOrEquals | lessOrEquals |
MatchRegex | matchRegex |
StartsWith | startsWith |
URLMatches | urlMatches |
ListAccountsResponse
data ListAccountsResponse Source #
List Accounts Response.
See: listAccountsResponse
smart constructor.
listAccountsResponse :: ListAccountsResponse Source #
Creates a value of ListAccountsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
larAccounts :: Lens' ListAccountsResponse [Account] Source #
List of GTM Accounts that a user has access to.
AccountAccessPermissionItem
data AccountAccessPermissionItem Source #
TagTagFiringOption
data TagTagFiringOption Source #
Option to fire this tag.
OncePerEvent | oncePerEvent |
OncePerLoad | oncePerLoad |
Unlimited | unlimited |
Rule
Represents a Google Tag Manager Rule.
See: rule
smart constructor.
Creates a value of Rule
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rFingerprint :: Lens' Rule (Maybe Text) Source #
The fingerprint of the GTM Rule as computed at storage time. This value is recomputed whenever the rule is modified.
rCondition :: Lens' Rule [Condition] Source #
The list of conditions that make up this rule (implicit AND between them).
Folder
Represents a Google Tag Manager Folder.
See: folder
smart constructor.
Creates a value of Folder
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
fFingerprint :: Lens' Folder (Maybe Text) Source #
The fingerprint of the GTM Folder as computed at storage time. This value is recomputed whenever the folder is modified.
Variable
Represents a Google Tag Manager Variable.
See: variable
smart constructor.
Creates a value of Variable
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
vScheduleEndMs :: Lens' Variable (Maybe Int64) Source #
The end timestamp in milliseconds to schedule a variable.
vFingerprint :: Lens' Variable (Maybe Text) Source #
The fingerprint of the GTM Variable as computed at storage time. This value is recomputed whenever the variable is modified.
vVariableId :: Lens' Variable (Maybe Text) Source #
The Variable ID uniquely identifies the GTM Variable.
vDisablingTriggerId :: Lens' Variable [Text] Source #
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.
vScheduleStartMs :: Lens' Variable (Maybe Int64) Source #
The start timestamp in milliseconds to schedule a variable.
vNotes :: Lens' Variable (Maybe Text) Source #
User notes on how to apply this variable in the container.
vEnablingTriggerId :: Lens' Variable [Text] Source #
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.
ParameterType
data ParameterType Source #
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)
Account
Represents a Google Tag Manager Account.
See: account
smart constructor.
Creates a value of Account
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aaShareData :: Lens' Account (Maybe Bool) Source #
Whether the account shares data anonymously with Google and others.
aaFingerprint :: Lens' Account (Maybe Text) Source #
The fingerprint of the GTM Account as computed at storage time. This value is recomputed whenever the account is modified.
aaAccountId :: Lens' Account (Maybe Text) Source #
The Account ID uniquely identifies the GTM Account.
ListContainerVersionsResponse
data ListContainerVersionsResponse Source #
List container versions response.
See: listContainerVersionsResponse
smart constructor.
listContainerVersionsResponse :: ListContainerVersionsResponse Source #
Creates a value of ListContainerVersionsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lcvrContainerVersionHeader :: Lens' ListContainerVersionsResponse [ContainerVersionHeader] Source #
All container version headers of a GTM Container.
lcvrContainerVersion :: Lens' ListContainerVersionsResponse [ContainerVersion] Source #
All versions of a GTM Container.
Container
Represents a Google Tag Manager Container.
See: container
smart constructor.
container :: Container Source #
Creates a value of Container
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cUsageContext :: Lens' Container [ContainerUsageContextItem] Source #
List of Usage Contexts for the Container. Valid values include: web, android, ios.
cEnabledBuiltInVariable :: Lens' Container [ContainerEnabledBuiltInVariableItem] Source #
List of enabled built-in variables. Valid values include: pageUrl, pageHostname, pagePath, referrer, event, clickElement, clickClasses, clickId, clickTarget, clickUrl, clickText, formElement, formClasses, formId, formTarget, formUrl, formText, errorMessage, errorUrl, errorLine, newHistoryFragment, oldHistoryFragment, newHistoryState, oldHistoryState, historySource, containerVersion, debugMode, randomNumber, containerId.
cContainerId :: Lens' Container (Maybe Text) Source #
The Container ID uniquely identifies the GTM Container.
cFingerprint :: Lens' Container (Maybe Text) Source #
The fingerprint of the GTM Container as computed at storage time. This value is recomputed whenever the account is modified.
cDomainName :: Lens' Container [Text] Source #
Optional list of domain names associated with the Container.
ListAccountUsersResponse
data ListAccountUsersResponse Source #
List AccountUsers Response.
See: listAccountUsersResponse
smart constructor.
listAccountUsersResponse :: ListAccountUsersResponse Source #
Creates a value of ListAccountUsersResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
laurUserAccess :: Lens' ListAccountUsersResponse [UserAccess] Source #
All GTM AccountUsers of a GTM Account.
ContainerAccessPermissionItem
data ContainerAccessPermissionItem Source #
CAPIDelete' | delete |
CAPIEdit | edit |
CAPIManage | manage |
CAPIPublish | publish |
CAPIRead' | read |
ContainerVersion
data ContainerVersion Source #
Represents a Google Tag Manager Container Version.
See: containerVersion
smart constructor.
containerVersion :: ContainerVersion Source #
Creates a value of ContainerVersion
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cvMacro :: Lens' ContainerVersion [Macro] Source #
The macros in the container that this version was taken from.
cvTag :: Lens' ContainerVersion [Tag] Source #
The tags in the container that this version was taken from.
cvContainerId :: Lens' ContainerVersion (Maybe Text) Source #
GTM Container ID.
cvFingerprint :: Lens' ContainerVersion (Maybe Text) Source #
The fingerprint of the GTM Container Version as computed at storage time. This value is recomputed whenever the container version is modified.
cvContainerVersionId :: Lens' ContainerVersion (Maybe Text) Source #
The Container Version ID uniquely identifies the GTM Container Version.
cvRule :: Lens' ContainerVersion [Rule] Source #
The rules in the container that this version was taken from.
cvFolder :: Lens' ContainerVersion [Folder] Source #
The folders in the container that this version was taken from.
cvVariable :: Lens' ContainerVersion [Variable] Source #
The variables in the container that this version was taken from.
cvAccountId :: Lens' ContainerVersion (Maybe Text) Source #
GTM Account ID.
cvContainer :: Lens' ContainerVersion (Maybe Container) Source #
The container that this version was taken from.
cvDeleted :: Lens' ContainerVersion (Maybe Bool) Source #
A value of true indicates this container version has been deleted.
cvTrigger :: Lens' ContainerVersion [Trigger] Source #
The triggers in the container that this version was taken from.
cvNotes :: Lens' ContainerVersion (Maybe Text) Source #
User notes on how to apply this container version in the container.
EnvironmentType
data EnvironmentType Source #
The type of this environment.
SetupTag
Creates a value of SetupTag
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
stStopOnSetupFailure :: Lens' SetupTag (Maybe Bool) Source #
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.
ListContainersResponse
data ListContainersResponse Source #
List Containers Response.
See: listContainersResponse
smart constructor.
listContainersResponse :: ListContainersResponse Source #
Creates a value of ListContainersResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lcrContainers :: Lens' ListContainersResponse [Container] Source #
All Containers of a GTM Account.
Trigger
Represents a Google Tag Manager Trigger
See: trigger
smart constructor.
Creates a value of Trigger
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
triCustomEventFilter :: Lens' Trigger [Condition] Source #
Used in the case of custom event, which is fired iff all Conditions are true.
triTriggerId :: Lens' Trigger (Maybe Text) Source #
The Trigger ID uniquely identifies the GTM Trigger.
triCheckValidation :: Lens' Trigger (Maybe Parameter) Source #
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.
triFingerprint :: Lens' Trigger (Maybe Text) Source #
The fingerprint of the GTM Trigger as computed at storage time. This value is recomputed whenever the trigger is modified.
triUniqueTriggerId :: Lens' Trigger (Maybe Parameter) Source #
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.
triInterval :: Lens' Trigger (Maybe Parameter) Source #
Time between triggering recurring Timer Events (in milliseconds). Only valid for Timer triggers.
triEnableAllVideos :: Lens' Trigger (Maybe Parameter) Source #
Reloads the videos in the page that don't already have the YT API enabled. If false, only capture events from videos that already have the API enabled. Only valid for YouTube triggers.
triWaitForTagsTimeout :: Lens' Trigger (Maybe Parameter) Source #
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.
triLimit :: Lens' Trigger (Maybe Parameter) Source #
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.
triFilter :: Lens' Trigger [Condition] Source #
The trigger will only fire iff all Conditions are true.
triType :: Lens' Trigger (Maybe TriggerType) Source #
Defines the data layer event that causes this trigger.
triVideoPercentageList :: Lens' Trigger (Maybe Parameter) Source #
List of integer percentage values. The trigger will fire as each percentage is reached in any instrumented videos. Only valid for YouTube triggers.
triEventName :: Lens' Trigger (Maybe Parameter) Source #
Name of the GTM event that is fired. Only valid for Timer triggers.
triWaitForTags :: Lens' Trigger (Maybe Parameter) Source #
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.
ListTagsResponse
data ListTagsResponse Source #
List Tags Response.
See: listTagsResponse
smart constructor.
listTagsResponse :: ListTagsResponse Source #
Creates a value of ListTagsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
FolderEntities
data FolderEntities Source #
Represents a Google Tag Manager Folder's contents.
See: folderEntities
smart constructor.
folderEntities :: FolderEntities Source #
Creates a value of FolderEntities
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
feVariable :: Lens' FolderEntities [Variable] Source #
The list of variables inside the folder.
Condition
Represents a predicate.
See: condition
smart constructor.
condition :: Condition Source #
Creates a value of Condition
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cParameter :: Lens' Condition [Parameter] Source #
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.
ContainerAccess
data ContainerAccess Source #
Defines the Google Tag Manager Container access permissions.
See: containerAccess
smart constructor.
containerAccess :: ContainerAccess Source #
Creates a value of ContainerAccess
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
caContainerId :: Lens' ContainerAccess (Maybe Text) Source #
GTM Container ID.
caPermission :: Lens' ContainerAccess [ContainerAccessPermissionItem] Source #
List of Container permissions. Valid container permissions are: read, edit, delete, publish.
Parameter
Represents a Google Tag Manager Parameter.
See: parameter
smart constructor.
pList :: Lens' Parameter [Parameter] Source #
This list parameter's parameters (keys will be ignored).
pValue :: Lens' Parameter (Maybe Text) Source #
A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
pMap :: Lens' Parameter [Parameter] Source #
This map parameter's parameters (must have keys; keys must be unique).
pKey :: Lens' Parameter (Maybe Text) Source #
The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
pType :: Lens' Parameter (Maybe ParameterType) Source #
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)