Viewing: firebase.google.com


                    
                    
                    adStorage

Enables storage (such as device identifiers) related to advertising.

Declaration

Swift

static let adStorage: ConsentType


                    
                    
                    analyticsStorage

Enables storage (such as app identifiers) related to analytics, e.g. visit duration.

Declaration

Swift

static let analyticsStorage: ConsentType


                    
                    
                    adUserData

Sets consent for sending user data to Google for advertising purposes.

Declaration

Swift

static let adUserData: ConsentType


                    
                    
                    adPersonalization

Sets consent for personalized advertising.

Declaration

Swift

static let adPersonalization: ConsentType


                    
                    
                    denied

Consent status indicating consent is denied. For an overview of which data is sent when consent is denied, see SDK behavior with consent mode.

Declaration

Swift

static let denied: ConsentStatus


                    
                    
                    granted

Consent status indicating consent is granted.

Declaration

Swift

static let granted: ConsentStatus


                    
                    
                    AnalyticsEventAdImpression

Ad Impression event. This event signifies when a user sees an ad impression. Note: If you supply the AnalyticsParameterValue parameter, you must also supply the AnalyticsParameterCurrency parameter so that revenue metrics can be computed accurately. Params:

AnalyticsParameterAdPlatform (String) (optional)
AnalyticsParameterAdFormat (String) (optional)
AnalyticsParameterAdSource (String) (optional)
AnalyticsParameterAdUnitName (String) (optional)
AnalyticsParameterCurrency (String) (optional)
AnalyticsParameterValue (Double) (optional)

Declaration

Swift

let AnalyticsEventAdImpression: String


                    
                    
                    AnalyticsEventAddPaymentInfo

Add Payment Info event. This event signifies that a user has submitted their payment information. Note: If you supply the AnalyticsParameterValue parameter, you must also supply the AnalyticsParameterCurrency parameter so that revenue metrics can be computed accurately. Params:

AnalyticsParameterCoupon (String) (optional)
AnalyticsParameterCurrency (String) (optional)
AnalyticsParameterItems ([[String: Any]]) (optional)
AnalyticsParameterPaymentType (String) (optional)
AnalyticsParameterValue (Double) (optional)

Declaration

Swift

let AnalyticsEventAddPaymentInfo: String


                    
                    
                    AnalyticsEventAddShippingInfo

Add Shipping Info event. This event signifies that a user has submitted their shipping information. Note: If you supply the AnalyticsParameterValue parameter, you must also supply the AnalyticsParameterCurrency parameter so that revenue metrics can be computed accurately. Params:

AnalyticsParameterCoupon (String) (optional)
AnalyticsParameterCurrency (String) (optional)
AnalyticsParameterItems ([[String: Any]]) (optional)
AnalyticsParameterShippingTier (String) (optional)
AnalyticsParameterValue (Double) (optional)

Declaration

Swift

let AnalyticsEventAddShippingInfo: String


                    
                    
                    AnalyticsEventAddToCart

E-Commerce Add To Cart event. This event signifies that an item(s) was added to a cart for purchase. Add this event to a funnel with AnalyticsEventPurchase to gauge the effectiveness of your checkout process. Note: If you supply the AnalyticsParameterValue parameter, you must also supply the AnalyticsParameterCurrency parameter so that revenue metrics can be computed accurately. Params:

AnalyticsParameterCurrency (String) (optional)
AnalyticsParameterItems ([[String: Any]]) (optional)
AnalyticsParameterValue (Double) (optional)

Declaration

Swift

let AnalyticsEventAddToCart: String


                    
                    
                    AnalyticsEventAddToWishlist

E-Commerce Add To Wishlist event. This event signifies that an item was added to a wishlist. Use this event to identify popular gift items. Note: If you supply the AnalyticsParameterValue parameter, you must also supply the AnalyticsParameterCurrency parameter so that revenue metrics can be computed accurately. Params:

AnalyticsParameterCurrency (String) (optional)
AnalyticsParameterItems ([[String: Any]]) (optional)
AnalyticsParameterValue (Double) (optional)

Declaration

Swift

let AnalyticsEventAddToWishlist: String


                    
                    
                    AnalyticsEventAppOpen

App Open event. By logging this event when an App becomes active, developers can understand how often users leave and return during the course of a Session. Although Sessions are automatically reported, this event can provide further clarification around the continuous engagement of app-users.

Declaration

Swift

let AnalyticsEventAppOpen: String


                    
                    
                    AnalyticsEventBeginCheckout

E-Commerce Begin Checkout event. This event signifies that a user has begun the process of checking out. Add this event to a funnel with your AnalyticsEventPurchase event to gauge the effectiveness of your checkout process. Note: If you supply the AnalyticsParameterValue parameter, you must also supply the AnalyticsParameterCurrency parameter so that revenue metrics can be computed accurately. Params:

AnalyticsParameterCoupon (String) (optional)
AnalyticsParameterCurrency (String) (optional)
AnalyticsParameterItems ([[String: Any]]) (optional)
AnalyticsParameterValue (Double) (optional)

Declaration

Swift

let AnalyticsEventBeginCheckout: String


                    
                    
                    AnalyticsEventCampaignDetails

Campaign Detail event. Log this event to supply the referral details of a re-engagement campaign. Note: you must supply at least one of the required parameters AnalyticsParameterSource, AnalyticsParameterMedium or AnalyticsParameterCampaign. Params:

AnalyticsParameterSource (String)
AnalyticsParameterMedium (String)
AnalyticsParameterCampaign (String)
AnalyticsParameterTerm (String) (optional)
AnalyticsParameterContent (String) (optional)
AnalyticsParameterAdNetworkClickID (String) (optional)
AnalyticsParameterCP1 (String) (optional)
AnalyticsParameterCampaignID (String) (optional)
AnalyticsParameterCreativeFormat (String) (optional)
AnalyticsParameterMarketingTactic (String) (optional)
AnalyticsParameterSourcePlatform (String) (optional)

Declaration

Swift

let AnalyticsEventCampaignDetails: String


                    
                    
                    AnalyticsEventEarnVirtualCurrency

Earn Virtual Currency event. This event tracks the awarding of virtual currency in your app. Log this along with AnalyticsEventSpendVirtualCurrency to better understand your virtual economy. Params:

AnalyticsParameterVirtualCurrencyName (String)
AnalyticsParameterValue (Int or Double)

Declaration

Swift

let AnalyticsEventEarnVirtualCurrency: String


                    
                    
                    AnalyticsEventGenerateLead

Generate Lead event. Log this event when a lead has been generated in the app to understand the efficacy of your install and re-engagement campaigns. Note: If you supply the AnalyticsParameterValue parameter, you must also supply the AnalyticsParameterCurrency parameter so that revenue metrics can be computed accurately. Params:

AnalyticsParameterCurrency (String) (optional)
AnalyticsParameterValue (Double) (optional)

Declaration

Swift

let AnalyticsEventGenerateLead: String


                    
                    
                    AnalyticsEventInAppPurchase

In-App Purchase event. This event signifies that extra content or a subscription was purchased by a user inside an app. Note: This is different from the ecommerce purchase event. Note: If you supply the AnalyticsParameterValue parameter, you must also supply the AnalyticsParameterCurrency parameter so that revenue metrics can be computed accurately. Params:

AnalyticsParameterCurrency (String)
AnalyticsParameterFreeTrial (Int) (optional)
AnalyticsParameterPrice (Double) (optional)
AnalyticsParameterPriceIsDiscounted (Int) (optional)
AnalyticsParameterProductID (String) (optional)
AnalyticsParameterProductName (String) (optional)
AnalyticsParameterQuantity (Int) (optional)
AnalyticsParameterSubscription (Int) (optional)
AnalyticsParameterValue (Double)

Declaration

Swift

let AnalyticsEventInAppPurchase: String


                    
                    
                    AnalyticsEventJoinGroup

Join Group event. Log this event when a user joins a group such as a guild, team or family. Use this event to analyze how popular certain groups or social features are in your app. Params:

AnalyticsParameterGroupID (String)

Declaration

Swift

let AnalyticsEventJoinGroup: String


                    
                    
                    AnalyticsEventLevelEnd

Level End event. Log this event when the user finishes a level. Params:

AnalyticsParameterLevelName (String)
AnalyticsParameterSuccess (String)

Declaration

Swift

let AnalyticsEventLevelEnd: String


                    
                    
                    AnalyticsEventLevelStart

Level Start event. Log this event when the user starts a new level. Params:

AnalyticsParameterLevelName (String)

Declaration

Swift

let AnalyticsEventLevelStart: String


                    
                    
                    AnalyticsEventLevelUp

Level Up event. This event signifies that a player has leveled up in your gaming app. It can help you gauge the level distribution of your userbase and help you identify certain levels that are difficult to pass. Params:

AnalyticsParameterLevel (Int)
AnalyticsParameterCharacter (String) (optional)

Declaration

Swift

let AnalyticsEventLevelUp: String


                    
                    
                    AnalyticsEventLogin

Login event. Apps with a login feature can report this event to signify that a user has logged in.

Declaration

Swift

let AnalyticsEventLogin: String


                    
                    
                    AnalyticsEventPostScore

Post Score event. Log this event when the user posts a score in your gaming app. This event can help you understand how users are actually performing in your game and it can help you correlate high scores with certain audiences or behaviors. Params:

AnalyticsParameterScore (Int)
AnalyticsParameterLevel (Int) (optional)
AnalyticsParameterCharacter (String) (optional)

Declaration

Swift

let AnalyticsEventPostScore: String


                    
                    
                    AnalyticsEventPurchase

E-Commerce Purchase event. This event signifies that an item(s) was purchased by a user. Note: This is different from the in-app purchase event, which is reported automatically for App Store-based apps. Note: If you supply the AnalyticsParameterValue parameter, you must also supply the AnalyticsParameterCurrency parameter so that revenue metrics can be computed accurately. Params:

AnalyticsParameterAffiliation (String) (optional)
AnalyticsParameterCoupon (String) (optional)
AnalyticsParameterCurrency (String) (optional)
AnalyticsParameterEndDate (String) (optional)
AnalyticsParameterItemID (String) (optional)
AnalyticsParameterItems ([[String: Any]]) (optional)
AnalyticsParameterShipping (Double) (optional)
AnalyticsParameterStartDate (String) (optional)
AnalyticsParameterTax (Double) (optional)
AnalyticsParameterTransactionID (String) (optional)
AnalyticsParameterValue (Double) (optional)

Declaration

Swift

let AnalyticsEventPurchase: String


                    
                    
                    AnalyticsEventRefund

E-Commerce Refund event. This event signifies that a refund was issued. Note: If you supply the AnalyticsParameterValue parameter, you must also supply the AnalyticsParameterCurrency parameter so that revenue metrics can be computed accurately. Params:

AnalyticsParameterAffiliation (String) (optional)
AnalyticsParameterCoupon (String) (optional)
AnalyticsParameterCurrency (String) (optional)
AnalyticsParameterItems ([[String: Any]]) (optional)
AnalyticsParameterShipping (Double) (optional)
AnalyticsParameterTax (Double) (optional)
AnalyticsParameterTransactionID (String) (optional)
AnalyticsParameterValue (Double) (optional)

Declaration

Swift

let AnalyticsEventRefund: String


                    
                    
                    AnalyticsEventRemoveFromCart

E-Commerce Remove from Cart event. This event signifies that an item(s) was removed from a cart. Note: If you supply the AnalyticsParameterValue parameter, you must also supply the AnalyticsParameterCurrency parameter so that revenue metrics can be computed accurately. Params:

AnalyticsParameterCurrency (String) (optional)
AnalyticsParameterItems ([[String: Any]]) (optional)
AnalyticsParameterValue (Double) (optional)

Declaration

Swift

let AnalyticsEventRemoveFromCart: String


                    
                    
                    AnalyticsEventScreenView

Screen View event. This event signifies a screen view. Use this when a screen transition occurs. This event can be logged irrespective of whether automatic screen tracking is enabled. Params:

AnalyticsParameterScreenClass (String) (optional)
AnalyticsParameterScreenName (String) (optional)

Declaration

Swift

let AnalyticsEventScreenView: String


                    
                    
                    AnalyticsEventSearch

Search event. Apps that support search features can use this event to contextualize search operations by supplying the appropriate, corresponding parameters. This event can help you identify the most popular content in your app. Params:

AnalyticsParameterSearchTerm (String)
AnalyticsParameterStartDate (String) (optional)
AnalyticsParameterEndDate (String) (optional)
AnalyticsParameterNumberOfNights (Int) (optional) for hotel bookings
AnalyticsParameterNumberOfRooms (Int) (optional) for hotel bookings
AnalyticsParameterNumberOfPassengers (Int) (optional) for travel bookings
AnalyticsParameterOrigin (String) (optional)
AnalyticsParameterDestination (String) (optional)
AnalyticsParameterTravelClass (String) (optional) for travel bookings

Declaration

Swift

let AnalyticsEventSearch: String


                    
                    
                    AnalyticsEventSelectContent

Select Content event. This general purpose event signifies that a user has selected some content of a certain type in an app. The content can be any object in your app. This event can help you identify popular content and categories of content in your app. Params:

AnalyticsParameterContentType (String)
AnalyticsParameterItemID (String)

Declaration

Swift

let AnalyticsEventSelectContent: String


                    
                    
                    AnalyticsEventSelectItem

Select Item event. This event signifies that an item was selected by a user from a list. Use the appropriate parameters to contextualize the event. Use this event to discover the most popular items selected. Params:

AnalyticsParameterItems ([[String: Any]]) (optional)
AnalyticsParameterItemListID (String) (optional)
AnalyticsParameterItemListName (String) (optional)

Declaration

Swift

let AnalyticsEventSelectItem: String


                    
                    
                    AnalyticsEventSelectPromotion

Select promotion event. This event signifies that a user has selected a promotion offer. Use the appropriate parameters to contextualize the event, such as the item(s) for which the promotion applies. Params:

AnalyticsParameterCreativeName (String) (optional)
AnalyticsParameterCreativeSlot (String) (optional)
AnalyticsParameterItems ([[String: Any]]) (optional)
AnalyticsParameterLocationID (String) (optional)
AnalyticsParameterPromotionID (String) (optional)
AnalyticsParameterPromotionName (String) (optional)

Declaration

Swift

let AnalyticsEventSelectPromotion: String


                    
                    
                    AnalyticsEventShare

Share event. Apps with social features can log the Share event to identify the most viral content. Params:

AnalyticsParameterContentType (String)
AnalyticsParameterItemID (String)

Declaration

Swift

let AnalyticsEventShare: String


                    
                    
                    AnalyticsEventSignUp

Sign Up event. This event indicates that a user has signed up for an account in your app. The parameter signifies the method by which the user signed up. Use this event to understand the different behaviors between logged in and logged out users. Params:

AnalyticsParameterMethod (String)

Declaration

Swift

let AnalyticsEventSignUp: String


                    
                    
                    AnalyticsEventSpendVirtualCurrency

Spend Virtual Currency event. This event tracks the sale of virtual goods in your app and can help you identify which virtual goods are the most popular objects of purchase. Params:

AnalyticsParameterItemName (String)
AnalyticsParameterVirtualCurrencyName (String)
AnalyticsParameterValue (Int or Double)

Declaration

Swift

let AnalyticsEventSpendVirtualCurrency: String


                    
                    
                    AnalyticsEventTutorialBegin

Tutorial Begin event. This event signifies the start of the on-boarding process in your app. Use this in a funnel with AnalyticsEventTutorialComplete to understand how many users complete this process and move on to the full app experience.

Declaration

Swift

let AnalyticsEventTutorialBegin: String


                    
                    
                    AnalyticsEventTutorialComplete

Tutorial End event. Use this event to signify the user's completion of your app's on-boarding process. Add this to a funnel with AnalyticsEventTutorialBegin to gauge the completion rate of your on-boarding process.

Declaration

Swift

let AnalyticsEventTutorialComplete: String


                    
                    
                    AnalyticsEventUnlockAchievement

Unlock Achievement event. Log this event when the user has unlocked an achievement in your game. Since achievements generally represent the breadth of a gaming experience, this event can help you understand how many users are experiencing all that your game has to offer. Params:

AnalyticsParameterAchievementID (String)

Declaration

Swift

let AnalyticsEventUnlockAchievement: String


                    
                    
                    AnalyticsEventViewCart

E-commerce View Cart event. This event signifies that a user has viewed their cart. Use this to analyze your purchase funnel. Note: If you supply the AnalyticsParameterValue parameter, you must also supply the AnalyticsParameterCurrency parameter so that revenue metrics can be computed accurately. Params:

AnalyticsParameterCurrency (String) (optional)
AnalyticsParameterItems ([[String: Any]]) (optional)
AnalyticsParameterValue (Double) (optional)

Declaration

Swift

let AnalyticsEventViewCart: String


                    
                    
                    AnalyticsEventViewItem

View Item event. This event signifies that a user has viewed an item. Use the appropriate parameters to contextualize the event. Use this event to discover the most popular items viewed in your app. Note: If you supply the AnalyticsParameterValue parameter, you must also supply the AnalyticsParameterCurrency parameter so that revenue metrics can be computed accurately. Params:

AnalyticsParameterCurrency (String) (optional)
AnalyticsParameterItems ([[String: Any]]) (optional)
AnalyticsParameterValue (Double) (optional)

Declaration

Swift

let AnalyticsEventViewItem: String


                    
                    
                    AnalyticsEventViewItemList

View Item List event. Log this event when a user sees a list of items or offerings. Params:

AnalyticsParameterItems ([[String: Any]]) (optional)
AnalyticsParameterItemListID (String) (optional)
AnalyticsParameterItemListName (String) (optional)

Declaration

Swift

let AnalyticsEventViewItemList: String


                    
                    
                    AnalyticsEventViewPromotion

View Promotion event. This event signifies that a promotion was shown to a user. Add this event to a funnel with the AnalyticsEventAddToCart and AnalyticsEventPurchase to gauge your conversion process. Params:

AnalyticsParameterCreativeName (String) (optional)
AnalyticsParameterCreativeSlot (String) (optional)
AnalyticsParameterItems ([[String: Any]]) (optional)
AnalyticsParameterLocationID (String) (optional)
AnalyticsParameterPromotionID (String) (optional)
AnalyticsParameterPromotionName (String) (optional)

Declaration

Swift

let AnalyticsEventViewPromotion: String


                    
                    
                    AnalyticsEventViewSearchResults

View Search Results event. Log this event when the user has been presented with the results of a search. Params:

AnalyticsParameterSearchTerm (String)

Declaration

Swift

let AnalyticsEventViewSearchResults: String


                    
                    
                    AnalyticsParameterAchievementID

Game achievement ID (String).

    let params = [
      AnalyticsParameterAchievementID : "10_matches_won",
      // ...
    ]

Declaration

Swift

let AnalyticsParameterAchievementID: String


                    
                    
                    AnalyticsParameterAdFormat

The ad format (e.g. Banner, Interstitial, Rewarded, Native, Rewarded Interstitial, Instream). (String).

    let params = [
      AnalyticsParameterAdFormat : "Banner",
      // ...
    ]

Declaration

Swift

let AnalyticsParameterAdFormat: String


                    
                    
                    AnalyticsParameterAdNetworkClickID

Ad Network Click ID (String). Used for network-specific click IDs which vary in format.

    let params = [
      AnalyticsParameterAdNetworkClickID : "1234567",
      // ...
    ]

Declaration

Swift

let AnalyticsParameterAdNetworkClickID: String


                    
                    
                    AnalyticsParameterAdPlatform

The ad platform (e.g. MoPub, IronSource) (String).

    let params = [
      AnalyticsParameterAdPlatform : "MoPub",
      // ...
    ]

Declaration

Swift

let AnalyticsParameterAdPlatform: String


                    
                    
                    AnalyticsParameterAdSource

The ad source (e.g. AdColony) (String).

    let params = [
      AnalyticsParameterAdSource : "AdColony",
      // ...
    ]

Declaration

Swift

let AnalyticsParameterAdSource: String


                    
                    
                    AnalyticsParameterAdUnitName

The ad unit name (e.g. Banner_03) (String).

    let params = [
      AnalyticsParameterAdUnitName : "Banner_03",
      // ...
    ]

Declaration

Swift

let AnalyticsParameterAdUnitName: String


                    
                    
                    AnalyticsParameterAffiliation

A product affiliation to designate a supplying company or brick and mortar store location (String).

    let params = [
      AnalyticsParameterAffiliation : "Google Store",
      // ...
    ]

Declaration

Swift

let AnalyticsParameterAffiliation: String


                    
                    
                    AnalyticsParameterCP1

Campaign custom parameter (String). Used as a method of capturing custom data in a campaign. Use varies by network.

    let params = [
      AnalyticsParameterCP1 : "custom_data",
      // ...
    ]

Declaration

Swift

let AnalyticsParameterCP1: String


                    
                    
                    AnalyticsParameterCampaign

The individual campaign name, slogan, promo code, etc. Some networks have pre-defined macro to capture campaign information, otherwise can be populated by developer. Highly Recommended (String).

    let params = [
      AnalyticsParameterCampaign : "winter_promotion",
      // ...
    ]

Declaration

Swift

let AnalyticsParameterCampaign: String


                    
                    
                    AnalyticsParameterCampaignID

Campaign ID (String). Used for keyword analysis to identify a specific product promotion or strategic campaign. This is a required key for GA4 data import.

    let params = [
      AnalyticsParameterCampaignID : "7877652710",
      // ...
    ]

Declaration

Swift

let AnalyticsParameterCampaignID: String


                    
                    
                    AnalyticsParameterCharacter

Character used in game (String).

    let params = [
      AnalyticsParameterCharacter : "beat_boss",
      // ...
    ]

Declaration

Swift

let AnalyticsParameterCharacter: String


                    
                    
                    AnalyticsParameterContent

Campaign content (String).

Declaration

Swift

let AnalyticsParameterContent: String


                    
                    
                    AnalyticsParameterContentType

Type of content selected (String).

    let params = [
      AnalyticsParameterContentType : "news article",
      // ...
    ]

Declaration

Swift

let AnalyticsParameterContentType: String


                    
                    
                    AnalyticsParameterCoupon

Coupon code used for a purchase (String).

    let params = [
      AnalyticsParameterCoupon : "SUMMER_FUN",
      // ...
    ]

Declaration

Swift

let AnalyticsParameterCoupon: String


                    
                    
                    AnalyticsParameterCreativeFormat

Creative Format (String). Used to identify the high-level classification of the type of ad served by a specific campaign.

    let params = [
      AnalyticsParameterCreativeFormat : "display",
      // ...
    ]

Declaration

Swift

let AnalyticsParameterCreativeFormat: String


                    
                    
                    AnalyticsParameterCreativeName

The name of a creative used in a promotional spot (String).

    let params = [
      AnalyticsParameterCreativeName : "Summer Sale",
      // ...
    ]

Declaration

Swift

let AnalyticsParameterCreativeName: String


                    
                    
                    AnalyticsParameterCreativeSlot

The name of a creative slot (String).

    let params = [
      AnalyticsParameterCreativeSlot : "summer_banner2",
      // ...
    ]

Declaration

Swift

let AnalyticsParameterCreativeSlot: String


                    
                    
                    AnalyticsParameterCurrency

Currency of the purchase or items associated with the event, in 3-letter ISO_4217 format (String).

    let params = [
      AnalyticsParameterCurrency : "USD",
      // ...
    ]

Declaration

Swift

let AnalyticsParameterCurrency: String


                    
                    
                    AnalyticsParameterDestination

Flight or Travel destination (String).

    let params = [
      AnalyticsParameterDestination : "Mountain View, CA",
      // ...
    ]

Declaration

Swift

let AnalyticsParameterDestination: String


                    
                    
                    AnalyticsParameterDiscount

Monetary value of discount associated with a purchase (Double).

    let params = [
      AnalyticsParameterDiscount : 2.0,
      AnalyticsParameterCurrency : "USD",  // e.g. $2.00 USD
      // ...
    ]

Declaration

Swift

let AnalyticsParameterDiscount: String


                    
                    
                    AnalyticsParameterEndDate

The arrival date, check-out date or rental end date for the item. This should be in YYYY-MM-DD format (String).

    let params = [
      AnalyticsParameterEndDate : "2015-09-14",
      // ...
    ]

Declaration

Swift

let AnalyticsParameterEndDate: String


                    
                    
                    AnalyticsParameterExtendSession

Indicates that the associated event should either extend the current session or start a new session if no session was active when the event was logged. Specify 1 to extend the current session or to start a new session; any other value will not extend or start a session.

    let params = [
      AnalyticsParameterExtendSession : 1,
      // ...
    ]

Declaration

Swift

let AnalyticsParameterExtendSession: String


                    
                    
                    AnalyticsParameterFlightNumber

Flight number for travel events (String).

    let params = [
      AnalyticsParameterFlightNumber : "ZZ800",
      // ...
    ]

Declaration

Swift

let AnalyticsParameterFlightNumber: String


                    
                    
                    AnalyticsParameterFreeTrial

Indicates if the user is on a free trial of a subscription. Specify 1 to indicate true and 0 to indicate false (Int).

    let params = [
      AnalyticsParameterFreeTrial : 1,
      // ...
    ]

Declaration

Swift

let AnalyticsParameterFreeTrial: String


                    
                    
                    AnalyticsParameterGroupID

Group/clan/guild ID (String).

    let params = [
      AnalyticsParameterGroupID : "g1",
      // ...
    ]

Declaration

Swift

let AnalyticsParameterGroupID: String


                    
                    
                    AnalyticsParameterIndex

The index of the item in a list (Int).

    let params = [
      AnalyticsParameterIndex : 5,
      // ...
    ]

Declaration

Swift

let AnalyticsParameterIndex: String


                    
                    
                    AnalyticsParameterItemBrand

Item brand (String).

    let params = [
      AnalyticsParameterItemBrand : "Google",
      // ...
    ]

Declaration

Swift

let AnalyticsParameterItemBrand: String


                    
                    
                    AnalyticsParameterItemCategory

Item category (context-specific) (String).

    let params = [
      AnalyticsParameterItemCategory : "pants",
      // ...
    ]

Declaration

Swift

let AnalyticsParameterItemCategory: String


                    
                    
                    AnalyticsParameterItemCategory2

Item Category (context-specific) (String).

    let params = [
      AnalyticsParameterItemCategory2 : "pants",
      // ...
    ]

Declaration

Swift

let AnalyticsParameterItemCategory2: String


                    
                    
                    AnalyticsParameterItemCategory3

Item Category (context-specific) (String).

    let params = [
      AnalyticsParameterItemCategory3 : "pants",
      // ...
    ]

Declaration

Swift

let AnalyticsParameterItemCategory3: String


                    
                    
                    AnalyticsParameterItemCategory4

Item Category (context-specific) (String).

    let params = [
      AnalyticsParameterItemCategory4 : "pants",
      // ...
    ]

Declaration

Swift

let AnalyticsParameterItemCategory4: String


                    
                    
                    AnalyticsParameterItemCategory5

Item Category (context-specific) (String).

    let params = [
      AnalyticsParameterItemCategory5 : "pants",
      // ...
    ]

Declaration

Swift

let AnalyticsParameterItemCategory5: String


                    
                    
                    AnalyticsParameterItemID

Item ID (context-specific) (String).

    let params = [
      AnalyticsParameterItemID : "SKU_12345",
      // ...
    ]

Declaration

Swift

let AnalyticsParameterItemID: String


                    
                    
                    AnalyticsParameterItemListID

The ID of the list in which the item was presented to the user(String).

    let params = [
      AnalyticsParameterItemListID : "ABC123",
      // ...
    ]

Declaration

Swift

let AnalyticsParameterItemListID: String


                    
                    
                    AnalyticsParameterItemListName

The name of the list in which the item was presented to the user (String).

    let params = [
      AnalyticsParameterItemListName : "Related products",
      // ...
    ]

Declaration

Swift

let AnalyticsParameterItemListName: String


                    
                    
                    AnalyticsParameterItemName

Item Name (context-specific) (String).

    let params = [
      AnalyticsParameterItemName : "jeggings",
      // ...
    ]

Declaration

Swift

let AnalyticsParameterItemName: String


                    
                    
                    AnalyticsParameterItemVariant

Item variant (String).

    let params = [
      AnalyticsParameterItemVariant : "Black",
      // ...
    ]

Declaration

Swift

let AnalyticsParameterItemVariant: String


                    
                    
                    AnalyticsParameterItems

The list of items involved in the transaction expressed as [[String: Any]].

    let params = [
      AnalyticsParameterItems : [
        [AnalyticsParameterItemName : "jeggings", AnalyticsParameterItemCategory : "pants"],
        [AnalyticsParameterItemName : "boots", AnalyticsParameterItemCategory : "shoes"],
      ],
    ]

Declaration

Swift

let AnalyticsParameterItems: String


                    
                    
                    AnalyticsParameterLevel

Level in game (Int).

    let params = [
      AnalyticsParameterLevel : 42,
      // ...
    ]

Declaration

Swift

let AnalyticsParameterLevel: String


                    
                    
                    AnalyticsParameterLevelName

The name of a level in a game (String).

    let params = [
      AnalyticsParameterLevelName : "room_1",
      // ...
    ]

Declaration

Swift

let AnalyticsParameterLevelName: String


                    
                    
                    AnalyticsParameterLocation

Location (String). The Google Place ID that corresponds to the associated event. Alternatively, you can supply your own custom Location ID.

    let params = [
      AnalyticsParameterLocation : "ChIJiyj437sx3YAR9kUWC8QkLzQ",
      // ...
    ]

Declaration

Swift

let AnalyticsParameterLocation: String


                    
                    
                    AnalyticsParameterLocationID

The location associated with the event. Preferred to be the Google Place ID that corresponds to the associated item but could be overridden to a custom location ID string.(String).

    let params = [
      AnalyticsParameterLocationID : "ChIJiyj437sx3YAR9kUWC8QkLzQ",
      // ...
    ]

Declaration

Swift

let AnalyticsParameterLocationID: String


                    
                    
                    AnalyticsParameterMarketingTactic

Marketing Tactic (String). Used to identify the targeting criteria applied to a specific campaign.

    let params = [
      AnalyticsParameterMarketingTactic : "Remarketing",
      // ...
    ]

Declaration

Swift

let AnalyticsParameterMarketingTactic: String


                    
                    
                    AnalyticsParameterMedium

The advertising or marketing medium, for example: cpc, banner, email, push. Highly recommended (String).

    let params = [
      AnalyticsParameterMedium : "email",
      // ...
    ]

Declaration

Swift

let AnalyticsParameterMedium: String


                    
                    
                    AnalyticsParameterMethod

A particular approach used in an operation; for example, "facebook" or "email" in the context of a sign_up or login event. (String).

    let params = [
      AnalyticsParameterMethod : "google",
      // ...
    ]

Declaration

Swift

let AnalyticsParameterMethod: String


                    
                    
                    AnalyticsParameterNumberOfNights

Number of nights staying at hotel (Int).

    let params = [
      AnalyticsParameterNumberOfNights : 3,
      // ...
    ]

Declaration

Swift

let AnalyticsParameterNumberOfNights: String


                    
                    
                    AnalyticsParameterNumberOfPassengers

Number of passengers traveling (Int).

    let params = [
      AnalyticsParameterNumberOfPassengers : 11,
      // ...
    ]

Declaration

Swift

let AnalyticsParameterNumberOfPassengers: String


                    
                    
                    AnalyticsParameterNumberOfRooms

Number of rooms for travel events (Int).

    let params = [
      AnalyticsParameterNumberOfRooms : 2,
      // ...
    ]

Declaration

Swift

let AnalyticsParameterNumberOfRooms: String


                    
                    
                    AnalyticsParameterOrigin

Flight or Travel origin (String).

    let params = [
      AnalyticsParameterOrigin : "Mountain View, CA",
      // ...
    ]

Declaration

Swift

let AnalyticsParameterOrigin: String


                    
                    
                    AnalyticsParameterPaymentType

The chosen method of payment (String).

    let params = [
      AnalyticsParameterPaymentType : "Visa",
      // ...
    ]

Declaration

Swift

let AnalyticsParameterPaymentType: String


                    
                    
                    AnalyticsParameterPrice

Purchase price (Double).

    let params = [
      AnalyticsParameterPrice : 1.0,
      AnalyticsParameterCurrency : "USD",  // e.g. $1.00 USD
      // ...
    ]

Declaration

Swift

let AnalyticsParameterPrice: String


                    
                    
                    AnalyticsParameterPriceIsDiscounted

Indicates if an item's price is discounted. Specify 1 to indicate true and 0 to indicate false (Int).

    let params = [
      AnalyticsParameterPriceIsDiscounted : 1,
      // ...
    ]

Declaration

Swift

let AnalyticsParameterPriceIsDiscounted: String


                    
                    
                    AnalyticsParameterProductID

The ID of a product (String).

    let params = [
      AnalyticsParameterProductID : "PROD_12345",
      // ...
    ]

Declaration

Swift

let AnalyticsParameterProductID: String


                    
                    
                    AnalyticsParameterProductName

The name of a product (String).

    let params = [
      AnalyticsParameterProductName : "My Awesome Product",
      // ...
    ]

Declaration

Swift

let AnalyticsParameterProductName: String


                    
                    
                    AnalyticsParameterPromotionID

The ID of a product promotion (String).

    let params = [
      AnalyticsParameterPromotionID : "ABC123",
      // ...
    ]

Declaration

Swift

let AnalyticsParameterPromotionID: String


                    
                    
                    AnalyticsParameterPromotionName

The name of a product promotion (String).

    let params = [
      AnalyticsParameterPromotionName : "Summer Sale",
      // ...
    ]

Declaration

Swift

let AnalyticsParameterPromotionName: String


                    
                    
                    AnalyticsParameterQuantity

Purchase quantity (Int).

    let params = [
      AnalyticsParameterQuantity : 1,
      // ...
    ]

Declaration

Swift

let AnalyticsParameterQuantity: String


                    
                    
                    AnalyticsParameterScore

Score in game (Int).

    let params = [
      AnalyticsParameterScore : 4200,
      // ...
    ]

Declaration

Swift

let AnalyticsParameterScore: String


                    
                    
                    AnalyticsParameterScreenClass

Current screen class, such as the class name of the UIViewController, logged with screen_view event and added to every event (String).

    let params = [
      AnalyticsParameterScreenClass : "LoginViewController",
      // ...
    ]

Declaration

Swift

let AnalyticsParameterScreenClass: String


                    
                    
                    AnalyticsParameterScreenName

Current screen name, such as the name of the UIViewController, logged with screen_view event and added to every event (String).

    let params = [
      AnalyticsParameterScreenName : "LoginView",
      // ...
    ]

Declaration

Swift

let AnalyticsParameterScreenName: String


                    
                    
                    AnalyticsParameterSearchTerm

The search string/keywords used (String).

    let params = [
      AnalyticsParameterSearchTerm : "periodic table",
      // ...
    ]

Declaration

Swift

let AnalyticsParameterSearchTerm: String


                    
                    
                    AnalyticsParameterShipping

Shipping cost associated with a transaction (Double).

    let params = [
      AnalyticsParameterShipping : 5.99,
      AnalyticsParameterCurrency : "USD",  // e.g. $5.99 USD
      // ...
    ]

Declaration

Swift

let AnalyticsParameterShipping: String


                    
                    
                    AnalyticsParameterShippingTier

The shipping tier (e.g. Ground, Air, Next-day) selected for delivery of the purchased item (String).

    let params = [
      AnalyticsParameterShippingTier : "Ground",
      // ...
    ]

Declaration

Swift

let AnalyticsParameterShippingTier: String


                    
                    
                    AnalyticsParameterSource

The origin of your traffic, such as an Ad network (for example, google) or partner (urban airship). Identify the advertiser, site, publication, etc. that is sending traffic to your property. Highly recommended (String).

    let params = [
      AnalyticsParameterSource : "InMobi",
      // ...
    ]

Declaration

Swift

let AnalyticsParameterSource: String


                    
                    
                    AnalyticsParameterSourcePlatform

Source Platform (String). Used to identify the platform responsible for directing traffic to a given Analytics property (e.g., a buying platform where budgets, targeting criteria, etc. are set, a platform for managing organic traffic data, etc.).

    let params = [
      AnalyticsParameterSourcePlatform : "sa360",
      // ...
    ]

Declaration

Swift

let AnalyticsParameterSourcePlatform: String


                    
                    
                    AnalyticsParameterStartDate

The departure date, check-in date or rental start date for the item. This should be in YYYY-MM-DD format (String).

    let params = [
      AnalyticsParameterStartDate : "2015-09-14",
      // ...
    ]

Declaration

Swift

let AnalyticsParameterStartDate: String


                    
                    
                    AnalyticsParameterSubscription

Indicates if the purchase is a subscription. Specify 1 to indicate true and 0 to indicate false (Int).

    let params = [
      AnalyticsParameterSubscription : 1,
      // ...
    ]

Declaration

Swift

let AnalyticsParameterSubscription: String


                    
                    
                    AnalyticsParameterSuccess

The result of an operation. Specify 1 to indicate success and 0 to indicate failure (Int).

    let params = [
      AnalyticsParameterSuccess : 1,
      // ...
    ]

Declaration

Swift

let AnalyticsParameterSuccess: String


                    
                    
                    AnalyticsParameterTax

Tax cost associated with a transaction (Double).

    let params = [
      AnalyticsParameterTax : 2.43,
      AnalyticsParameterCurrency : "USD",  // e.g. $2.43 USD
      // ...
    ]

Declaration

Swift

let AnalyticsParameterTax: String


                    
                    
                    AnalyticsParameterTerm

If you're manually tagging keyword campaigns, you should use utm_term to specify the keyword (String).

    let params = [
      AnalyticsParameterTerm : "game",
      // ...
    ]

Declaration

Swift

let AnalyticsParameterTerm: String


                    
                    
                    AnalyticsParameterTransactionID

The unique identifier of a transaction (String).

    let params = [
      AnalyticsParameterTransactionID : "T12345",
      // ...
    ]

Declaration

Swift

let AnalyticsParameterTransactionID: String


                    
                    
                    AnalyticsParameterTravelClass

Travel class (String).

    let params = [
      AnalyticsParameterTravelClass : "business",
      // ...
    ]

Declaration

Swift

let AnalyticsParameterTravelClass: String


                    
                    
                    AnalyticsParameterValue

A context-specific numeric value which is accumulated automatically for each event type. This is a general purpose parameter that is useful for accumulating a key metric that pertains to an event. Examples include revenue, distance, time and points. Value should be specified as Int or Double. Notes: Values for pre-defined currency-related events (such as AnalyticsEventAddToCart) should be supplied using Double and must be accompanied by a AnalyticsParameterCurrency parameter. The valid range of accumulated values is [-9,223,372,036,854.77, 9,223,372,036,854.77]. Supplying a non-numeric value, omitting the corresponding AnalyticsParameterCurrency parameter, or supplying an invalid currency code for conversion events will cause that conversion to be omitted from reporting.

    let params = [
      AnalyticsParameterValue : 3.99,
      AnalyticsParameterCurrency : "USD",  // e.g. $3.99 USD
      // ...
    ]

Declaration

Swift

let AnalyticsParameterValue: String


                    
                    
                    AnalyticsParameterVirtualCurrencyName

Name of virtual currency type (String).

    let params = [
      AnalyticsParameterVirtualCurrencyName : "virtual_currency_name",
      // ...
    ]

Declaration

Swift

let AnalyticsParameterVirtualCurrencyName: String


                    
                    
                    AnalyticsUserPropertyAllowAdPersonalizationSignals

Indicates whether events logged by Google Analytics can be used to personalize ads for the user. Set to "YES" to enable, or "NO" to disable. Default is enabled. See the documentation for more details and information about related settings.

    Analytics.setUserProperty("NO", forName: AnalyticsUserPropertyAllowAdPersonalizationSignals)

Declaration

Swift

let AnalyticsUserPropertyAllowAdPersonalizationSignals: String


                    
                    
                    AnalyticsUserPropertySignUpMethod

The method used to sign in. For example, "google", "facebook" or "twitter".

Declaration

Swift

let AnalyticsUserPropertySignUpMethod: String

FirebaseAnalytics Framework Reference Stay organized with collections Save and categorize content based on your preferences.

Constants

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration