Help us shape the future of Go! Take the 2026 Go Developer Survey

config

package
v0.6.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 7, 2024 License: MIT Imports: 2 Imported by: 0

Documentation

Index

Constants

View Source
const Version = "1.0"

Variables

This section is empty.

Functions

This section is empty.

Types

type Config

type Config struct {
	// Config version
	Version string `json:"version" yaml:"version" jsonschema:"required"`
	// Globally redact visitor ip
	RedactVisitorIP bool `json:"redactVisitorIp" yaml:"redactVisitorIp"`
	// 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"`
	// Emarsys provider settings
	Emarsys Emarsys `json:"emarsys" yaml:"emarsys"`
	// Hotjar provider settings
	Hotjar Hotjar `json:"hotjar" yaml:"hotjar"`
	// Tracify provider settings
	Tracify Tracify `json:"tracify" yaml:"tracify"`
	// Umami provider settings
	Umami Umami `json:"umami" yaml:"umami"`
}

type ConversionLinker added in v0.3.0

type ConversionLinker struct {
	Enabled       bool          `json:"enabled" yaml:"enabled"`
	GoogleConsent GoogleConsent `json:"googleConsent" yaml:"googleConsent"`
}

type Cookiebot added in v0.4.0

type Cookiebot struct {
	Enabled                      bool   `json:"enabled" yaml:"enabled"`
	TemplateName                 string `json:"templateName" yaml:"templateName"`
	CookiebotID                  string `json:"cookiebotId" yaml:"cookiebotId"`
	CDNRegion                    string `json:"cdnRegion" yaml:"cdnRegion"`
	URLPassthrough               bool   `json:"urlPassthrough" yaml:"urlPassthrough"`
	AdvertiserConsentModeEnabled bool   `json:"advertiserConsentModeEnabled" yaml:"advertiserConsentModeEnabled"`
}

type Emarsys added in v0.3.1

type Emarsys struct {
	// Enable provider
	Enabled bool `json:"enabled" yaml:"enabled"`
	// Emarsys merchant id
	MerchantID string `json:"merchantId" yaml:"merchantId"`
	// 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 Facebook added in v0.3.0

type Facebook struct {
	Enabled         bool               `json:"enabled" yaml:"enabled"`
	PixelID         string             `json:"pixelId" yaml:"pixelId"`
	APIAccessToken  string             `json:"apiAccessToken" yaml:"apiAccessToken"`
	TestEventToken  string             `json:"testEventToken" yaml:"testEventToken"`
	GoogleConsent   GoogleConsent      `json:"googleConsent" yaml:"googleConsent"`
	ServerContainer contemplate.Config `json:"serverContainer" yaml:"serverContainer"`
}

type GoogleAPI added in v0.3.0

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

func (GoogleAPI) GetClientOption added in v0.3.0

func (c GoogleAPI) GetClientOption() googleapioption.ClientOption
type GoogleAds struct {
	Enabled       bool                 `json:"enabled" yaml:"enabled"`
	GoogleConsent GoogleConsent        `json:"googleConsent" yaml:"googleConsent"`
	ConversionID  string               `json:"conversionId" yaml:"conversionId"`
	Conversion    GoogleAdsConversion  `json:"conversion" yaml:"conversion"`
	Remarketing   GoogleAdsRemarketing `json:"remarketing" yaml:"remarketing"`
}

type GoogleAdsConversion added in v0.3.0

type GoogleAdsConversion struct {
	Enabled         bool               `json:"enabled" yaml:"enabled"`
	ConversionLabel string             `json:"conversionLabel" yaml:"conversionLabel"`
	ServerContainer contemplate.Config `json:"serverContainer" yaml:"serverContainer"`
}

type GoogleAdsRemarketing added in v0.4.2

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

type GoogleAnalytics added in v0.3.0

type GoogleAnalytics struct {
	Enabled         bool               `json:"enabled" yaml:"enabled"`
	GoogleGTag      GoogleGTag         `json:"googleGTag" yaml:"googleGTag"`
	GoogleConsent   GoogleConsent      `json:"googleConsent" yaml:"googleConsent"`
	WebContainer    contemplate.Config `json:"webContainer" yaml:"webContainer"`
	ServerContainer contemplate.Config `json:"serverContainer" yaml:"serverContainer"`
}

type GoogleConsent added in v0.4.0

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

type GoogleGTag added in v0.3.1

type GoogleGTag struct {
	Enabled        bool  `json:"enabled" yaml:"enabled"`
	Priority       int64 `json:"priority" yaml:"priority"`
	EcommerceItems bool  `json:"ecommerceItems" yaml:"ecommerceItems"`
}

type GoogleTag added in v0.3.0

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"`
	// Enable debug mode for all user devices
	DebugMode bool `json:"debugMode" yaml:"debugMode"`
	// Whether a page_view should be sent on initial load
	SendPageView bool `json:"sendPageView" yaml:"sendPageView"`
	// TypeScript settings
	TypeScript TypeScript `json:"typeScript" yaml:"typeScript"`
}

type GoogleTagManager added in v0.3.0

type GoogleTagManager struct {
	AccountID       string                    `json:"accountId" yaml:"accountId"`
	WebContainer    GoogleTagManagerContainer `json:"webContainer" yaml:"webContainer"`
	ServerContainer GoogleTagManagerContainer `json:"serverContainer" yaml:"serverContainer"`
}

type GoogleTagManagerContainer added in v0.3.0

type GoogleTagManagerContainer struct {
	TagID       string `json:"tagId" yaml:"tagId"`
	ContainerID string `json:"containerId" yaml:"containerId"`
	WorkspaceID string `json:"workspaceId" yaml:"workspaceId"`
}

type Hotjar added in v0.6.0

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

type Tracify added in v0.5.0

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"`
	// Google Consent settings
	GoogleConsent GoogleConsent `json:"googleConsent" yaml:"googleConsent"`
	// Google Tag Manager server container settings
	ServerContainer contemplate.Config `json:"serverContainer" yaml:"serverContainer"`
}

type TypeScript added in v0.3.0

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

type Umami added in v0.3.0

type Umami struct {
	Enabled         bool               `json:"enabled" yaml:"enabled"`
	Domain          string             `json:"domain" yaml:"domain"`
	WebsiteID       string             `json:"websiteId" yaml:"websiteId"`
	EndpointURL     string             `json:"endpointUrl" yaml:"endpointUrl"`
	GoogleConsent   GoogleConsent      `json:"googleConsent" yaml:"googleConsent"`
	ServerContainer contemplate.Config `json:"serverContainer" yaml:"serverContainer"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL