FirebaseDestination

public enum FirebaseDestination : JSONObjectPathConvertible

Type-safe Firebase Analytics mapping destinations.

Each case maps to a specific key or path in the Firebase command payload. Use with mapFrom(_:to:), mapConstant(_:to:), and keep(_:).

LogEvent

  • The event name parameter ("event_name").

    Declaration

    Swift

    case eventName

  • The event parameters dictionary ("parameters").

    Declaration

    Swift

    case eventParams

  • A specific event parameter nested under parameters.[name].

    Pass a Firebase Analytics parameter constant (e.g. AnalyticsParameterCurrency) or any custom string for non-predefined parameters.

    Declaration

    Swift

    case eventParam(String)

  • A specific item parameter nested under parameters.items.[name].

    Pass a Firebase Analytics item parameter constant (e.g. AnalyticsParameterItemID) or any custom string for non-predefined parameters.

    Declaration

    Swift

    case itemParam(String)

SetUserId

  • The user ID parameter ("user_id").

    Declaration

    Swift

    case userId

SetUserProperty

  • The user property name(s) parameter ("property_name").

    Declaration

    Swift

    case userPropertyName

  • The user property value(s) parameter ("property_value").

    Declaration

    Swift

    case userPropertyValue

SetDefaultParameters

  • The default parameters dictionary ("parameters").

    Declaration

    Swift

    case defaultParams

  • A specific default parameter nested under parameters.[name].

    Declaration

    Swift

    case defaultParam(String)

SetConsent

  • The consent settings dictionary ("consent_settings").

    Declaration

    Swift

    case consentSettings

  • A specific consent setting nested under consent_settings.[type.rawValue].

    Declaration

    Swift

    case consentSetting(ConsentType)

SetSessionTimeout

  • The session timeout parameter ("session_timeout_seconds").

    Declaration

    Swift

    case sessionTimeout

SetAnalyticsCollectionEnabled

  • The analytics enabled parameter ("analytics_collection_enabled").

    Declaration

    Swift

    case analyticsEnabled

InitiateConversionMeasurement

  • The email address for conversion measurement ("email_address").

    Declaration

    Swift

    case conversionEmail

  • The phone number for conversion measurement ("phone_number").

    Declaration

    Swift

    case conversionPhone

  • The hashed email address for conversion measurement ("hashed_email_address").

    Declaration

    Swift

    case conversionHashedEmail

  • The hashed phone number for conversion measurement ("hashed_phone_number").

    Declaration

    Swift

    case conversionHashedPhone

  • The path in the Firebase command payload that this destination writes to.

    Declaration

    Swift

    public var path: JSONObjectPath { get }