sesamy-cli/sesamy.yaml

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

# Whether to redact the visitor ip
redactVisitorIp: true

# --- Google API settings
googleApi:
  # Single line Service Account credentials
  credentials: '{...\\n...\\n...}'
  # Path to the Service Account credentials json file
  credentialsFile: ./tmp/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
    # The workspace id that should be used by the api
    workspaceId: 23
  # Server container settings
  serverContainer:
    # The container tag id
    tagId: GTM-5NWPR4QW
    # The container id
    containerId: 175348980
    # The workspace id that should be used by the api
    workspaceId: 10

# --- 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
  # Enable debug mode for all user devices
  debugMode: false
  # Google Tag Manager web container settings
  webContainer:
    # 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:
    # Contemplate package config for generated events
    packages:
    - path: github.com/foomo/sesamy-go/pkg/event
      types:
      - PageView
      - SelectItem
  # Google Tag Manager web container settings
  typeScript:
    # Target directory for generate files
    outputPath: path/to/target
    # 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 Tag Manager web container settings
  webContainer:
    # 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:
    # 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 settings
  conversion:
    # Google Ads Conversion Tracking ID
    conversionId: ''
    # Google Ads Conversion Tracking Label
    conversionLabel: ''
    # Google Tag Manager server container settings
    serverContainer:
      # 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

# --- 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: 4lkdakkt-al32jklafja-adflakj4ldk-4l9akcnn
  # Endpoint url of the umami api
  endpointUrl: https://umami.your-domain.com
  # Google Tag Manager server container settings
  serverContainer:
    # Contemplate package config for generated events
    packages:
    - path: github.com/foomo/sesamy-go/pkg/event
      types:
      - PageView
      - SelectItem

# --- Facebook
# https://developers.facebook.com/docs/marketing-api/conversions-api/guides/gtm-server-side
facebook:
  # Enable provider
  enabled: true
  # Facebook pixel id
  pixelId: '5793878117412736'
  # To use the Conversions API, you need an access token.
  apiAccessToken: 'EDO3KLJFrcsBO47QALoUENl3AIioUQ74PaNfRBn8iJ6a2yqCjZA1SM6CpMeDVB0dVSCsESfIrLuggtRSSZAcGg8KK79cD8a0AaJ3mvLsyiHzKU8orO15G74ZBJPuywFJfal43ikdAR5GNpSD5zngLKNZB7blZAZBJdllkjdaz4sifmqB2v47AZDZD'
  # Code used to verify that your server events are received correctly by Conversions API
  testEventToken: 'TEST1234'
  # Google Tag Manager server container settings
  serverContainer:
    # 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