sesamy-cli/sesamy.yaml

# yaml-language-server: $schema=sesamy.schema.json
version: '1.1'

# Whether to redact the visitor ip
redactVisitorIp: true
# Enable region specific settings
# https://developers.google.com/tag-platform/tag-manager/server-side/enable-region-specific-settings
enableGeoResolution: true

# --- Google API settings
googleApi:
  # Single line Service Account credentials
  credentials: '{...\\n...\\n...}'
  # Path to the Service Account credentials json file
  credentialsFile: google_service_account_creds.json
  # Current API request quota (send a request to increase the quota)
  requestQuota: 15

# --- Google Tag Manager settings
googleTagManager:
  # The account id
  accountId: '6099238525'
  # Web container settings
  webContainer:
    # The container tag id
    tagId: GTM-57BHX34G
    # The container id
    containerId: '175355532'
    # (Optional) The workspace id that should be used by the api
    workspaceId: '23'
    # (Optional) The workspace name that should be used by the api
    workspace: 'Default Workspace'
  # Server container settings
  serverContainer:
    # The container tag id
    tagId: GTM-5NWPR4QW
    # The container id
    containerId: '175348980'
    # (Optional) The workspace id that should be used by the api
    workspaceId: '10'
    # (Optional) The workspace name that should be used by the api
    workspace: 'Default Workspace'
  # Web container variables
  webContainerVariables:
    dataLayer:
      - link_url
    lookupTables:
      link_url_conversion_label:
        input: '{{dlv.link_url}}'
        valueTable:
          123456: 'https://foomo.org/'
  # Server container variables
  serverContainerVariables:
    eventData:
      - link_url
    lookupTables:
      link_url_conversion_label:
        input: '{{event.link_url}}'
        valueTable:
          123456: 'https://foomo.org/'

# --- Google Tag settings
googleTag:
  # A tag ID is an identifier that you put on your page to load a given Google tag
  tagId: G-PZ5ELRCR31
  # Whether a page_view should be sent on initial load
  sendPageView: true
  # Optional custom server container url
  serverContainerUrl: ''
  # Data layer variables to be added to the event settings
  dataLayerVariables:
    emarsys_page_view_id: emarsys.page_view_id
  # TypeScript settings
  typeScript:
    # Target directory for generate files
    outputPath: path/to/target
    # Path to the go.mod file
    directory: .
    # Contemplate package config for generated events
    packages:
      - path: github.com/foomo/sesamy-go/pkg/event
        types:
        ## GA4 Automatically collected events
        ## https://support.google.com/analytics/answer/9234069
        - Click
        - FileDownload
        - FirstVisit
        - FormStart
        - FormSubmit
        - PageView
        - Scroll
        - UserEngagement
        - VideoComplete
        - VideoProgress
        - VideoStart
        - ViewSearchResults
        ## Recommended events
        ## https://developers.google.com/tag-platform/gtagjs/reference/events
        - AdImpression
        - AddPaymentInfo
        - AddShippingInfo
        - AddToCart
        - AddToWishlist
        - BeginCheckout
        - CampaignDetails
        - CloseConvertLead
        - CloseUnconvertLead
        - DisqualifyLead
        - EarnVirtualMoney
        - Exception
        - GenerateLead
        - JoinGroup
        - LevelEnd
        - LevelStart
        - LevelUp
        - Login
        - PostScore
        - Purchase
        - QualifyLead
        - Refund
        - RemoveFromCart
        - ScreenView
        - Search
        - SelectContent
        - SelectItem
        - SelectPromotion
        - SessionStart
        - Share
        - SignUp
        - SpendVirtualCurrency
        - TutorialBegin
        - TutorialComplete
        - UnlockAchievement
        - ViewCart
        - ViewItem
        - ViewItemList
        - ViewPromotion
        - WorkingLead

# --- Google Analytics settings
googleAnalytics:
  # Enable provider
  enabled: true
  # Google Consent settings
  googleConsent:
    # Enable consent mode
    enabled: true
    # Consent mode name
    mode: analytics_storage
  # Google GTag.js override settings
  googleGTagJSOverride:
    # Provision custom client
    enabled: true
    # Client priority
    priority: 10
    # Patch ecommerce items
    ecommerceItems: true
  # Google Tag Manager web container settings
  webContainer:
    # Path to the go.mod file
    directory: .
    # Contemplate package config for generated events
    packages:
      - path: github.com/foomo/sesamy-go/pkg/event
        types:
          - PageView
          - SelectItem
  # Google Tag Manager server container settings
  serverContainer:
    # Path to the go.mod file
    directory: .
    # Contemplate package config for generated events
    packages:
      - path: github.com/foomo/sesamy-go/pkg/event
        types:
          - PageView
          - SelectItem

# --- Google Ads
googleAds:
  # Enable provider
  enabled: true
  # Google Ads Conversion Tracking ID
  conversionId: ''
  # Google Consent settings
  googleConsent:
    # Enable consent mode
    enabled: true
    # Consent mode name
    mode: ad_storage
  # Google Ads Remarketing settings
  remarketing:
    # Enable Google Ads Remarketing
    enabled: true
    # Enable conversion linking
    enableConversionLinker: true
  # Google Ads Conversion settings
  conversion:
    # Enable Google Ads Conversion
    enabled: true
    # Google Tag Manager server container settings
    serverContainer:
      # Path to the go.mod file
      directory: .
      # Conversion settings map
      settings:
        add_to_cart:
          - label: ''
        purchase:
          - label: ''
      # Contemplate package config for generated events
      packages:
        - path: github.com/foomo/sesamy-go/pkg/event
          types:
            - AddToCart
            - Purchase

# --- Conversion Linker settings
conversionLinker:
  # Enable provider
  enabled: true
  # Google Consent settings
  googleConsent:
    # Enable consent mode
    enabled: true
    # Consent mode name
    mode: ad_storage
  # Accept incoming linker parameters
  enableLinkerParams: true

# --- Umami settings
umami:
  # Enable provider
  enabled: true
  # Enter an optional fixed domain to override event data
  domain: your-domain.com
  # Paste ID for your website from the Umami settings
  websiteId: ''
  # Endpoint url of the umami api
  endpointUrl: https://umami.your-domain.com
  # Google Consent settings
  googleConsent:
    # Enable consent mode
    enabled: true
    # Consent mode name
    mode: analytics_storage
  # Google Tag Manager server container settings
  serverContainer:
    # Path to the go.mod file
    directory: .
    # Contemplate package config for generated events
    packages:
    - path: github.com/foomo/sesamy-go/pkg/event
      types:
      - PageView
      - SelectItem

# --- Criteo
criteo:
  # Enable provider
  enabled: true
  # Criteo caller id
  callerId: 123
  # Criteo partner id
  partnerId: 123456
  # Criteo applicaiton id
  applicationId: com.foomo
  # Google Tag Manager server container settings
  serverContainer:
    # Path to the go.mod file
    directory: .
    # Contemplate package config for generated events
    packages:
      - path: github.com/foomo/sesamy-go/pkg/event
        types:
          - AddToCart
          - BeginCheckout
          - PageView
          - Purchase
          - ViewItem
          - ViewItemList
          - ViewCart

# --- Facebook
# https://developers.facebook.com/docs/marketing-api/conversions-api/guides/gtm-server-side
facebook:
  # Enable provider
  enabled: true
  # Facebook pixel id
  pixelId: ''
  # To use the Conversions API, you need an access token.
  apiAccessToken: ''
  # Code used to verify that your server events are received correctly by Conversions API
  testEventToken: ''
  # Google Tag Manager server container settings
  # Google Consent settings
  googleConsent:
    # Enable consent mode
    enabled: true
    # Consent mode name
    mode: ad_storage
  serverContainer:
    # Path to the go.mod file
    directory: .
    # Contemplate package config for generated events
    packages:
      - path: github.com/foomo/sesamy-go/pkg/event
        types:
          - AddPaymentInfo
          - AddToCart
          - AddToWishlist
          - PageView
          - Purchase
          - Search
          - BeginCheckout
          - GenerateLead
          - ViewItem

# --- Emarsys
emarsys:
  # Enable provider
  enabled: true
  # Emarsys merchant id
  merchantId: ''
  # Enable test mode
  testMode: false
  # Enable debug mode
  debugMode: false
  # Google Consent settings
  googleConsent:
    # Enable consent mode
    enabled: true
    # Consent mode name
    mode: analytics_storage
  # Google Tag Manager server container settings
  serverContainer:
    # Path to the go.mod file
    directory: .
    # Contemplate package config for generated events
    packages:
      - path: github.com/foomo/sesamy-go/pkg/event
        types:
          - Purchase
          - ViewItem
          - ViewItemList

# --- Tracify
tracify:
  # Enable provider
  enabled: true
  # Tracify token
  token: ''
  # Tracify customer site id
  customerSiteId: ''
  # Google Consent settings
  googleConsent:
    # Enable consent mode
    enabled: true
    # Consent mode name
    mode: analytics_storage
  # Google Tag Manager server container settings
  serverContainer:
    # Path to the go.mod file
    directory: .
    # Contemplate package config for generated events
    packages:
      - path: github.com/foomo/sesamy-go/pkg/event
        types:
          - AddToCart
          - PageView
          - ViewItem
          - Purchase


# --- Microsoft Ads
microsoftAds:
  # Enable provider
  enabled: true
  # Microsoft UET Tag ID
  tagId: '123456789'
  # Microsoft Ads Conversion
  conversion:
    # Enable conversion
    enabled: true
    # Google Tag Manager server container settings
    serverContainer:
      # Conversion labels map
      settings:
        add_to_cart:
          pageType: other
          eventType: custom
        page_view:
          pageType: other
          eventType: pageLoad
        purchase:
          pageType: purchase
          eventType: custom
      # Path to the go.mod file
      directory: .
      # Contemplate package config for generated events
      packages:
        - path: github.com/foomo/sesamy-go/pkg/event
          types:
            - AddToCart
            - PageView
            - Purchase

# --- Hotjar
hotjar:
  # Enable provider
  enabled: true
  # Hotjar site id
  siteId: '123456'

# --- Cookiebot CMP
cookiebot:
  # Enable provider
  enabled: true
  # Name of the manually installed Cookiebot CMP tag template
  # "https://tagmanager.google.com/gallery/#/owners/cybotcorp/templates/gtm-templates-cookiebot-cmp
  templateName: Cookiebot CMP
  # Cookiebot id
  cookiebotId: ''
  # CDN Region (eu, com)
  cdnRegion: eu
  # Enable URL passthrough
  urlPassthrough: false
  # Enable advertiser consent mode
  advertiserConsentModeEnabled: false
  # Default Consent state
  regionSettings:
      # Region (leave blank to apply globally)
    - region: ''
      # Default consent for functionality_storage and personalization_storage
      preferences: denied
      # Default consent for analytics_storage
      statistics: denied
      # Default consent for ad_storage
      marketing: denied
      # Default consent ad_user_data
      adUserData: denied
      # Default consent ad_personalization
      adPersonalization: denied

# --- Mixpanel
mixpanel:
  # Enable provider
  enabled: true
  # Project Token
  projectToken: ''
  # Google Consent settings
  googleConsent:
    # Enable consent mode
    enabled: true
    # Consent mode name
    mode: analytics_storage
  # Google Tag Manager server container settings
  serverContainer:
    # Track events
    track:
      # Directory containing the go.mod file
      directory: .
      # Contemplate package config for generated events
      packages:
        - path: 'github.com/foomo/sesamy-go/pkg/event'
          types:
            - AddPaymentInfo
            - AddShippingInfo
            - AddToCart
            - BeginCheckout
            - PageView
            - Purchase
            - RemoveFromCart
            - Search
            - SelectItem
            - ViewCart
            - ViewItem
            - ViewItemList

# --- Pinterest
pinterest:
  # Enable provider
  enabled: true
  # Pinterest advertiser id
  advertiserId: ''
  # Pinterest API access token
  apiAccessToken: ''
  # Enable test mode
  testModeEnabled: false
  # Google Consent settings
  googleConsent:
    # Enable consent mode
    enabled: true
    # Consent mode name
    mode: analytics_storage
  # Google Tag Manager server container settings
  serverContainer:
    # Directory containing the go.mod file
    directory: .
    # Contemplate package config for generated events
    packages:
      - path: 'github.com/foomo/sesamy-go/pkg/event'
        types:
          - AddToCart
          - GenerateLead
          - PageView
          - Purchase
          - Search
          - SignUp
          - ViewItemList