diff --git a/.swiftpm/xcode/xcshareddata/xcschemes/Firebase-Package.xcscheme b/.swiftpm/xcode/xcshareddata/xcschemes/Firebase-Package.xcscheme index e7a276f714..071beed045 100644 --- a/.swiftpm/xcode/xcshareddata/xcschemes/Firebase-Package.xcscheme +++ b/.swiftpm/xcode/xcshareddata/xcschemes/Firebase-Package.xcscheme @@ -630,6 +630,16 @@ ReferencedContainer = "container:"> + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/FirebaseAnalyticsWrapper/Public/FirebaseAnalytics/FIRAnalytics+AppDelegate.h b/FirebaseAnalyticsWrapper/Public/FirebaseAnalytics/FIRAnalytics+AppDelegate.h deleted file mode 100755 index d499af668b..0000000000 --- a/FirebaseAnalyticsWrapper/Public/FirebaseAnalytics/FIRAnalytics+AppDelegate.h +++ /dev/null @@ -1,62 +0,0 @@ -#import - -#import "FIRAnalytics.h" - -NS_ASSUME_NONNULL_BEGIN - -/** - * Provides App Delegate handlers to be used in your App Delegate. - * - * To save time integrating Firebase Analytics in an application, Firebase Analytics does not - * require delegation implementation from the AppDelegate. Instead this is automatically done by - * Firebase Analytics. Should you choose instead to delegate manually, you can turn off the App - * Delegate Proxy by adding FirebaseAppDelegateProxyEnabled into your app's Info.plist and setting - * it to NO, and adding the methods in this category to corresponding delegation handlers. - * - * To handle Universal Links, you must return YES in - * [UIApplicationDelegate application:didFinishLaunchingWithOptions:]. - */ -@interface FIRAnalytics (AppDelegate) - -/** - * Handles events related to a URL session that are waiting to be processed. - * - * For optimal use of Firebase Analytics, call this method from the - * [UIApplicationDelegate application:handleEventsForBackgroundURLSession:completionHandler] - * method of the app delegate in your app. - * - * @param identifier The identifier of the URL session requiring attention. - * @param completionHandler The completion handler to call when you finish processing the events. - * Calling this completion handler lets the system know that your app's user interface is - * updated and a new snapshot can be taken. - */ -+ (void)handleEventsForBackgroundURLSession:(NSString *)identifier - completionHandler:(nullable void (^)(void))completionHandler; - -/** - * Handles the event when the app is launched by a URL. - * - * Call this method from [UIApplicationDelegate application:openURL:options:] (on iOS 9.0 and - * above), or [UIApplicationDelegate application:openURL:sourceApplication:annotation:] (on - * iOS 8.x and below) in your app. - * - * @param url The URL resource to open. This resource can be a network resource or a file. - */ -+ (void)handleOpenURL:(NSURL *)url; - -/** - * Handles the event when the app receives data associated with user activity that includes a - * Universal Link (on iOS 9.0 and above). - * - * Call this method from [UIApplication continueUserActivity:restorationHandler:] in your app - * delegate (on iOS 9.0 and above). - * - * @param userActivity The activity object containing the data associated with the task the user - * was performing. - */ -+ (void)handleUserActivity:(id)userActivity; - -@end - -NS_ASSUME_NONNULL_END - diff --git a/FirebaseAnalyticsWrapper/Public/FirebaseAnalytics/FIRAnalytics.h b/FirebaseAnalyticsWrapper/Public/FirebaseAnalytics/FIRAnalytics.h deleted file mode 100755 index b7a2860c12..0000000000 --- a/FirebaseAnalyticsWrapper/Public/FirebaseAnalytics/FIRAnalytics.h +++ /dev/null @@ -1,154 +0,0 @@ -#import - -#import "FIREventNames.h" -#import "FIRParameterNames.h" -#import "FIRUserPropertyNames.h" - -NS_ASSUME_NONNULL_BEGIN - -/// The top level Firebase Analytics singleton that provides methods for logging events and setting -/// user properties. See the developer guides for general -/// information on using Firebase Analytics in your apps. -/// -/// @note The Analytics SDK uses SQLite to persist events and other app-specific data. Calling -/// certain thread-unsafe global SQLite methods like `sqlite3_shutdown()` can result in -/// unexpected crashes at runtime. -NS_SWIFT_NAME(Analytics) -@interface FIRAnalytics : NSObject - -/// Logs an app event. The event can have up to 25 parameters. Events with the same name must have -/// the same parameters. Up to 500 event names are supported. Using predefined events and/or -/// parameters is recommended for optimal reporting. -/// -/// The following event names are reserved and cannot be used: -///
    -///
  • ad_activeview
  • -///
  • ad_click
  • -///
  • ad_exposure
  • -///
  • ad_impression
  • -///
  • ad_query
  • -///
  • adunit_exposure
  • -///
  • app_clear_data
  • -///
  • app_remove
  • -///
  • app_update
  • -///
  • error
  • -///
  • first_open
  • -///
  • in_app_purchase
  • -///
  • notification_dismiss
  • -///
  • notification_foreground
  • -///
  • notification_open
  • -///
  • notification_receive
  • -///
  • os_update
  • -///
  • session_start
  • -///
  • user_engagement
  • -///
-/// -/// @param name The name of the event. Should contain 1 to 40 alphanumeric characters or -/// underscores. The name must start with an alphabetic character. Some event names are -/// reserved. See FIREventNames.h for the list of reserved event names. The "firebase_", -/// "google_", and "ga_" prefixes are reserved and should not be used. Note that event names are -/// case-sensitive and that logging two events whose names differ only in case will result in -/// two distinct events. To manually log screen view events, use the `screen_view` event name. -/// @param parameters The dictionary of event parameters. Passing nil indicates that the event has -/// no parameters. Parameter names can be up to 40 characters long and must start with an -/// alphabetic character and contain only alphanumeric characters and underscores. Only NSString -/// and NSNumber (signed 64-bit integer and 64-bit floating-point number) parameter types are -/// supported. NSString parameter values can be up to 100 characters long. The "firebase_", -/// "google_", and "ga_" prefixes are reserved and should not be used for parameter names. -+ (void)logEventWithName:(NSString *)name - parameters:(nullable NSDictionary *)parameters - NS_SWIFT_NAME(logEvent(_:parameters:)); - -/// Sets a user property to a given value. Up to 25 user property names are supported. Once set, -/// user property values persist throughout the app lifecycle and across sessions. -/// -/// The following user property names are reserved and cannot be used: -///
    -///
  • first_open_time
  • -///
  • last_deep_link_referrer
  • -///
  • user_id
  • -///
-/// -/// @param value The value of the user property. Values can be up to 36 characters long. Setting the -/// value to nil removes the user property. -/// @param name The name of the user property to set. Should contain 1 to 24 alphanumeric characters -/// or underscores and must start with an alphabetic character. The "firebase_", "google_", and -/// "ga_" prefixes are reserved and should not be used for user property names. -+ (void)setUserPropertyString:(nullable NSString *)value forName:(NSString *)name - NS_SWIFT_NAME(setUserProperty(_:forName:)); - -/// Sets the user ID property. This feature must be used in accordance with -/// Google's Privacy Policy -/// -/// @param userID The user ID to ascribe to the user of this app on this device, which must be -/// non-empty and no more than 256 characters long. Setting userID to nil removes the user ID. -+ (void)setUserID:(nullable NSString *)userID; - -/// This method was deprecated in Firebase 6.29.0. -/// -/// Sets the current screen name, which specifies the current visual context in your app. This helps -/// identify the areas in your app where users spend their time and how they interact with your app. -/// Must be called on the main thread. -/// -/// Note that screen reporting is enabled automatically and records the class name of the current -/// UIViewController for you without requiring you to call this method. The class name can -/// optionally be overridden by calling this method in the viewDidAppear callback of your -/// UIViewController and specifying the screenClassOverride parameter. -/// `setScreenName:screenClass:` must be called after `[super viewDidAppear:]`. -/// -/// If your app does not use a distinct UIViewController for each screen, you should call this -/// method and specify a distinct screenName each time a new screen is presented to the user. -/// -/// The screen name and screen class remain in effect until the current UIViewController changes or -/// a new call to setScreenName:screenClass: is made. -/// -/// @warning If you override `viewDidAppear:` in your UIViewController but do not call -/// `[super viewDidAppear:]`, that screen class will not be tracked. -/// -/// @param screenName The name of the current screen. Should contain 1 to 100 characters. Set to nil -/// to clear the current screen name. -/// @param screenClassOverride The name of the screen class. Should contain 1 to 100 characters. By -/// default this is the class name of the current UIViewController. Set to nil to revert to the -/// default class name. -+ (void)setScreenName:(nullable NSString *)screenName - screenClass:(nullable NSString *)screenClassOverride - DEPRECATED_MSG_ATTRIBUTE( - "Use +[FIRAnalytics logEventWithName:kFIREventScreenView parameters:] instead."); - -/// Sets whether analytics collection is enabled for this app on this device. This setting is -/// persisted across app sessions. By default it is enabled. -/// -/// @param analyticsCollectionEnabled A flag that enables or disables Analytics collection. -+ (void)setAnalyticsCollectionEnabled:(BOOL)analyticsCollectionEnabled; - -/// Sets the interval of inactivity in seconds that terminates the current session. The default -/// value is 1800 seconds (30 minutes). -/// -/// @param sessionTimeoutInterval The custom time of inactivity in seconds before the current -/// session terminates. -+ (void)setSessionTimeoutInterval:(NSTimeInterval)sessionTimeoutInterval; - -/// The unique ID for this instance of the application. -+ (NSString *)appInstanceID; - -/// Clears all analytics data for this instance from the device and resets the app instance ID. -/// FIRAnalyticsConfiguration values will be reset to the default values. -+ (void)resetAnalyticsData; - -/// Adds parameters that will be set on every event logged from the SDK, including automatic ones. -/// The values passed in the parameters dictionary will be added to the dictionary of default event -/// parameters. These parameters persist across app runs. They are of lower precedence than event -/// parameters, so if an event parameter and a parameter set using this API have the same name, the -/// value of the event parameter will be used. The same limitations on event parameters apply to -/// default event parameters. -/// -/// @param parameters Parameters to be added to the dictionary of parameters added to every event. -/// They will be added to the dictionary of default event parameters, replacing any existing -/// parameter with the same name. Valid parameters are NSString and NSNumber (signed 64-bit -/// integer and 64-bit floating-point number). Setting a key's value to [NSNull null] will clear -/// that parameter. Passing in a nil dictionary will clear all parameters. -+ (void)setDefaultEventParameters:(nullable NSDictionary *)parameters; - -@end - -NS_ASSUME_NONNULL_END diff --git a/FirebaseAnalyticsWrapper/Public/FirebaseAnalytics/FIREventNames.h b/FirebaseAnalyticsWrapper/Public/FirebaseAnalytics/FIREventNames.h deleted file mode 100755 index f43350f76c..0000000000 --- a/FirebaseAnalyticsWrapper/Public/FirebaseAnalytics/FIREventNames.h +++ /dev/null @@ -1,480 +0,0 @@ -/// @file FIREventNames.h -/// -/// Predefined event names. -/// -/// An Event is an important occurrence in your app that you want to measure. You can report up to -/// 500 different types of Events per app and you can associate up to 25 unique parameters with each -/// Event type. Some common events are suggested below, but you may also choose to specify custom -/// Event types that are associated with your specific app. Each event type is identified by a -/// unique name. Event names can be up to 40 characters long, may only contain alphanumeric -/// characters and underscores ("_"), and must start with an alphabetic character. The "firebase_", -/// "google_", and "ga_" prefixes are reserved and should not be used. - -#import - -/// Add Payment Info event. This event signifies that a user has submitted their payment -/// information. Note: If you supply the @c kFIRParameterValue parameter, you must also supply the -/// @c kFIRParameterCurrency parameter so that revenue metrics can be computed accurately. Params: -/// -///
    -///
  • @c kFIRParameterCoupon (NSString) (optional)
  • -///
  • @c kFIRParameterCurrency (NSString) (optional)
  • -///
  • @c kFIRParameterItems (NSArray) (optional)
  • -///
  • @c kFIRParameterPaymentType (NSString) (optional)
  • -///
  • @c kFIRParameterValue (double as NSNumber) (optional)
  • -///
-static NSString *const kFIREventAddPaymentInfo NS_SWIFT_NAME(AnalyticsEventAddPaymentInfo) = - @"add_payment_info"; - -/// 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 @c kFIREventPurchase to gauge the effectiveness of -/// your checkout process. Note: If you supply the @c kFIRParameterValue parameter, you must also -/// supply the @c kFIRParameterCurrency parameter so that revenue metrics can be computed -/// accurately. Params: -/// -///
    -///
  • @c kFIRParameterCurrency (NSString) (optional)
  • -///
  • @c kFIRParameterItems (NSArray) (optional)
  • -///
  • @c kFIRParameterValue (double as NSNumber) (optional)
  • -///
-static NSString *const kFIREventAddToCart NS_SWIFT_NAME(AnalyticsEventAddToCart) = @"add_to_cart"; - -/// 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 @c kFIRParameterValue -/// parameter, you must also supply the @c kFIRParameterCurrency parameter so that revenue metrics -/// can be computed accurately. Params: -/// -///
    -///
  • @c kFIRParameterCurrency (NSString) (optional)
  • -///
  • @c kFIRParameterItems (NSArray) (optional)
  • -///
  • @c kFIRParameterValue (double as NSNumber) (optional)
  • -///
-static NSString *const kFIREventAddToWishlist NS_SWIFT_NAME(AnalyticsEventAddToWishlist) = - @"add_to_wishlist"; - -/// 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. -static NSString *const kFIREventAppOpen NS_SWIFT_NAME(AnalyticsEventAppOpen) = @"app_open"; - -/// 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 @c kFIREventPurchase event to gauge the -/// effectiveness of your checkout process. Note: If you supply the @c kFIRParameterValue parameter, -/// you must also supply the @c kFIRParameterCurrency parameter so that revenue metrics can be -/// computed accurately. Params: -/// -///
    -///
  • @c kFIRParameterCoupon (NSString) (optional)
  • -///
  • @c kFIRParameterCurrency (NSString) (optional)
  • -///
  • @c kFIRParameterItems (NSArray) (optional)
  • -///
  • @c kFIRParameterValue (double as NSNumber) (optional)
  • -///
-static NSString *const kFIREventBeginCheckout NS_SWIFT_NAME(AnalyticsEventBeginCheckout) = - @"begin_checkout"; - -/// 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 kFIRParameterSource, -/// kFIRParameterMedium or kFIRParameterCampaign. Params: -/// -///
    -///
  • @c kFIRParameterSource (NSString)
  • -///
  • @c kFIRParameterMedium (NSString)
  • -///
  • @c kFIRParameterCampaign (NSString)
  • -///
  • @c kFIRParameterTerm (NSString) (optional)
  • -///
  • @c kFIRParameterContent (NSString) (optional)
  • -///
  • @c kFIRParameterAdNetworkClickID (NSString) (optional)
  • -///
  • @c kFIRParameterCP1 (NSString) (optional)
  • -///
-static NSString *const kFIREventCampaignDetails NS_SWIFT_NAME(AnalyticsEventCampaignDetails) = - @"campaign_details"; - -/// Checkout progress. Params: -/// -///
    -///
  • @c kFIRParameterCheckoutStep (unsigned 64-bit integer as NSNumber)
  • -///
  • @c kFIRParameterCheckoutOption (NSString) (optional)
  • -///
-/// This constant has been deprecated. -static NSString *const kFIREventCheckoutProgress NS_SWIFT_NAME(AnalyticsEventCheckoutProgress) = - @"checkout_progress"; - -/// Earn Virtual Currency event. This event tracks the awarding of virtual currency in your app. Log -/// this along with @c kFIREventSpendVirtualCurrency to better understand your virtual economy. -/// Params: -/// -///
    -///
  • @c kFIRParameterVirtualCurrencyName (NSString)
  • -///
  • @c kFIRParameterValue (signed 64-bit integer or double as NSNumber)
  • -///
-static NSString *const kFIREventEarnVirtualCurrency - NS_SWIFT_NAME(AnalyticsEventEarnVirtualCurrency) = @"earn_virtual_currency"; - -/// E-Commerce Purchase event. This event signifies that an item 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 @c kFIRParameterValue parameter, you must also -/// supply the @c kFIRParameterCurrency parameter so that revenue metrics can be computed -/// accurately. Params: -/// -///
    -///
  • @c kFIRParameterCurrency (NSString) (optional)
  • -///
  • @c kFIRParameterValue (double as NSNumber) (optional)
  • -///
  • @c kFIRParameterTransactionID (NSString) (optional)
  • -///
  • @c kFIRParameterTax (double as NSNumber) (optional)
  • -///
  • @c kFIRParameterShipping (double as NSNumber) (optional)
  • -///
  • @c kFIRParameterCoupon (NSString) (optional)
  • -///
  • @c kFIRParameterLocation (NSString) (optional)
  • -///
  • @c kFIRParameterStartDate (NSString) (optional)
  • -///
  • @c kFIRParameterEndDate (NSString) (optional)
  • -///
  • @c kFIRParameterNumberOfNights (signed 64-bit integer as NSNumber) (optional) for -/// hotel bookings
  • -///
  • @c kFIRParameterNumberOfRooms (signed 64-bit integer as NSNumber) (optional) for -/// hotel bookings
  • -///
  • @c kFIRParameterNumberOfPassengers (signed 64-bit integer as NSNumber) (optional) -/// for travel bookings
  • -///
  • @c kFIRParameterOrigin (NSString) (optional)
  • -///
  • @c kFIRParameterDestination (NSString) (optional)
  • -///
  • @c kFIRParameterTravelClass (NSString) (optional) for travel bookings
  • -///
-/// This constant has been deprecated. Use @c kFIREventPurchase constant instead. -static NSString *const kFIREventEcommercePurchase NS_SWIFT_NAME(AnalyticsEventEcommercePurchase) = - @"ecommerce_purchase"; - -/// 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 -/// @c kFIRParameterValue parameter, you must also supply the @c kFIRParameterCurrency -/// parameter so that revenue metrics can be computed accurately. Params: -/// -///
    -///
  • @c kFIRParameterCurrency (NSString) (optional)
  • -///
  • @c kFIRParameterValue (double as NSNumber) (optional)
  • -///
-static NSString *const kFIREventGenerateLead NS_SWIFT_NAME(AnalyticsEventGenerateLead) = - @"generate_lead"; - -/// 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: -/// -///
    -///
  • @c kFIRParameterGroupID (NSString)
  • -///
-static NSString *const kFIREventJoinGroup NS_SWIFT_NAME(AnalyticsEventJoinGroup) = @"join_group"; - -/// Level End event. Log this event when the user finishes a level. Params: -/// -///
    -///
  • @c kFIRParameterLevelName (NSString)
  • -///
  • @c kFIRParameterSuccess (NSString)
  • -///
-static NSString *const kFIREventLevelEnd NS_SWIFT_NAME(AnalyticsEventLevelEnd) = @"level_end"; - -/// Level Start event. Log this event when the user starts a new level. Params: -/// -///
    -///
  • @c kFIRParameterLevelName (NSString)
  • -///
-static NSString *const kFIREventLevelStart NS_SWIFT_NAME(AnalyticsEventLevelStart) = @"level_start"; - -/// 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: -/// -///
    -///
  • @c kFIRParameterLevel (signed 64-bit integer as NSNumber)
  • -///
  • @c kFIRParameterCharacter (NSString) (optional)
  • -///
-static NSString *const kFIREventLevelUp NS_SWIFT_NAME(AnalyticsEventLevelUp) = @"level_up"; - -/// Login event. Apps with a login feature can report this event to signify that a user has logged -/// in. -static NSString *const kFIREventLogin NS_SWIFT_NAME(AnalyticsEventLogin) = @"login"; - -/// 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: -/// -///
    -///
  • @c kFIRParameterScore (signed 64-bit integer as NSNumber)
  • -///
  • @c kFIRParameterLevel (signed 64-bit integer as NSNumber) (optional)
  • -///
  • @c kFIRParameterCharacter (NSString) (optional)
  • -///
-static NSString *const kFIREventPostScore NS_SWIFT_NAME(AnalyticsEventPostScore) = @"post_score"; - -/// Present Offer event. This event signifies that the app has presented a purchase offer to a user. -/// Add this event to a funnel with the kFIREventAddToCart and kFIREventEcommercePurchase to gauge -/// your conversion process. Note: If you supply the @c kFIRParameterValue parameter, you must -/// also supply the @c kFIRParameterCurrency parameter so that revenue metrics can be computed -/// accurately. Params: -/// -///
    -///
  • @c kFIRParameterQuantity (signed 64-bit integer as NSNumber)
  • -///
  • @c kFIRParameterItemID (NSString)
  • -///
  • @c kFIRParameterItemName (NSString)
  • -///
  • @c kFIRParameterItemCategory (NSString)
  • -///
  • @c kFIRParameterItemLocationID (NSString) (optional)
  • -///
  • @c kFIRParameterPrice (double as NSNumber) (optional)
  • -///
  • @c kFIRParameterCurrency (NSString) (optional)
  • -///
  • @c kFIRParameterValue (double as NSNumber) (optional)
  • -///
-/// This constant has been deprecated. Use @c kFIREventViewPromotion constant instead. -static NSString *const kFIREventPresentOffer NS_SWIFT_NAME(AnalyticsEventPresentOffer) = - @"present_offer"; - -/// E-Commerce Purchase Refund event. This event signifies that an item purchase was refunded. -/// Note: If you supply the @c kFIRParameterValue parameter, you must also supply the -/// @c kFIRParameterCurrency parameter so that revenue metrics can be computed accurately. -/// Params: -/// -///
    -///
  • @c kFIRParameterCurrency (NSString) (optional)
  • -///
  • @c kFIRParameterValue (double as NSNumber) (optional)
  • -///
  • @c kFIRParameterTransactionID (NSString) (optional)
  • -///
-/// This constant has been deprecated. Use @c kFIREventRefund constant instead. -static NSString *const kFIREventPurchaseRefund NS_SWIFT_NAME(AnalyticsEventPurchaseRefund) = - @"purchase_refund"; - -/// E-Commerce Remove from Cart event. This event signifies that an item(s) was removed from a cart. -/// Note: If you supply the @c kFIRParameterValue parameter, you must also supply the @c -/// kFIRParameterCurrency parameter so that revenue metrics can be computed accurately. Params: -/// -///
    -///
  • @c kFIRParameterCurrency (NSString) (optional)
  • -///
  • @c kFIRParameterItems (NSArray) (optional)
  • -///
  • @c kFIRParameterValue (double as NSNumber) (optional)
  • -///
-static NSString *const kFIREventRemoveFromCart NS_SWIFT_NAME(AnalyticsEventRemoveFromCart) = - @"remove_from_cart"; - -/// 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: -/// -///
    -///
  • @c kFIRParameterScreenClass (NSString) (optional)
  • -///
  • @c kFIRParameterScreenName (NSString) (optional)
  • -///
-static NSString *const kFIREventScreenView NS_SWIFT_NAME(AnalyticsEventScreenView) = @"screen_view"; - -/// 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: -/// -///
    -///
  • @c kFIRParameterSearchTerm (NSString)
  • -///
  • @c kFIRParameterStartDate (NSString) (optional)
  • -///
  • @c kFIRParameterEndDate (NSString) (optional)
  • -///
  • @c kFIRParameterNumberOfNights (signed 64-bit integer as NSNumber) (optional) for -/// hotel bookings
  • -///
  • @c kFIRParameterNumberOfRooms (signed 64-bit integer as NSNumber) (optional) for -/// hotel bookings
  • -///
  • @c kFIRParameterNumberOfPassengers (signed 64-bit integer as NSNumber) (optional) -/// for travel bookings
  • -///
  • @c kFIRParameterOrigin (NSString) (optional)
  • -///
  • @c kFIRParameterDestination (NSString) (optional)
  • -///
  • @c kFIRParameterTravelClass (NSString) (optional) for travel bookings
  • -///
-static NSString *const kFIREventSearch NS_SWIFT_NAME(AnalyticsEventSearch) = @"search"; - -/// 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: -/// -///
    -///
  • @c kFIRParameterContentType (NSString)
  • -///
  • @c kFIRParameterItemID (NSString)
  • -///
-static NSString *const kFIREventSelectContent NS_SWIFT_NAME(AnalyticsEventSelectContent) = - @"select_content"; - -/// Set checkout option. Params: -/// -///
    -///
  • @c kFIRParameterCheckoutStep (unsigned 64-bit integer as NSNumber)
  • -///
  • @c kFIRParameterCheckoutOption (NSString)
  • -///
-/// This constant has been deprecated. -static NSString *const kFIREventSetCheckoutOption NS_SWIFT_NAME(AnalyticsEventSetCheckoutOption) = - @"set_checkout_option"; - -/// Share event. Apps with social features can log the Share event to identify the most viral -/// content. Params: -/// -///
    -///
  • @c kFIRParameterContentType (NSString)
  • -///
  • @c kFIRParameterItemID (NSString)
  • -///
-static NSString *const kFIREventShare NS_SWIFT_NAME(AnalyticsEventShare) = @"share"; - -/// 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: -/// -///
    -///
  • @c kFIRParameterSignUpMethod (NSString)
  • -///
-static NSString *const kFIREventSignUp NS_SWIFT_NAME(AnalyticsEventSignUp) = @"sign_up"; - -/// 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: -/// -///
    -///
  • @c kFIRParameterItemName (NSString)
  • -///
  • @c kFIRParameterVirtualCurrencyName (NSString)
  • -///
  • @c kFIRParameterValue (signed 64-bit integer or double as NSNumber)
  • -///
-static NSString *const kFIREventSpendVirtualCurrency - NS_SWIFT_NAME(AnalyticsEventSpendVirtualCurrency) = @"spend_virtual_currency"; - -/// Tutorial Begin event. This event signifies the start of the on-boarding process in your app. Use -/// this in a funnel with kFIREventTutorialComplete to understand how many users complete this -/// process and move on to the full app experience. -static NSString *const kFIREventTutorialBegin NS_SWIFT_NAME(AnalyticsEventTutorialBegin) = - @"tutorial_begin"; - -/// 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 kFIREventTutorialBegin to gauge the completion rate of your -/// on-boarding process. -static NSString *const kFIREventTutorialComplete NS_SWIFT_NAME(AnalyticsEventTutorialComplete) = - @"tutorial_complete"; - -/// 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: -/// -///
    -///
  • @c kFIRParameterAchievementID (NSString)
  • -///
-static NSString *const kFIREventUnlockAchievement NS_SWIFT_NAME(AnalyticsEventUnlockAchievement) = - @"unlock_achievement"; - -/// 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 @c kFIRParameterValue parameter, you must also supply the -/// @c kFIRParameterCurrency parameter so that revenue metrics can be computed accurately. Params: -/// -///
    -///
  • @c kFIRParameterCurrency (NSString) (optional)
  • -///
  • @c kFIRParameterItems (NSArray) (optional)
  • -///
  • @c kFIRParameterValue (double as NSNumber) (optional)
  • -///
-static NSString *const kFIREventViewItem NS_SWIFT_NAME(AnalyticsEventViewItem) = @"view_item"; - -/// View Item List event. Log this event when a user sees a list of items or offerings. Params: -/// -///
    -///
  • @c kFIRParameterItems (NSArray) (optional)
  • -///
  • @c kFIRParameterItemListID (NSString) (optional)
  • -///
  • @c kFIRParameterItemListName (NSString) (optional)
  • -///
-static NSString *const kFIREventViewItemList NS_SWIFT_NAME(AnalyticsEventViewItemList) = - @"view_item_list"; - -/// View Search Results event. Log this event when the user has been presented with the results of a -/// search. Params: -/// -///
    -///
  • @c kFIRParameterSearchTerm (NSString)
  • -///
-static NSString *const kFIREventViewSearchResults NS_SWIFT_NAME(AnalyticsEventViewSearchResults) = - @"view_search_results"; - -/// Add Shipping Info event. This event signifies that a user has submitted their shipping -/// information. Note: If you supply the @c kFIRParameterValue parameter, you must also supply the -/// @c kFIRParameterCurrency parameter so that revenue metrics can be computed accurately. Params: -/// -///
    -///
  • @c kFIRParameterCoupon (NSString) (optional)
  • -///
  • @c kFIRParameterCurrency (NSString) (optional)
  • -///
  • @c kFIRParameterItems (NSArray) (optional)
  • -///
  • @c kFIRParameterShippingTier (NSString) (optional)
  • -///
  • @c kFIRParameterValue (double as NSNumber) (optional)
  • -///
-static NSString *const kFIREventAddShippingInfo NS_SWIFT_NAME(AnalyticsEventAddShippingInfo) = - @"add_shipping_info"; - -/// 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 @c kFIRParameterValue parameter, you must also supply -/// the @c kFIRParameterCurrency parameter so that revenue metrics can be computed accurately. -/// Params: -/// -///
    -///
  • @c kFIRParameterAffiliation (NSString) (optional)
  • -///
  • @c kFIRParameterCoupon (NSString) (optional)
  • -///
  • @c kFIRParameterCurrency (NSString) (optional)
  • -///
  • @c kFIRParameterItems (NSArray) (optional)
  • -///
  • @c kFIRParameterShipping (double as NSNumber) (optional)
  • -///
  • @c kFIRParameterTax (double as NSNumber) (optional)
  • -///
  • @c kFIRParameterTransactionID (NSString) (optional)
  • -///
  • @c kFIRParameterValue (double as NSNumber) (optional)
  • -///
-static NSString *const kFIREventPurchase NS_SWIFT_NAME(AnalyticsEventPurchase) = @"purchase"; - -/// E-Commerce Refund event. This event signifies that a refund was issued. Note: If you supply the -/// @c kFIRParameterValue parameter, you must also supply the @c kFIRParameterCurrency parameter so -/// that revenue metrics can be computed accurately. Params: -/// -///
    -///
  • @c kFIRParameterAffiliation (NSString) (optional)
  • -///
  • @c kFIRParameterCoupon (NSString) (optional)
  • -///
  • @c kFIRParameterCurrency (NSString) (optional)
  • -///
  • @c kFIRParameterItems (NSArray) (optional)
  • -///
  • @c kFIRParameterShipping (double as NSNumber) (optional)
  • -///
  • @c kFIRParameterTax (double as NSNumber) (optional)
  • -///
  • @c kFIRParameterTransactionID (NSString) (optional)
  • -///
  • @c kFIRParameterValue (double as NSNumber) (optional)
  • -///
-static NSString *const kFIREventRefund NS_SWIFT_NAME(AnalyticsEventRefund) = @"refund"; - -/// 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: -/// -///
    -///
  • @c kFIRParameterItems (NSArray) (optional)
  • -///
  • @c kFIRParameterItemListID (NSString) (optional)
  • -///
  • @c kFIRParameterItemListName (NSString) (optional)
  • -///
-static NSString *const kFIREventSelectItem NS_SWIFT_NAME(AnalyticsEventSelectItem) = @"select_item"; - -/// 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: -/// -///
    -///
  • @c kFIRParameterCreativeName (NSString) (optional)
  • -///
  • @c kFIRParameterCreativeSlot (NSString) (optional)
  • -///
  • @c kFIRParameterItems (NSArray) (optional)
  • -///
  • @c kFIRParameterLocationID (NSString) (optional)
  • -///
  • @c kFIRParameterPromotionID (NSString) (optional)
  • -///
  • @c kFIRParameterPromotionName (NSString) (optional)
  • -///
-static NSString *const kFIREventSelectPromotion NS_SWIFT_NAME(AnalyticsEventSelectPromotion) = - @"select_promotion"; - -/// 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 @c kFIRParameterValue parameter, you must -/// also supply the @c kFIRParameterCurrency parameter so that revenue metrics can be computed -/// accurately. Params: -/// -///
    -///
  • @c kFIRParameterCurrency (NSString) (optional)
  • -///
  • @c kFIRParameterItems (NSArray) (optional)
  • -///
  • @c kFIRParameterValue (double as NSNumber) (optional)
  • -///
-static NSString *const kFIREventViewCart NS_SWIFT_NAME(AnalyticsEventViewCart) = @"view_cart"; - -/// View Promotion event. This event signifies that a promotion was shown to a user. Add this event -/// to a funnel with the @c kFIREventAddToCart and @c kFIREventPurchase to gauge your conversion -/// process. Params: -/// -///
    -///
  • @c kFIRParameterCreativeName (NSString) (optional)
  • -///
  • @c kFIRParameterCreativeSlot (NSString) (optional)
  • -///
  • @c kFIRParameterItems (NSArray) (optional)
  • -///
  • @c kFIRParameterLocationID (NSString) (optional)
  • -///
  • @c kFIRParameterPromotionID (NSString) (optional)
  • -///
  • @c kFIRParameterPromotionName (NSString) (optional)
  • -///
-static NSString *const kFIREventViewPromotion NS_SWIFT_NAME(AnalyticsEventViewPromotion) = - @"view_promotion"; diff --git a/FirebaseAnalyticsWrapper/Public/FirebaseAnalytics/FIRParameterNames.h b/FirebaseAnalyticsWrapper/Public/FirebaseAnalytics/FIRParameterNames.h deleted file mode 100755 index 7221305796..0000000000 --- a/FirebaseAnalyticsWrapper/Public/FirebaseAnalytics/FIRParameterNames.h +++ /dev/null @@ -1,690 +0,0 @@ -/// @file FIRParameterNames.h -/// -/// Predefined event parameter names. -/// -/// Params supply information that contextualize Events. You can associate up to 25 unique Params -/// with each Event type. Some Params are suggested below for certain common Events, but you are -/// not limited to these. You may supply extra Params for suggested Events or custom Params for -/// Custom events. Param names can be up to 40 characters long, may only contain alphanumeric -/// characters and underscores ("_"), and must start with an alphabetic character. Param values can -/// be up to 100 characters long. The "firebase_", "google_", and "ga_" prefixes are reserved and -/// should not be used. - -#import - -/// Game achievement ID (NSString). -///
-///     NSDictionary *params = @{
-///       kFIRParameterAchievementID : @"10_matches_won",
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterAchievementID NS_SWIFT_NAME(AnalyticsParameterAchievementID) = - @"achievement_id"; - -/// Ad Network Click ID (NSString). Used for network-specific click IDs which vary in format. -///
-///     NSDictionary *params = @{
-///       kFIRParameterAdNetworkClickID : @"1234567",
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterAdNetworkClickID - NS_SWIFT_NAME(AnalyticsParameterAdNetworkClickID) = @"aclid"; - -/// A product affiliation to designate a supplying company or brick and mortar store location -/// (NSString).
-///     NSDictionary *params = @{
-///       kFIRParameterAffiliation : @"Google Store",
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterAffiliation NS_SWIFT_NAME(AnalyticsParameterAffiliation) = - @"affiliation"; - -/// 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 -/// (NSString). -///
-///     NSDictionary *params = @{
-///       kFIRParameterCampaign : @"winter_promotion",
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterCampaign NS_SWIFT_NAME(AnalyticsParameterCampaign) = - @"campaign"; - -/// Character used in game (NSString). -///
-///     NSDictionary *params = @{
-///       kFIRParameterCharacter : @"beat_boss",
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterCharacter NS_SWIFT_NAME(AnalyticsParameterCharacter) = - @"character"; - -/// The checkout step (1..N) (unsigned 64-bit integer as NSNumber). -///
-///     NSDictionary *params = @{
-///       kFIRParameterCheckoutStep : @"1",
-///       // ...
-///     };
-/// 
-/// This constant has been deprecated. -static NSString *const kFIRParameterCheckoutStep NS_SWIFT_NAME(AnalyticsParameterCheckoutStep) = - @"checkout_step"; - -/// Some option on a step in an ecommerce flow (NSString). -///
-///     NSDictionary *params = @{
-///       kFIRParameterCheckoutOption : @"Visa",
-///       // ...
-///     };
-/// 
-/// This constant has been deprecated. -static NSString *const kFIRParameterCheckoutOption - NS_SWIFT_NAME(AnalyticsParameterCheckoutOption) = @"checkout_option"; - -/// Campaign content (NSString). -static NSString *const kFIRParameterContent NS_SWIFT_NAME(AnalyticsParameterContent) = @"content"; - -/// Type of content selected (NSString). -///
-///     NSDictionary *params = @{
-///       kFIRParameterContentType : @"news article",
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterContentType NS_SWIFT_NAME(AnalyticsParameterContentType) = - @"content_type"; - -/// Coupon code used for a purchase (NSString). -///
-///     NSDictionary *params = @{
-///       kFIRParameterCoupon : @"SUMMER_FUN",
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterCoupon NS_SWIFT_NAME(AnalyticsParameterCoupon) = @"coupon"; - -/// Campaign custom parameter (NSString). Used as a method of capturing custom data in a campaign. -/// Use varies by network. -///
-///     NSDictionary *params = @{
-///       kFIRParameterCP1 : @"custom_data",
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterCP1 NS_SWIFT_NAME(AnalyticsParameterCP1) = @"cp1"; - -/// The name of a creative used in a promotional spot (NSString). -///
-///     NSDictionary *params = @{
-///       kFIRParameterCreativeName : @"Summer Sale",
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterCreativeName NS_SWIFT_NAME(AnalyticsParameterCreativeName) = - @"creative_name"; - -/// The name of a creative slot (NSString). -///
-///     NSDictionary *params = @{
-///       kFIRParameterCreativeSlot : @"summer_banner2",
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterCreativeSlot NS_SWIFT_NAME(AnalyticsParameterCreativeSlot) = - @"creative_slot"; - -/// Currency of the purchase or items associated with the event, in 3-letter -/// ISO_4217 format (NSString). -///
-///     NSDictionary *params = @{
-///       kFIRParameterCurrency : @"USD",
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterCurrency NS_SWIFT_NAME(AnalyticsParameterCurrency) = - @"currency"; - -/// Flight or Travel destination (NSString). -///
-///     NSDictionary *params = @{
-///       kFIRParameterDestination : @"Mountain View, CA",
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterDestination NS_SWIFT_NAME(AnalyticsParameterDestination) = - @"destination"; - -/// The arrival date, check-out date or rental end date for the item. This should be in -/// YYYY-MM-DD format (NSString). -///
-///     NSDictionary *params = @{
-///       kFIRParameterEndDate : @"2015-09-14",
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterEndDate NS_SWIFT_NAME(AnalyticsParameterEndDate) = @"end_date"; - -/// Flight number for travel events (NSString). -///
-///     NSDictionary *params = @{
-///       kFIRParameterFlightNumber : @"ZZ800",
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterFlightNumber NS_SWIFT_NAME(AnalyticsParameterFlightNumber) = - @"flight_number"; - -/// Group/clan/guild ID (NSString). -///
-///     NSDictionary *params = @{
-///       kFIRParameterGroupID : @"g1",
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterGroupID NS_SWIFT_NAME(AnalyticsParameterGroupID) = @"group_id"; - -/// The index of the item in a list (signed 64-bit integer as NSNumber). -///
-///     NSDictionary *params = @{
-///       kFIRParameterIndex : @(5),
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterIndex NS_SWIFT_NAME(AnalyticsParameterIndex) = @"index"; - -/// Item brand (NSString). -///
-///     NSDictionary *params = @{
-///       kFIRParameterItemBrand : @"Google",
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterItemBrand NS_SWIFT_NAME(AnalyticsParameterItemBrand) = - @"item_brand"; - -/// Item category (context-specific) (NSString). -///
-///     NSDictionary *params = @{
-///       kFIRParameterItemCategory : @"pants",
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterItemCategory NS_SWIFT_NAME(AnalyticsParameterItemCategory) = - @"item_category"; - -/// Item ID (context-specific) (NSString). -///
-///     NSDictionary *params = @{
-///       kFIRParameterItemID : @"SKU_12345",
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterItemID NS_SWIFT_NAME(AnalyticsParameterItemID) = @"item_id"; - -/// The Google Place ID (NSString) that -/// corresponds to the associated item. Alternatively, you can supply your own custom Location ID. -///
-///     NSDictionary *params = @{
-///       kFIRParameterItemLocationID : @"ChIJiyj437sx3YAR9kUWC8QkLzQ",
-///       // ...
-///     };
-/// 
-/// This constant has been deprecated. Use @c kFIRParameterLocationID constant instead. -static NSString *const kFIRParameterItemLocationID - NS_SWIFT_NAME(AnalyticsParameterItemLocationID) = @"item_location_id"; - -/// Item Name (context-specific) (NSString). -///
-///     NSDictionary *params = @{
-///       kFIRParameterItemName : @"jeggings",
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterItemName NS_SWIFT_NAME(AnalyticsParameterItemName) = - @"item_name"; - -/// The list in which the item was presented to the user (NSString). -///
-///     NSDictionary *params = @{
-///       kFIRParameterItemList : @"Search Results",
-///       // ...
-///     };
-/// 
-/// This constant has been deprecated. Use @c kFIRParameterItemListName constant instead. -static NSString *const kFIRParameterItemList NS_SWIFT_NAME(AnalyticsParameterItemList) = - @"item_list"; - -/// Item variant (NSString). -///
-///     NSDictionary *params = @{
-///       kFIRParameterItemVariant : @"Black",
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterItemVariant NS_SWIFT_NAME(AnalyticsParameterItemVariant) = - @"item_variant"; - -/// Level in game (signed 64-bit integer as NSNumber). -///
-///     NSDictionary *params = @{
-///       kFIRParameterLevel : @(42),
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterLevel NS_SWIFT_NAME(AnalyticsParameterLevel) = @"level"; - -/// Location (NSString). The Google Place ID -/// that corresponds to the associated event. Alternatively, you can supply your own custom -/// Location ID. -///
-///     NSDictionary *params = @{
-///       kFIRParameterLocation : @"ChIJiyj437sx3YAR9kUWC8QkLzQ",
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterLocation NS_SWIFT_NAME(AnalyticsParameterLocation) = - @"location"; - -/// The advertising or marketing medium, for example: cpc, banner, email, push. Highly recommended -/// (NSString). -///
-///     NSDictionary *params = @{
-///       kFIRParameterMedium : @"email",
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterMedium NS_SWIFT_NAME(AnalyticsParameterMedium) = @"medium"; - -/// Number of nights staying at hotel (signed 64-bit integer as NSNumber). -///
-///     NSDictionary *params = @{
-///       kFIRParameterNumberOfNights : @(3),
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterNumberOfNights - NS_SWIFT_NAME(AnalyticsParameterNumberOfNights) = @"number_of_nights"; - -/// Number of passengers traveling (signed 64-bit integer as NSNumber). -///
-///     NSDictionary *params = @{
-///       kFIRParameterNumberOfPassengers : @(11),
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterNumberOfPassengers - NS_SWIFT_NAME(AnalyticsParameterNumberOfPassengers) = @"number_of_passengers"; - -/// Number of rooms for travel events (signed 64-bit integer as NSNumber). -///
-///     NSDictionary *params = @{
-///       kFIRParameterNumberOfRooms : @(2),
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterNumberOfRooms NS_SWIFT_NAME(AnalyticsParameterNumberOfRooms) = - @"number_of_rooms"; - -/// Flight or Travel origin (NSString). -///
-///     NSDictionary *params = @{
-///       kFIRParameterOrigin : @"Mountain View, CA",
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterOrigin NS_SWIFT_NAME(AnalyticsParameterOrigin) = @"origin"; - -/// Purchase price (double as NSNumber). -///
-///     NSDictionary *params = @{
-///       kFIRParameterPrice : @(1.0),
-///       kFIRParameterCurrency : @"USD",  // e.g. $1.00 USD
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterPrice NS_SWIFT_NAME(AnalyticsParameterPrice) = @"price"; - -/// Purchase quantity (signed 64-bit integer as NSNumber). -///
-///     NSDictionary *params = @{
-///       kFIRParameterQuantity : @(1),
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterQuantity NS_SWIFT_NAME(AnalyticsParameterQuantity) = - @"quantity"; - -/// Score in game (signed 64-bit integer as NSNumber). -///
-///     NSDictionary *params = @{
-///       kFIRParameterScore : @(4200),
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterScore NS_SWIFT_NAME(AnalyticsParameterScore) = @"score"; - -/// Current screen class, such as the class name of the UIViewController, logged with screen_view -/// event and added to every event (NSString).
-///     NSDictionary *params = @{
-///       kFIRParameterScreenClass : @"LoginViewController",
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterScreenClass NS_SWIFT_NAME(AnalyticsParameterScreenClass) = - @"screen_class"; - -/// Current screen name, such as the name of the UIViewController, logged with screen_view event and -/// added to every event (NSString).
-///     NSDictionary *params = @{
-///       kFIRParameterScreenName : @"LoginView",
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterScreenName NS_SWIFT_NAME(AnalyticsParameterScreenName) = - @"screen_name"; - -/// The search string/keywords used (NSString). -///
-///     NSDictionary *params = @{
-///       kFIRParameterSearchTerm : @"periodic table",
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterSearchTerm NS_SWIFT_NAME(AnalyticsParameterSearchTerm) = - @"search_term"; - -/// Shipping cost associated with a transaction (double as NSNumber). -///
-///     NSDictionary *params = @{
-///       kFIRParameterShipping : @(5.99),
-///       kFIRParameterCurrency : @"USD",  // e.g. $5.99 USD
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterShipping NS_SWIFT_NAME(AnalyticsParameterShipping) = - @"shipping"; - -/// Sign up method (NSString). -///
-///     NSDictionary *params = @{
-///       kFIRParameterSignUpMethod : @"google",
-///       // ...
-///     };
-/// 
-/// -/// This constant has been deprecated. Use Method constant instead. -static NSString *const kFIRParameterSignUpMethod NS_SWIFT_NAME(AnalyticsParameterSignUpMethod) = - @"sign_up_method"; - -/// A particular approach used in an operation; for example, "facebook" or "email" in the context -/// of a sign_up or login event. (NSString). -///
-///     NSDictionary *params = @{
-///       kFIRParameterMethod : @"google",
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterMethod NS_SWIFT_NAME(AnalyticsParameterMethod) = @"method"; - -/// 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 (NSString). -///
-///     NSDictionary *params = @{
-///       kFIRParameterSource : @"InMobi",
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterSource NS_SWIFT_NAME(AnalyticsParameterSource) = @"source"; - -/// The departure date, check-in date or rental start date for the item. This should be in -/// YYYY-MM-DD format (NSString). -///
-///     NSDictionary *params = @{
-///       kFIRParameterStartDate : @"2015-09-14",
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterStartDate NS_SWIFT_NAME(AnalyticsParameterStartDate) = - @"start_date"; - -/// Tax cost associated with a transaction (double as NSNumber). -///
-///     NSDictionary *params = @{
-///       kFIRParameterTax : @(2.43),
-///       kFIRParameterCurrency : @"USD",  // e.g. $2.43 USD
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterTax NS_SWIFT_NAME(AnalyticsParameterTax) = @"tax"; - -/// If you're manually tagging keyword campaigns, you should use utm_term to specify the keyword -/// (NSString). -///
-///     NSDictionary *params = @{
-///       kFIRParameterTerm : @"game",
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterTerm NS_SWIFT_NAME(AnalyticsParameterTerm) = @"term"; - -/// The unique identifier of a transaction (NSString). -///
-///     NSDictionary *params = @{
-///       kFIRParameterTransactionID : @"T12345",
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterTransactionID NS_SWIFT_NAME(AnalyticsParameterTransactionID) = - @"transaction_id"; - -/// Travel class (NSString). -///
-///     NSDictionary *params = @{
-///       kFIRParameterTravelClass : @"business",
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterTravelClass NS_SWIFT_NAME(AnalyticsParameterTravelClass) = - @"travel_class"; - -/// 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 signed -/// 64-bit integer or double as NSNumber. Notes: Values for pre-defined currency-related events -/// (such as @c kFIREventAddToCart) should be supplied using double as NSNumber and must be -/// accompanied by a @c kFIRParameterCurrency 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 @c kFIRParameterCurrency parameter, or supplying an invalid -/// currency code for conversion events will cause that -/// conversion to be omitted from reporting. -///
-///     NSDictionary *params = @{
-///       kFIRParameterValue : @(3.99),
-///       kFIRParameterCurrency : @"USD",  // e.g. $3.99 USD
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterValue NS_SWIFT_NAME(AnalyticsParameterValue) = @"value"; - -/// Name of virtual currency type (NSString). -///
-///     NSDictionary *params = @{
-///       kFIRParameterVirtualCurrencyName : @"virtual_currency_name",
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterVirtualCurrencyName - NS_SWIFT_NAME(AnalyticsParameterVirtualCurrencyName) = @"virtual_currency_name"; - -/// The name of a level in a game (NSString). -///
-///     NSDictionary *params = @{
-///       kFIRParameterLevelName : @"room_1",
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterLevelName NS_SWIFT_NAME(AnalyticsParameterLevelName) = - @"level_name"; - -/// The result of an operation. Specify 1 to indicate success and 0 to indicate failure (unsigned -/// integer as NSNumber). -///
-///     NSDictionary *params = @{
-///       kFIRParameterSuccess : @(1),
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterSuccess NS_SWIFT_NAME(AnalyticsParameterSuccess) = @"success"; - -/// 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 YES to extend the current session or to start a new session; any -/// other value will not extend or start a session. -///
-///     NSDictionary *params = @{
-///       kFIRParameterExtendSession : @YES,
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterExtendSession NS_SWIFT_NAME(AnalyticsParameterExtendSession) = - @"extend_session"; - -/// Monetary value of discount associated with a purchase (double as NSNumber). -///
-///     NSDictionary *params = @{
-///       kFIRParameterDiscount : @(2.0),
-///       kFIRParameterCurrency : @"USD",  // e.g. $2.00 USD
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterDiscount NS_SWIFT_NAME(AnalyticsParameterDiscount) = - @"discount"; - -/// Item Category (context-specific) (NSString). -///
-///     NSDictionary *params = @{
-///       kFIRParameterItemCategory2 : @"pants",
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterItemCategory2 NS_SWIFT_NAME(AnalyticsParameterItemCategory2) = - @"item_category2"; - -/// Item Category (context-specific) (NSString). -///
-///     NSDictionary *params = @{
-///       kFIRParameterItemCategory3 : @"pants",
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterItemCategory3 NS_SWIFT_NAME(AnalyticsParameterItemCategory3) = - @"item_category3"; - -/// Item Category (context-specific) (NSString). -///
-///     NSDictionary *params = @{
-///       kFIRParameterItemCategory4 : @"pants",
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterItemCategory4 NS_SWIFT_NAME(AnalyticsParameterItemCategory4) = - @"item_category4"; - -/// Item Category (context-specific) (NSString). -///
-///     NSDictionary *params = @{
-///       kFIRParameterItemCategory5 : @"pants",
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterItemCategory5 NS_SWIFT_NAME(AnalyticsParameterItemCategory5) = - @"item_category5"; - -/// The ID of the list in which the item was presented to the userĀ (NSString). -///
-///     NSDictionary *params = @{
-///       kFIRParameterItemListID : @"ABC123",
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterItemListID NS_SWIFT_NAME(AnalyticsParameterItemListID) = - @"item_list_id"; - -/// The name of the list in which the item was presented to the user (NSString). -///
-///     NSDictionary *params = @{
-///       kFIRParameterItemListName : @"Related products",
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterItemListName NS_SWIFT_NAME(AnalyticsParameterItemListName) = - @"item_list_name"; - -/// The list of items involved in the transaction. (NSArray). -///
-///     NSDictionary *params = @{
-///       kFIRParameterItems : @[
-///         @{kFIRParameterItemName : @"jeggings", kFIRParameterItemCategory : @"pants"},
-///         @{kFIRParameterItemName : @"boots", kFIRParameterItemCategory : @"shoes"},
-///       ],
-///     };
-/// 
-static NSString *const kFIRParameterItems NS_SWIFT_NAME(AnalyticsParameterItems) = @"items"; - -/// 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.(NSString).
-///     NSDictionary *params = @{
-///       kFIRParameterLocationID : @"ChIJiyj437sx3YAR9kUWC8QkLzQ",
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterLocationID NS_SWIFT_NAME(AnalyticsParameterLocationID) = - @"location_id"; - -/// The chosen method of payment (NSString). -///
-///     NSDictionary *params = @{
-///       kFIRParameterPaymentType : @"Visa",
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterPaymentType NS_SWIFT_NAME(AnalyticsParameterPaymentType) = - @"payment_type"; - -/// The ID of a product promotion (NSString). -///
-///     NSDictionary *params = @{
-///       kFIRParameterPromotionID : @"ABC123",
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterPromotionID NS_SWIFT_NAME(AnalyticsParameterPromotionID) = - @"promotion_id"; - -/// The name of a product promotion (NSString). -///
-///     NSDictionary *params = @{
-///       kFIRParameterPromotionName : @"Summer Sale",
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterPromotionName NS_SWIFT_NAME(AnalyticsParameterPromotionName) = - @"promotion_name"; - -/// The shipping tier (e.g. Ground, Air, Next-day) selected for delivery of the purchased item -/// (NSString). -///
-///     NSDictionary *params = @{
-///       kFIRParameterShippingTier : @"Ground",
-///       // ...
-///     };
-/// 
-static NSString *const kFIRParameterShippingTier NS_SWIFT_NAME(AnalyticsParameterShippingTier) = - @"shipping_tier"; diff --git a/FirebaseAnalyticsWrapper/Public/FirebaseAnalytics/FIRUserPropertyNames.h b/FirebaseAnalyticsWrapper/Public/FirebaseAnalytics/FIRUserPropertyNames.h deleted file mode 100755 index 132aef770c..0000000000 --- a/FirebaseAnalyticsWrapper/Public/FirebaseAnalytics/FIRUserPropertyNames.h +++ /dev/null @@ -1,29 +0,0 @@ -/// @file FIRUserPropertyNames.h -/// -/// Predefined user property names. -/// -/// A UserProperty is an attribute that describes the app-user. By supplying UserProperties, you can -/// later analyze different behaviors of various segments of your userbase. You may supply up to 25 -/// unique UserProperties per app, and you can use the name and value of your choosing for each one. -/// UserProperty names can be up to 24 characters long, may only contain alphanumeric characters and -/// underscores ("_"), and must start with an alphabetic character. UserProperty values can be up to -/// 36 characters long. The "firebase_", "google_", and "ga_" prefixes are reserved and should not -/// be used. - -#import - -/// The method used to sign in. For example, "google", "facebook" or "twitter". -static NSString *const kFIRUserPropertySignUpMethod - NS_SWIFT_NAME(AnalyticsUserPropertySignUpMethod) = @"sign_up_method"; - -/// 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. -/// -///
-///     [FIRAnalytics setUserPropertyString:@"NO"
-///                                 forName:kFIRUserPropertyAllowAdPersonalizationSignals];
-/// 
-static NSString *const kFIRUserPropertyAllowAdPersonalizationSignals - NS_SWIFT_NAME(AnalyticsUserPropertyAllowAdPersonalizationSignals) = @"allow_personalized_ads"; diff --git a/FirebaseAnalyticsWrapper/Public/FirebaseAnalytics/FirebaseAnalytics.h b/FirebaseAnalyticsWrapper/Public/FirebaseAnalytics/FirebaseAnalytics.h deleted file mode 100755 index ed7588a6b7..0000000000 --- a/FirebaseAnalyticsWrapper/Public/FirebaseAnalytics/FirebaseAnalytics.h +++ /dev/null @@ -1,5 +0,0 @@ -#import "FIRAnalytics+AppDelegate.h" -#import "FIRAnalytics.h" -#import "FIREventNames.h" -#import "FIRParameterNames.h" -#import "FIRUserPropertyNames.h" diff --git a/FirebaseAnalyticsWrapper/dummy.m b/FirebaseAnalyticsWrapper/dummy.m index e69de29bb2..b26380df1b 100644 --- a/FirebaseAnalyticsWrapper/dummy.m +++ b/FirebaseAnalyticsWrapper/dummy.m @@ -0,0 +1,17 @@ +/* + * Copyright 2020 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +// Swift Package Manager needs at least one source file. diff --git a/FirebaseAnalyticsWrapper/include/dummy.h b/FirebaseAnalyticsWrapper/include/dummy.h new file mode 100644 index 0000000000..ee616859d6 --- /dev/null +++ b/FirebaseAnalyticsWrapper/include/dummy.h @@ -0,0 +1,18 @@ +/* + * Copyright 2020 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +// Swift Package Manager needs at least one header to prevent a warning. See +// https://github.com/firebase/firebase-ios-sdk/pull/6504. diff --git a/Package.swift b/Package.swift index a130d877aa..12bd244c32 100644 --- a/Package.swift +++ b/Package.swift @@ -22,7 +22,7 @@ import PackageDescription -let firebaseVersion = "6.32.0" +let firebaseVersion = "6.33.0" let package = Package( name: "Firebase", @@ -214,7 +214,6 @@ let package = Package( .product(name: "nanopb", package: "nanopb"), ], path: "FirebaseAnalyticsWrapper", - publicHeadersPath: "Public", linkerSettings: [ .linkedLibrary("sqlite3"), .linkedLibrary("c++"), @@ -659,6 +658,14 @@ let package = Package( ], path: "SwiftPMTests/swift-test" ), + .testTarget( + name: "analytics-import-test", + dependencies: [ + "FirebaseAnalyticsWrapper", + "Firebase", + ], + path: "SwiftPMTests/analytics-import-test" + ), .testTarget( name: "objc-import-test", dependencies: [ diff --git a/SwiftPMTests/analytics-import-test/analytics-import.swift b/SwiftPMTests/analytics-import-test/analytics-import.swift new file mode 100644 index 0000000000..66fee79458 --- /dev/null +++ b/SwiftPMTests/analytics-import-test/analytics-import.swift @@ -0,0 +1,23 @@ +// Copyright 2020 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +import XCTest +import FirebaseAnalytics + +class importTest: XCTestCase { + func testAnalyticsImported() { + Analytics.logEvent(AnalyticsEventEcommercePurchase, + parameters: [AnalyticsParameterShipping: 10.0]) + } +} diff --git a/SwiftPMTests/analytics-import-test/firebase-import.swift b/SwiftPMTests/analytics-import-test/firebase-import.swift new file mode 100644 index 0000000000..c51423c3d6 --- /dev/null +++ b/SwiftPMTests/analytics-import-test/firebase-import.swift @@ -0,0 +1,23 @@ +// Copyright 2020 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +import XCTest +import Firebase + +class firebaseImportTest: XCTestCase { + func testAnalyticsImported() { + Analytics.logEvent(AnalyticsEventEcommercePurchase, + parameters: [AnalyticsParameterShipping: 10.0]) + } +} diff --git a/scripts/check_copyright.sh b/scripts/check_copyright.sh index 85ee20b21a..cab264b1e0 100755 --- a/scripts/check_copyright.sh +++ b/scripts/check_copyright.sh @@ -24,8 +24,7 @@ options=( list=$(git grep "${options[@]}" -- \ '*.'{c,cc,cmake,h,js,m,mm,py,rb,sh,swift} \ CMakeLists.txt '**/CMakeLists.txt' \ - ':(exclude)**/third_party/**' \ - ':(exclude)FirebaseAnalyticsWrapper/**') + ':(exclude)**/third_party/**') # Allow copyrights before 2020 without LLC. result=$(grep -L 'Copyright 20[0-1][0-9].*Google' $list)