config

type Config struct {
	// Config version
	Version string `json:"version" yaml:"version" jsonschema:"required"`
	// Globally redact visitor ip
	RedactVisitorIP bool `json:"redactVisitorIp" yaml:"redactVisitorIp"`
	// Enable region specific settings
	// https://developers.google.com/tag-platform/tag-manager/server-side/enable-region-specific-settings
	EnableGeoResolution bool `json:"enableGeoResolution" yaml:"enableGeoResolution"`
	// Google Tag settings
	GoogleTag GoogleTag `json:"googleTag" yaml:"googleTag"`
	// Google API settings
	GoogleAPI GoogleAPI `json:"googleApi" yaml:"googleApi"`
	// Google Tag Manager settings
	GoogleTagManager GoogleTagManager `json:"googleTagManager" yaml:"googleTagManager"`
	// Google Ads provider settings
	GoogleAds GoogleAds `json:"googleAds" yaml:"googleAds"`
	// CookieBot provider settings
	Cookiebot Cookiebot `json:"cookiebot" yaml:"cookiebot"`
	// Google Analytics provider settings
	GoogleAnalytics GoogleAnalytics `json:"googleAnalytics" yaml:"googleAnalytics"`
	// Conversion Linker provider settings
	ConversionLinker ConversionLinker `json:"conversionLinker" yaml:"conversionLinker"`
	// Facebook provider settings
	Facebook Facebook `json:"facebook" yaml:"facebook"`
	// MicrosoftAds provider settings
	MicrosoftAds MicrosoftAds `json:"microsoftAds" yaml:"microsoftAds"`
	// OpenAIAds provider settings
	OpenAIAds OpenAIAds `json:"openaiAds" yaml:"openaiAds"`
	// Mixpanel provider settings
	Mixpanel Mixpanel `json:"mixpanel" yaml:"mixpanel"`
	// Pinterest provider settings
	Pinterest Pinterest `json:"pinterest" yaml:"pinterest"`
	// Emarsys provider settings
	Emarsys Emarsys `json:"emarsys" yaml:"emarsys"`
	// Hotjar provider settings
	Hotjar Hotjar `json:"hotjar" yaml:"hotjar"`
	// Criteo provider settings
	Criteo Criteo `json:"criteo" yaml:"criteo"`
	// Tracify provider settings
	Tracify Tracify `json:"tracify" yaml:"tracify"`
	// Umami provider settings
	Umami Umami `json:"umami" yaml:"umami"`
	// UTM provider settings
	Utm Utm `json:"utm" yaml:"utm"`
}

type ConversionLinker struct {
	// Enable provider
	Enabled bool `json:"enabled" yaml:"enabled"`
	// Google Consent settings
	GoogleConsent GoogleConsent `json:"googleConsent" yaml:"googleConsent"`
	// Accept incoming linker parameters
	EnableLinkerParams bool `json:"enableLinkerParams" yaml:"enableLinkerParams"`
}

type Cookiebot struct {
	// Enable provider
	Enabled bool `json:"enabled" yaml:"enabled"`
	// Name of the manually installed Cookiebot CMP tag template
	TemplateName string `json:"templateName" yaml:"templateName"`
	// Create an account on Cookiebot.com and copy 'Domain Group ID' from the tab 'Your Scripts' in Cookiebot
	CookiebotID string `json:"cookiebotId" yaml:"cookiebotId"`
	// Select which CDN region Cookiebot uses
	CDNRegion string `json:"cdnRegion" yaml:"cdnRegion"`
	// When using URL passthrough, a few query parameters may be appended to links as users navigate through pages on your website
	URLPassthrough bool `json:"urlPassthrough" yaml:"urlPassthrough"`
	// If enabled, Google will deduce ad_storage, ad_user_data and ad_personalization data from the TC string.
	AdvertiserConsentModeEnabled bool `json:"advertiserConsentModeEnabled" yaml:"advertiserConsentModeEnabled"`
	// Default Consent state
	RegionSettings []CookiebotRegionSetting `json:"regionSettings" yaml:"regionSettings"`
	// Custom tag template settings
	Templates CookiebotTemplates `json:"templates" yaml:"templates"`
}

type CookiebotRegionSetting struct {
	// Region (leave blank to apply globally)
	Region string `json:"region" yaml:"region"`
	// Default consent for functionality_storage and personalization_storage
	Preferences string `json:"preferences" yaml:"preferences"`
	// Default consent for analytics_storage
	Statistics string `json:"statistics" yaml:"statistics"`
	// Default consent for ad_storage
	Marketing string `json:"marketing" yaml:"marketing"`
	// Default consent ad_user_data
	AdUserData string `json:"adUserData" yaml:"adUserData"`
	// Default consent ad_personalization
	AdPersonalization string `json:"adPersonalization" yaml:"adPersonalization"`
}

type CookiebotTemplates struct {
	// Path to a custom cmp tag template file, defaults to the manually installed one
	Tag string `json:"tag" yaml:"tag"`
}

type Criteo struct {
	// Enable provider
	Enabled bool `json:"enabled" yaml:"enabled"`
	// Criteo caller id
	CallerID string `json:"callerId" yaml:"callerId"`
	// Criteo partner id
	PartnerID string `json:"partnerId" yaml:"partnerId"`
	// Criteo application id
	ApplicationID string `json:"applicationId" yaml:"applicationId"`
	// Custom tag template settings
	Templates CriteoTemplates `json:"templates" yaml:"templates"`
	// Google Consent settings
	GoogleConsent GoogleConsent `json:"googleConsent" yaml:"googleConsent"`
	// Google Tag Manager server container settings
	ServerContainer contemplate.Config `json:"serverContainer" yaml:"serverContainer"`
}

type CriteoTemplates struct {
	// Path to a custom events api tag template file, defaults to the manually installed one
	EventsAPITag string `json:"eventsApiTag" yaml:"eventsApiTag"`
	// Path to a custom user identification template file, defaults to the manually installed one
	UserIdentification string `json:"userIdentification" yaml:"userIdentification"`
}

type Emarsys struct {
	// Enable provider
	Enabled bool `json:"enabled" yaml:"enabled"`
	// Emarsys merchant id
	MerchantID string `json:"merchantId" yaml:"merchantId"`
	// Enable test mode
	TestMode bool `json:"testMode" yaml:"testMode"`
	// Enable debug mode
	DebugMode bool `json:"debugMode" yaml:"debugMode"`
	// Custom tag template settings
	Templates EmarsysTemplates `json:"templates" yaml:"templates"`
	// Google Consent settings
	GoogleConsent GoogleConsent `json:"googleConsent" yaml:"googleConsent"`
	// Google Tag Manager web container settings
	WebContainer contemplate.Config `json:"webContainer" yaml:"webContainer"`
	// Google Tag Manager server container settings
	ServerContainer contemplate.Config `json:"serverContainer" yaml:"serverContainer"`
}

type EmarsysTemplates struct {
	// Path to a custom web extend tag template file, defaults to the embedded one
	WebExtendTag string `json:"webExtendTag" yaml:"webExtendTag"`
	// Path to a custom initialization client template file, defaults to the embedded one
	InitializationClient string `json:"initializationClient" yaml:"initializationClient"`
	// Path to a custom initialization tag template file, defaults to the embedded one
	InitializationTag string `json:"initializationTag" yaml:"initializationTag"`
}

type Facebook struct {
	// Enable provider
	Enabled        bool   `json:"enabled" yaml:"enabled"`
	PixelID        string `json:"pixelId" yaml:"pixelId"`
	APIAccessToken string `json:"apiAccessToken" yaml:"apiAccessToken"`
	TestEventToken string `json:"testEventToken" yaml:"testEventToken"`
	// Custom tag template settings
	Templates FacebookTemplates `json:"templates" yaml:"templates"`
	// Google Consent settings
	GoogleConsent GoogleConsent `json:"googleConsent" yaml:"googleConsent"`
	// Google Tag Manager server container settings
	ServerContainer FacebookServerContainer `json:"serverContainer" yaml:"serverContainer"`
}

type FacebookConversionAPITag struct {
	// Extend Meta Pixel cookies (fbp/fbc)
	ExtendCookies bool `json:"extendCookies" yaml:"extendCookies"`
	// Enable Use of HTTP Only Secure Cookie (gtmeec) to Enhance Event Data
	EnableEventEnhancement bool `json:"enableEventEnhancement" yaml:"enableEventEnhancement"`
}

type FacebookServerContainer struct {
	contemplate.Config `json:",inline" yaml:",squash"`
	Settings           map[string]FacebookConversionAPITag `json:"settings" yaml:"settings"`
}

type FacebookTemplates struct {
	// Path to a custom conversions api tag template file, defaults to the manually installed one
	ConversionsAPITag string `json:"conversionsApiTag" yaml:"conversionsApiTag"`
}

type GoogleAPI struct {
	Credentials     string `json:"credentials" yaml:"credentials"`
	CredentialsFile string `json:"credentialsFile" yaml:"credentialsFile"`
	RequestQuota    int    `json:"requestQuota" yaml:"requestQuota"`
}

type GoogleAds struct {
	// Enable provider
	Enabled bool `json:"enabled" yaml:"enabled"`
	// Google Consent settings
	GoogleConsent GoogleConsent `json:"googleConsent" yaml:"googleConsent"`
	// Conversion id
	ConversionID string `json:"conversionId" yaml:"conversionId"`
	// Google Ads Conversion settings
	Conversion GoogleAdsConversion `json:"conversion" yaml:"conversion"`
	// Google Ads Remarketing settings
	Remarketing GoogleAdsRemarketing `json:"remarketing" yaml:"remarketing"`
}

type GoogleAdsConversion struct {
	// Enable provider
	Enabled bool `json:"enabled" yaml:"enabled"`
	// Google Tag Manager server container settings
	ServerContainer GoogleAdsConversionServerContainer `json:"serverContainer" yaml:"serverContainer"`
}

type GoogleAdsConversionServerContainer struct {
	contemplate.Config `json:",inline" yaml:",squash"`
	// Conversion settings map
	Settings map[string][]GoogleAdsConversionTracking `json:"settings" yaml:"settings"`
}

type GoogleAdsConversionTracking struct {
	// Conversion label
	Label string `json:"label" yaml:"label"`
	// Optional conversion id overriding the default
	ConversionID string `json:"conversionId" yaml:"conversionId"`
}

type GoogleAdsRemarketing struct {
	// Enable provider
	Enabled                bool `json:"enabled" yaml:"enabled"`
	EnableConversionLinker bool `json:"enableConversionLinker" yaml:"enableConversionLinker"`
}

type GoogleAnalytics struct {
	// Enable provider
	Enabled bool `json:"enabled" yaml:"enabled"`
	// Google Analytics account id
	AccountID string `json:"accountId" yaml:"accountId"`
	// Google Analytics property id
	PropertyID string `json:"propertyId" yaml:"propertyId"`
	// Google Consent settings
	GoogleConsent GoogleConsent `json:"googleConsent" yaml:"googleConsent"`
	// GTag.js override configuration
	GoogleGTagJSOverride GoogleAnalyticsGTagJSOverride `json:"googleGTagJSOverride" yaml:"googleGTagJSOverride"`
	// Enable mpv2 user data transformation (experimental)
	EnableMPv2UserDataTransformation bool `json:"enableMPv2UserDataTransformation" yaml:"enableMPv2UserDataTransformation"`
	// Custom tag template settings
	Templates GoogleAnalyticsTemplates `json:"templates" yaml:"templates"`
	// Google Tag Manager web container settings
	WebContainer contemplate.Config `json:"webContainer" yaml:"webContainer"`
	// Google Tag Manager server container settings
	ServerContainer contemplate.Config `json:"serverContainer" yaml:"serverContainer"`
}

type GoogleAnalyticsGTagJSOverride struct {
	// Enable override
	Enabled bool `json:"enabled" yaml:"enabled"`
	// Client priority
	Priority int64 `json:"priority" yaml:"priority"`
	// Allow sending items for non ecommerce events
	EcommerceItems bool `json:"ecommerceItems" yaml:"ecommerceItems"`
}

type GoogleAnalyticsTemplates struct {
	// Path to a custom json request value variable template file, defaults to the embedded one
	JSONRequestValueVariable string `json:"jsonRequestValueVariable" yaml:"jsonRequestValueVariable"`
	// Path to a custom gtag client template file, defaults to the embedded one
	GTagClient string `json:"gtagClient" yaml:"gtagClient"`
}

type GoogleConsent struct {
	// Enable provider
	Enabled bool   `json:"enabled" yaml:"enabled"`
	Mode    string `json:"mode" yaml:"mode"`
}

type GoogleTag struct {
	// A tag ID is an identifier that you put on your page to load a given Google tag
	TagID string `json:"tagId" yaml:"tagId"`
	// Whether a page_view should be sent on initial load
	SendPageView bool `json:"sendPageView" yaml:"sendPageView"`
	// Optional custom server container url
	ServerContainerURL string `json:"serverContainerUrl" yaml:"serverContainerUrl"`
	// Data layer variables to be added to the event settings
	DataLayerVariables map[string]string `json:"dataLayerVariables" yaml:"dataLayerVariables"`
	// TypeScript settings
	TypeScript TypeScript `json:"typeScript" yaml:"typeScript"`
}

type GoogleTagManager struct {
	// Google Tag Manager account id
	AccountID string `json:"accountId" yaml:"accountId"`
	// Google Tag Manager web container settings
	WebContainer GoogleTagManagerContainer `json:"webContainer" yaml:"webContainer"`
	// Google Tag Manager server container settings
	ServerContainer GoogleTagManagerContainer `json:"serverContainer" yaml:"serverContainer"`
	// Google Tag Manager web container variables
	WebContaienrVariables GoogleTagManagerWebContainerVariables `json:"webContainerVariables" yaml:"webContainerVariables"`
	// Google Tag Manager server container variables
	ServerContaienrVariables GoogleTagManagerServerContainerVariables `json:"serverContainerVariables" yaml:"serverContainerVariables"`
}

type GoogleTagManagerContainer struct {
	// The container tag id
	TagID string `json:"tagId" yaml:"tagId"`
	// The container id
	ContainerID string `json:"containerId" yaml:"containerId"`
	// (Optional) The workspace id that should be used by the api
	WorkspaceID string `json:"workspaceId" yaml:"workspaceId"`
	// (Optional) The workspace name that should be used by the api
	Workspace string `json:"workspace" yaml:"workspace"`
}

type GoogleTagManagerServerContainerVariables struct {
	// List of event data variables
	EventData []string `json:"eventData" yaml:"eventData"`
	// Map of lookup table variables
	LookupTables map[string]LookupTable `json:"lookupTables" yaml:"lookupTables"`
}

type GoogleTagManagerWebContainerVariables struct {
	// List of event data variables
	DataLayer []string `json:"dataLayer" yaml:"dataLayer"`
	// Map of lookup table variables
	LookupTables map[string]LookupTable `json:"lookupTables" yaml:"lookupTables"`
}

type Hotjar struct {
	// Enable provider
	Enabled bool   `json:"enabled" yaml:"enabled"`
	SiteID  string `json:"siteId" yaml:"siteId"`
}

type LookupTable struct {
	// Input source
	Input string `json:"input" yaml:"input"`
	// Key value data map
	KeyTable map[string]string `json:"keyTable" yaml:"keyTable"`
	// Vaule key data map
	ValueTable map[string]string `json:"valueTable" yaml:"valueTable"`
}

type MicrosoftAds struct {
	// Enable provider
	Enabled bool `json:"enabled" yaml:"enabled"`
	// Google Consent settings
	GoogleConsent GoogleConsent `json:"googleConsent" yaml:"googleConsent"`
	// Microsoft Ads UET Tag ID
	TagID string `json:"tagId" yaml:"tagId"`
	// Microsoft Ads Conversion settings
	Conversion MicrosoftAdsConversion `json:"conversion" yaml:"conversion"`
	// Custom tag template settings
	Templates MicrosoftAdsTemplates `json:"templates" yaml:"templates"`
}

type MicrosoftAdsConversion struct {
	// Enable provider
	Enabled bool `json:"enabled" yaml:"enabled"`
	// Google Tag Manager server container settings
	ServerContainer MicrosoftAdsServerContainer `json:"serverContainer" yaml:"serverContainer"`
}

type MicrosoftAdsConversionTag struct {
	PageType  string `json:"pageType" yaml:"pageType"`
	EventType string `json:"eventType" yaml:"eventType"`
}

type MicrosoftAdsServerContainer struct {
	contemplate.Config `json:",inline" yaml:",squash"`
	Settings           map[string]MicrosoftAdsConversionTag `json:"settings" yaml:"settings"`
}

type MicrosoftAdsTemplates struct {
	// Path to a custom conversion tag template file, defaults to the embedded one
	ConversionTag string `json:"conversionTag" yaml:"conversionTag"`
}

type Mixpanel struct {
	// Enable provider
	Enabled bool `json:"enabled" yaml:"enabled"`
	// Mixpanel project token
	ProjectToken string `json:"projectToken" yaml:"projectToken"`
	// Google Consent settings
	GoogleConsent GoogleConsent `json:"googleConsent" yaml:"googleConsent"`
	// Google Tag Manager server container settings
	ServerContainer MixpanelServerContainer `json:"serverContainer" yaml:"serverContainer"`
	// Custom tag template settings
	Templates MixpanelTemplates `json:"templates" yaml:"templates"`
}

type MixpanelServerContainer struct {
	UserID string `json:"userId" yaml:"userId"`
	// Set events
	Set contemplate.Config `json:"set" yaml:"set"`
	// SetOnce events
	SetOnce contemplate.Config `json:"setOnce" yaml:"setOnce"`
	// Reset events
	Reset contemplate.Config `json:"reset" yaml:"reset"`
	// Track events
	Track contemplate.Config `json:"track" yaml:"track"`
}

type MixpanelTemplates struct {
	// Path to a custom tag template file, defaults to the embedded one
	Tag string `json:"tag" yaml:"tag"`
}

type OpenAIAds struct {
	// Enable provider
	Enabled bool `json:"enabled" yaml:"enabled"`
	// Google Consent settings
	GoogleConsent GoogleConsent `json:"googleConsent" yaml:"googleConsent"`
	// OpenAI Ads pixel id
	PixelID string `json:"pixelId" yaml:"pixelId"`
	// OpenAI Ads api key
	APIKey string `json:"apiKey" yaml:"apiKey"`
	// OpenAI Ads Conversion settings
	Conversion OpenAIAdsConversion `json:"conversion" yaml:"conversion"`
	// Custom tag template settings
	Templates OpenAIAdsTemplates `json:"templates" yaml:"templates"`
}

type OpenAIAdsConversion struct {
	// Enable provider
	Enabled bool `json:"enabled" yaml:"enabled"`
	// Only validate the events without persisting them
	ValidateOnly bool `json:"validateOnly" yaml:"validateOnly"`
	// Google Tag Manager server container settings
	ServerContainer OpenAIAdsServerContainer `json:"serverContainer" yaml:"serverContainer"`
}

type OpenAIAdsConversionTag struct {
	// Standard event name sent to OpenAI Ads, defaults to the event name
	EventName string `json:"eventName" yaml:"eventName"`
}

type OpenAIAdsServerContainer struct {
	contemplate.Config `json:",inline" yaml:",squash"`
	Settings           map[string]OpenAIAdsConversionTag `json:"settings" yaml:"settings"`
}

type OpenAIAdsTemplates struct {
	// Path to a custom conversions api tag template file, defaults to the manually installed one
	ConversionsAPITag string `json:"conversionsApiTag" yaml:"conversionsApiTag"`
}

type Pinterest struct {
	// Enable provider
	Enabled bool `json:"enabled" yaml:"enabled"`
	// Pinterest advertiser id
	AdvertiserID string `json:"advertiserId" yaml:"advertiserId"`
	// Pinterest API access token
	APIAccessToken string `json:"apiAccessToken" yaml:"apiAccessToken"`
	// Enable test mode
	TestModeEnabled bool `json:"testModeEnabled" yaml:"testModeEnabled"`
	// Custom tag template settings
	Templates PinterestTemplates `json:"templates" yaml:"templates"`
	// Google Consent settings
	GoogleConsent GoogleConsent `json:"googleConsent" yaml:"googleConsent"`
	// Google Tag Manager server container settings
	ServerContainer contemplate.Config `json:"serverContainer" yaml:"serverContainer"`
}

type PinterestTemplates struct {
	// Path to a custom conversions tag template file, defaults to the manually installed one
	Tag string `json:"tag" yaml:"tag"`
}

type Tracify struct {
	// Enable provider
	Enabled bool `json:"enabled" yaml:"enabled"`
	// Tracify token
	Token string `json:"token" yaml:"token"`
	// Tracify customer site id
	CustomerSiteID string `json:"customerSiteId" yaml:"customerSiteId"`
	// Enable stating mode
	StagingModeEnabled bool `json:"stagingModeEnabled" yaml:"stagingModeEnabled"`
	// Custom tag template settings
	Templates TracifyTemplates `json:"templates" yaml:"templates"`
	// Google Consent settings
	GoogleConsent GoogleConsent `json:"googleConsent" yaml:"googleConsent"`
	// Google Tag Manager server container settings
	ServerContainer contemplate.Config `json:"serverContainer" yaml:"serverContainer"`
}

type TracifyTemplates struct {
	// Path to a custom tag template file, defaults to the embedded one
	Tag string `json:"tag" yaml:"tag"`
}

type TypeScript struct {
	contemplate.Config `json:",inline" yaml:",squash"`
	OutputPath         string `json:"outputPath" yaml:"outputPath"`
}

type Umami struct {
	// Enable provider
	Enabled     bool   `json:"enabled" yaml:"enabled"`
	Domain      string `json:"domain" yaml:"domain"`
	WebsiteID   string `json:"websiteId" yaml:"websiteId"`
	EndpointURL string `json:"endpointUrl" yaml:"endpointUrl"`
	// Custom tag template settings
	Templates UmamiTemplates `json:"templates" yaml:"templates"`
	// Google Consent settings
	GoogleConsent GoogleConsent `json:"googleConsent" yaml:"googleConsent"`
	// Google Tag Manager server container settings
	ServerContainer contemplate.Config `json:"serverContainer" yaml:"serverContainer"`
}

type UmamiTemplates struct {
	// Path to a custom tag template file, defaults to the embedded one
	Tag string `json:"tag" yaml:"tag"`
}

type Utm struct {
	// Enable provider
	Enabled bool `json:"enabled" yaml:"enabled"`
	// Custom tag template settings
	Templates UtmTemplates `json:"templates" yaml:"templates"`
	// Google Consent settings
	GoogleConsent GoogleConsent `json:"googleConsent" yaml:"googleConsent"`
}

type UtmTemplates struct {
	// Path to a custom attribution variable template file, defaults to the embedded one
	AttributionVariable string `json:"attributionVariable" yaml:"attributionVariable"`
	// Path to a custom cookie writer tag template file, defaults to the embedded one
	CookieWriterTag string `json:"cookieWriterTag" yaml:"cookieWriterTag"`
}