eventcolumns

var ClickIDsDclidColumn = columns.FromPageURLParamEventColumn(
	columns.CoreInterfaces.EventClickIDDclid.ID,
	columns.CoreInterfaces.EventClickIDDclid.Field,
	"dclid",
	true,
	columns.WithEventColumnCast(
		columns.StrNilIfErrorOrEmpty(columns.CastToString(columns.CoreInterfaces.EventClickIDDclid.ID)),
	),
	columns.WithEventColumnDocs(
		"Google dclid",
		"Google Click ID from Google Display & Video 360 campaigns, extracted from the 'dclid' parameter in the page URL, used for tracking display ad clicks and conversions.",
	),
)

var ClickIDsFbclidColumn = columns.FromPageURLParamEventColumn(
	columns.CoreInterfaces.EventClickIDFbclid.ID,
	columns.CoreInterfaces.EventClickIDFbclid.Field,
	"fbclid",
	true,
	columns.WithEventColumnCast(
		columns.StrNilIfErrorOrEmpty(columns.CastToString(columns.CoreInterfaces.EventClickIDFbclid.ID)),
	),
	columns.WithEventColumnDocs(
		"Facebook fbclid",
		"Meta Click ID from Meta Ads campaigns (Facebook, Instagram, WhatsApp), extracted from the 'fbclid' parameter in the page URL, used for tracking ad clicks and linking conversions to Meta Ads.",
	),
)

var ClickIDsGbraidColumn = columns.FromPageURLParamEventColumn(
	columns.CoreInterfaces.EventClickIDGbraid.ID,
	columns.CoreInterfaces.EventClickIDGbraid.Field,
	"gbraid",
	true,
	columns.WithEventColumnCast(
		columns.StrNilIfErrorOrEmpty(columns.CastToString(columns.CoreInterfaces.EventClickIDGbraid.ID)),
	),
	columns.WithEventColumnDocs(
		"Google gbraid",
		"Google Click ID for iOS app-to-web conversions, extracted from the 'gbraid' parameter in the page URL, used for privacy-preserving attribution from iOS apps.",
	),
)

var ClickIDsGclidColumn = columns.FromPageURLParamEventColumn(
	columns.CoreInterfaces.EventClickIDGclid.ID,
	columns.CoreInterfaces.EventClickIDGclid.Field,
	"gclid",
	true,
	columns.WithEventColumnCast(
		columns.StrNilIfErrorOrEmpty(columns.CastToString(columns.CoreInterfaces.EventClickIDGclid.ID)),
	),
	columns.WithEventColumnDocs(
		"Google gclid",
		"Google Click ID from Google Ads campaigns, extracted from the 'gclid' parameter in the page URL, used for tracking ad clicks and linking conversions to Google Ads.",
	),
)

var ClickIDsMsclkidColumn = columns.FromPageURLParamEventColumn(
	columns.CoreInterfaces.EventClickIDMsclkid.ID,
	columns.CoreInterfaces.EventClickIDMsclkid.Field,
	"msclkid",
	true,
	columns.WithEventColumnCast(
		columns.StrNilIfErrorOrEmpty(columns.CastToString(columns.CoreInterfaces.EventClickIDMsclkid.ID)),
	),
	columns.WithEventColumnDocs(
		"Microsoft msclkid",
		"Microsoft Click ID from Microsoft Advertising campaigns, extracted from the 'msclkid' parameter in the page URL, used for tracking Bing/Microsoft ad clicks and conversions.",
	),
)

var ClickIDsSrsltidColumn = columns.FromPageURLParamEventColumn(
	columns.CoreInterfaces.EventClickIDSrsltid.ID,
	columns.CoreInterfaces.EventClickIDSrsltid.Field,
	"srsltid",
	true,
	columns.WithEventColumnCast(
		columns.StrNilIfErrorOrEmpty(columns.CastToString(columns.CoreInterfaces.EventClickIDSrsltid.ID)),
	),
	columns.WithEventColumnDocs(
		"Google srsltid",
		"Google Shopping Result Click ID, extracted from the 'srsltid' parameter in the page URL, used for tracking clicks from Google Shopping results.",
	),
)

var ClickIDsWbraidColumn = columns.FromPageURLParamEventColumn(
	columns.CoreInterfaces.EventClickIDWbraid.ID,
	columns.CoreInterfaces.EventClickIDWbraid.Field,
	"wbraid",
	true,
	columns.WithEventColumnCast(
		columns.StrNilIfErrorOrEmpty(columns.CastToString(columns.CoreInterfaces.EventClickIDWbraid.ID)),
	),
	columns.WithEventColumnDocs(
		"Google wbraid",
		"Google Click ID for iOS web-to-app conversions, extracted from the 'wbraid' parameter in the page URL, used for privacy-preserving attribution to iOS apps.",
	),
)

var ClientIDColumn = columns.NewSimpleEventColumn(
	columns.CoreInterfaces.EventClientID.ID,
	columns.CoreInterfaces.EventClientID.Field,
	func(event *schema.Event) (any, error) {
		return string(event.BoundHit.ClientID), nil
	},
	columns.WithEventColumnDocs(
		"Client ID",
		"The Client ID is a unique, randomly generated identifier assigned to each device-browser pair or app installation. It is stored client-side and sent with every event, enabling the analytics system to calculate the number of unique users. It is also used as one of the identifiers that merge events into a session.",
	),
)

var EventIDColumn = columns.NewSimpleEventColumn(
	columns.CoreInterfaces.EventID.ID,
	columns.CoreInterfaces.EventID.Field,
	func(event *schema.Event) (any, error) {
		return event.BoundHit.ID, nil
	},
	columns.WithEventColumnDocs(
		"Event ID",
		"A unique event identifier, generated server-side when the hit is received, used to deduplicate events.",
	),
)

var EventNameColumn = columns.NewSimpleEventColumn(
	columns.CoreInterfaces.EventName.ID,
	columns.CoreInterfaces.EventName.Field,
	func(event *schema.Event) (any, error) {
		if event.BoundHit.EventName == "" {
			return nil, columns.NewBrokenEventError("event name is empty")
		}
		return event.BoundHit.EventName, nil
	},
	columns.WithEventColumnDocs(
		"Event Name",
		"The name of the event. This identifies the action the user performed (e.g., 'page_view', 'click', 'purchase', 'sign_up').",
	),
)

var GeoCityStubColumn = columns.AlwaysNilEventColumn(
	columns.CoreInterfaces.GeoCity.ID,
	columns.CoreInterfaces.GeoCity.Field,
	columns.WithEventColumnDocs(
		"City",
		stubDescription,
	),
)

var GeoContinentStubColumn = columns.AlwaysNilEventColumn(
	columns.CoreInterfaces.GeoContinent.ID,
	columns.CoreInterfaces.GeoContinent.Field,
	columns.WithEventColumnDocs(
		"Continent",
		stubDescription,
	),
)

var GeoCountryStubColumn = columns.AlwaysNilEventColumn(
	columns.CoreInterfaces.GeoCountry.ID,
	columns.CoreInterfaces.GeoCountry.Field,
	columns.WithEventColumnDocs(
		"Country",
		stubDescription,
	),
)

var GeoMetroStubColumn = columns.AlwaysNilEventColumn(
	columns.CoreInterfaces.GeoMetro.ID,
	columns.CoreInterfaces.GeoMetro.Field,
	columns.WithEventColumnDocs(
		"Metro Area",
		stubDescription,
	),
)

var GeoRegionStubColumn = columns.AlwaysNilEventColumn(
	columns.CoreInterfaces.GeoRegion.ID,
	columns.CoreInterfaces.GeoRegion.Field,
	columns.WithEventColumnDocs(
		"Region",
		stubDescription,
	),
)

var GeoSubContinentStubColumn = columns.AlwaysNilEventColumn(
	columns.CoreInterfaces.GeoSubContinent.ID,
	columns.CoreInterfaces.GeoSubContinent.Field,
	columns.WithEventColumnDocs(
		"Sub-Continent",
		stubDescription,
	),
)

var IPAddressColumn = columns.NewSimpleEventColumn(
	columns.CoreInterfaces.EventIPAddress.ID,
	columns.CoreInterfaces.EventIPAddress.Field,
	func(event *schema.Event) (any, error) {
		return event.BoundHit.IP, nil
	},
	columns.WithEventColumnDocs(
		"IP Address",
		"The IP address (IPv4 or IPv6) from which the tracking request originates, used as the source for geolocation data.",
	),
)

var PropertyIDColumn = columns.NewSimpleEventColumn(
	columns.CoreInterfaces.EventPropertyID.ID,
	columns.CoreInterfaces.EventPropertyID.Field,
	func(event *schema.Event) (any, error) {
		return event.BoundHit.PropertyID, nil
	},
	columns.WithEventColumnDocs(
		"Property ID",
		"The unique identifier for the property that sent this event, used to distinguish between different tracked properties and route data to appropriate destinations.",
	),
)

var SSEIsEntry = columns.NewSimpleSessionScopedEventColumn(
	columns.CoreInterfaces.SSEIsEntry.ID,
	columns.CoreInterfaces.SSEIsEntry.Field,
	func(s *schema.Session, i int) (any, error) {
		if len(s.Events) == 0 {
			return nil, nil
		}
		if i == 0 {
			return int64(1), nil
		}
		return int64(0), nil
	},
	columns.WithSessionScopedEventColumnDocs(
		"Session Is Entry Event",
		"An integer flag indicating whether this event is the first event (entry point) of the session. Returns 1 for the first event in the session, 0 for all subsequent events.",
	),
)

var SSESessionHitNumber = columns.NewSimpleSessionScopedEventColumn(
	columns.CoreInterfaces.SSESessionHitNumber.ID,
	columns.CoreInterfaces.SSESessionHitNumber.Field,
	func(_ *schema.Session, i int) (any, error) {
		return int64(i), nil
	},
	columns.WithSessionScopedEventColumnRequired(false),
	columns.WithSessionScopedEventColumnDocs(
		"Session Hit Number",
		"The sequential number of this event within its session, starting from 0. This is the index position of the event in the chronological sequence of all events in the same session.",
	),
)

var SSESessionPageNumber = columns.NewSimpleSessionScopedEventColumn(
	columns.CoreInterfaces.SSESessionPageNumber.ID,
	columns.CoreInterfaces.SSESessionPageNumber.Field,
	func(s *schema.Session, i int) (any, error) {
		var currentPageNumber int64 = 0
		currentPageValue, ok := s.Events[0].Values[columns.CoreInterfaces.EventPageLocation.Field.Name].(string)
		if !ok {
			return nil, errors.New("invalid page location type")
		}
		currentPage := currentPageValue
		for idx := 0; idx <= i; idx++ {
			candidatePageValue, ok := s.Events[idx].Values[columns.CoreInterfaces.EventPageLocation.Field.Name].(string)
			if !ok {
				return nil, errors.New("invalid page location type")
			}
			if currentPage != candidatePageValue {
				currentPageNumber++
				currentPage = candidatePageValue
			}
			if idx == i {
				return currentPageNumber, nil
			}
		}
		return nil, errors.New("event not found in session")
	},
	columns.WithSessionScopedEventColumnRequired(false),
	columns.WithSessionScopedEventColumnDependsOn(
		schema.DependsOnEntry{
			Interface:        columns.CoreInterfaces.EventPageLocation.ID,
			GreaterOrEqualTo: columns.CoreInterfaces.EventPageLocation.Version,
		},
	),
	columns.WithSessionScopedEventColumnDocs(
		"Session Page Number",
		"The sequential page number within the session, starting from 0. Increments when the page location changes. Tracks which page view in the session this event occurred on.",
	),
)

var UserIDColumn = columns.NewSimpleEventColumn(
	columns.CoreInterfaces.EventUserID.ID,
	columns.CoreInterfaces.EventUserID.Field,
	func(event *schema.Event) (any, error) {
		if event.BoundHit.UserID == nil {
			return nil, nil
		}
		return *event.BoundHit.UserID, nil
	},
	columns.WithEventColumnDocs(
		"User ID",
		"An optional, user-provided identifier for authenticated users. It is set by the tracking implementation when a user is logged in (and can be identified) and enables tracking across devices and sessions for the same user.",
	),
)

var UtmCampaignColumn = columns.FromPageURLParamEventColumn(
	columns.CoreInterfaces.EventUtmCampaign.ID,
	columns.CoreInterfaces.EventUtmCampaign.Field,
	"utm_campaign",
	true,
	columns.WithEventColumnCast(
		columns.StrNilIfErrorOrEmpty(columns.CastToString(columns.CoreInterfaces.EventUtmCampaign.ID)),
	),
	columns.WithEventColumnDocs(
		"UTM Campaign",
		"The campaign name from the 'utm_campaign' URL parameter, used to identify specific marketing campaigns (e.g., 'summer_sale', 'product_launch_2024').",
	),
)

var UtmContentColumn = columns.FromPageURLParamEventColumn(
	columns.CoreInterfaces.EventUtmContent.ID,
	columns.CoreInterfaces.EventUtmContent.Field,
	"utm_content",
	true,
	columns.WithEventColumnCast(
		columns.StrNilIfErrorOrEmpty(columns.CastToString(columns.CoreInterfaces.EventUtmContent.ID)),
	),
	columns.WithEventColumnDocs(
		"UTM Content",
		"The content identifier from the 'utm_content' URL parameter, used to differentiate similar content or links within the same campaign (e.g., 'banner_top', 'button_cta').",
	),
)

var UtmCreativeFormatColumn = columns.FromPageURLParamEventColumn(
	columns.CoreInterfaces.EventUtmCreativeFormat.ID,
	columns.CoreInterfaces.EventUtmCreativeFormat.Field,
	"utm_creative_format",
	true,
	columns.WithEventColumnCast(
		columns.StrNilIfErrorOrEmpty(columns.CastToString(columns.CoreInterfaces.EventUtmCreativeFormat.ID)),
	),
	columns.WithEventColumnDocs(
		"UTM Creative Format",
		"The creative format from the 'utm_creative_format' URL parameter, identifies the format of the creative asset.",
	),
)

var UtmIDColumn = columns.FromPageURLParamEventColumn(
	columns.CoreInterfaces.EventUtmID.ID,
	columns.CoreInterfaces.EventUtmID.Field,
	"utm_id",
	true,
	columns.WithEventColumnCast(
		columns.StrNilIfErrorOrEmpty(columns.CastToString(columns.CoreInterfaces.EventUtmID.ID)),
	),
	columns.WithEventColumnDocs(
		"UTM ID",
		"The campaign ID from the 'utm_id' URL parameter, used to identify a specific campaign with a unique identifier for integration with advertising platforms.",
	),
)

var UtmMarketingTacticColumn = columns.FromPageURLParamEventColumn(
	columns.CoreInterfaces.EventUtmMarketingTactic.ID,
	columns.CoreInterfaces.EventUtmMarketingTactic.Field,
	"utm_marketing_tactic",
	true,
	columns.WithEventColumnCast(
		columns.StrNilIfErrorOrEmpty(columns.CastToString(columns.CoreInterfaces.EventUtmMarketingTactic.ID)),
	),
	columns.WithEventColumnDocs(
		"UTM Marketing Tactic",
		"The marketing tactic from the 'utm_marketing_tactic' URL parameter, describes the targeting criteria (e.g., 'remarketing', 'prospecting').",
	),
)

var UtmMediumColumn = columns.FromPageURLParamEventColumn(
	columns.CoreInterfaces.EventUtmMedium.ID,
	columns.CoreInterfaces.EventUtmMedium.Field,
	"utm_medium",
	true,
	columns.WithEventColumnCast(
		columns.StrNilIfErrorOrEmpty(columns.CastToString(columns.CoreInterfaces.EventUtmMedium.ID)),
	),
	columns.WithEventColumnDocs(
		"UTM Medium",
		"The traffic medium from the 'utm_medium' URL parameter, identifies the marketing medium (e.g., 'cpc', 'email', 'social', 'organic').",
	),
)

var UtmSourceColumn = columns.FromPageURLParamEventColumn(
	columns.CoreInterfaces.EventUtmSource.ID,
	columns.CoreInterfaces.EventUtmSource.Field,
	"utm_source",
	true,
	columns.WithEventColumnCast(
		columns.StrNilIfErrorOrEmpty(columns.CastToString(columns.CoreInterfaces.EventUtmSource.ID)),
	),
	columns.WithEventColumnDocs(
		"UTM Source",
		"The traffic source from the 'utm_source' URL parameter, identifies where the traffic originated (e.g., 'google', 'facebook', 'newsletter').",
	),
)

var UtmSourcePlatformColumn = columns.FromPageURLParamEventColumn(
	columns.CoreInterfaces.EventUtmSourcePlatform.ID,
	columns.CoreInterfaces.EventUtmSourcePlatform.Field,
	"utm_source_platform",
	true,
	columns.WithEventColumnCast(
		columns.StrNilIfErrorOrEmpty(columns.CastToString(columns.CoreInterfaces.EventUtmSourcePlatform.ID)),
	),
	columns.WithEventColumnDocs(
		"UTM Source Platform",
		"The source platform from the 'utm_source_platform' URL parameter, identifies the platform of the traffic source (e.g., 'Google Ads', 'Display & Video 360', 'Meta Ads').",
	),
)

var UtmTermColumn = columns.FromPageURLParamEventColumn(
	columns.CoreInterfaces.EventUtmTerm.ID,
	columns.CoreInterfaces.EventUtmTerm.Field,
	"utm_term",
	true,
	columns.WithEventColumnCast(
		columns.StrNilIfErrorOrEmpty(columns.CastToString(columns.CoreInterfaces.EventUtmTerm.ID)),
	),
	columns.WithEventColumnDocs(
		"UTM Term",
		"The search term from the 'utm_term' URL parameter, used primarily for paid search campaigns to identify the keywords that triggered the ad.",
	),
)