sesamy

Documentation

Index

• func Decode(input any, output any) error
• type AnyEvent
• type Event
  • func NewEvent[P any](name EventName, params P) Event[P]
  • func (e Event[P]) AnyEvent() Event[any]
  • func (e Event[P]) Decode(output any) error
  • func (e Event[P]) DecodeParams(output any) error
• type EventName
  • func (s EventName) String() string

Functions

func Decode

func Decode(input any, output any) error

Types

type AnyEvent

type AnyEvent interface {
	AnyEvent() Event[any]
}

AnyEvent casting is required as castings like Event[any](pageView) do not work.

type Event

type Event[P any] struct {
	// Reserved names: https://developers.google.com/analytics/devguides/collection/protocol/ga4/reference?client_type=gtag#reserved_names
	Name EventName `json:"name"`
	// Reserved parameter names: https://developers.google.com/analytics/devguides/collection/protocol/ga4/reference?client_type=gtag#reserved_parameter_names
	Params P `json:"params,omitempty"`
}

func NewEvent

func NewEvent[P any](name EventName, params P) Event[P]

func (Event[P]) AnyEvent

func (e Event[P]) AnyEvent() Event[any]

func (Event[P]) Decode

func (e Event[P]) Decode(output any) error

func (Event[P]) DecodeParams

func (e Event[P]) DecodeParams(output any) error

type EventName

type EventName string

const (
	EventNameAdImpression         EventName = "ad_impression"
	EventNameAddPaymentInfo       EventName = "add_payment_info"
	EventNameAddShippingInfo      EventName = "add_shipping_info"
	EventNameAddToCart            EventName = "add_to_cart"
	EventNameAddToWishlist        EventName = "add_to_wishlist"
	EventNameBeginCheckout        EventName = "begin_checkout"
	EventNameCampaignDetails      EventName = "campaign_details"
	EventNameClick                EventName = "click"
	EventNameEarnVirtualMoney     EventName = "earn_virtual_money"
	EventNameFileDownload         EventName = "file_download"
	EventNameFormStart            EventName = "form_start"
	EventNameFormSubmit           EventName = "form_submit"
	EventNameGenerateLead         EventName = "generate_lead"
	EventNameJoinGroup            EventName = "join_group"
	EventNameLevelEnd             EventName = "level_end"
	EventNameLevelStart           EventName = "level_start"
	EventNameLevelUp              EventName = "level_up"
	EventNameLogin                EventName = "login"
	EventNamePageView             EventName = "page_view"
	EventNamePostScore            EventName = "post_score"
	EventNamePurchase             EventName = "purchase"
	EventNameRefund               EventName = "refund"
	EventNameRemoveFromCart       EventName = "remove_from_cart"
	EventNameScreenView           EventName = "screen_view"
	EventNameScroll               EventName = "scroll"
	EventNameSearch               EventName = "search"
	EventNameSelectContent        EventName = "select_content"
	EventNameSelectItem           EventName = "select_item"
	EventNameSelectPromotion      EventName = "select_promotion"
	EventNameSessionStart         EventName = "session_start"
	EventNameShare                EventName = "share"
	EventNameSignUp               EventName = "sign_up"
	EventNameSpendVirtualCurrency EventName = "spend_virtual_currency"
	EventNameTutorialBegin        EventName = "tutorial_begin"
	EventNameTutorialComplete     EventName = "tutorial_complete"
	EventNameUnlockAchievement    EventName = "unlock_achievement"
	EventNameUserEngagement       EventName = "user_engagement"
	EventNameVideoComplete        EventName = "video_complete"
	EventNameVideoProgress        EventName = "video_progress"
	EventNameVideoStart           EventName = "video_start"
	EventNameViewCart             EventName = "view_cart"
	EventNameViewItem             EventName = "view_item"
	EventNameViewItemList         EventName = "view_item_list"
	EventNameViewPromotion        EventName = "view_promotion"
	EventNameViewSearchResults    EventName = "view_search_results"
)

List of standard events - [[GA4] Automatically collected events](https://support.google.com/analytics/answer/9234069 - [[GA4] Enhanced measurement events](https://support.google.com/analytics/answer/9216061) - [[GA4] Recommended events](https://support.google.com/analytics/answer/9267735)

func (EventName) String

func (s EventName) String() string