|
| 1 | +#import <Foundation/Foundation.h> |
| 2 | + |
| 3 | +#import "FIREventNames.h" |
| 4 | +#import "FIRParameterNames.h" |
| 5 | +#import "FIRUserPropertyNames.h" |
| 6 | + |
| 7 | +NS_ASSUME_NONNULL_BEGIN |
| 8 | + |
| 9 | +/// The top level Firebase Analytics singleton that provides methods for logging events and setting |
| 10 | +/// user properties. See <a href="http://goo.gl/gz8SLz">the developer guides</a> for general |
| 11 | +/// information on using Firebase Analytics in your apps. |
| 12 | +/// |
| 13 | +/// @note The Analytics SDK uses SQLite to persist events and other app-specific data. Calling |
| 14 | +/// certain thread-unsafe global SQLite methods like `sqlite3_shutdown()` can result in |
| 15 | +/// unexpected crashes at runtime. |
| 16 | +NS_SWIFT_NAME(Analytics) |
| 17 | +@interface FIRAnalytics : NSObject |
| 18 | + |
| 19 | +/// Logs an app event. The event can have up to 25 parameters. Events with the same name must have |
| 20 | +/// the same parameters. Up to 500 event names are supported. Using predefined events and/or |
| 21 | +/// parameters is recommended for optimal reporting. |
| 22 | +/// |
| 23 | +/// The following event names are reserved and cannot be used: |
| 24 | +/// <ul> |
| 25 | +/// <li>ad_activeview</li> |
| 26 | +/// <li>ad_click</li> |
| 27 | +/// <li>ad_exposure</li> |
| 28 | +/// <li>ad_query</li> |
| 29 | +/// <li>ad_reward</li> |
| 30 | +/// <li>adunit_exposure</li> |
| 31 | +/// <li>app_background</li> |
| 32 | +/// <li>app_clear_data</li> |
| 33 | +/// <li>app_exception</li> |
| 34 | +/// <li>app_remove</li> |
| 35 | +/// <li>app_store_refund</li> |
| 36 | +/// <li>app_store_subscription_cancel</li> |
| 37 | +/// <li>app_store_subscription_convert</li> |
| 38 | +/// <li>app_store_subscription_renew</li> |
| 39 | +/// <li>app_update</li> |
| 40 | +/// <li>app_upgrade</li> |
| 41 | +/// <li>dynamic_link_app_open</li> |
| 42 | +/// <li>dynamic_link_app_update</li> |
| 43 | +/// <li>dynamic_link_first_open</li> |
| 44 | +/// <li>error</li> |
| 45 | +/// <li>firebase_campaign</li> |
| 46 | +/// <li>first_open</li> |
| 47 | +/// <li>first_visit</li> |
| 48 | +/// <li>in_app_purchase</li> |
| 49 | +/// <li>notification_dismiss</li> |
| 50 | +/// <li>notification_foreground</li> |
| 51 | +/// <li>notification_open</li> |
| 52 | +/// <li>notification_receive</li> |
| 53 | +/// <li>os_update</li> |
| 54 | +/// <li>session_start</li> |
| 55 | +/// <li>session_start_with_rollout</li> |
| 56 | +/// <li>user_engagement</li> |
| 57 | +/// </ul> |
| 58 | +/// |
| 59 | +/// @param name The name of the event. Should contain 1 to 40 alphanumeric characters or |
| 60 | +/// underscores. The name must start with an alphabetic character. Some event names are |
| 61 | +/// reserved. See FIREventNames.h for the list of reserved event names. The "firebase_", |
| 62 | +/// "google_", and "ga_" prefixes are reserved and should not be used. Note that event names are |
| 63 | +/// case-sensitive and that logging two events whose names differ only in case will result in |
| 64 | +/// two distinct events. To manually log screen view events, use the `screen_view` event name. |
| 65 | +/// @param parameters The dictionary of event parameters. Passing nil indicates that the event has |
| 66 | +/// no parameters. Parameter names can be up to 40 characters long and must start with an |
| 67 | +/// alphabetic character and contain only alphanumeric characters and underscores. Only NSString |
| 68 | +/// and NSNumber (signed 64-bit integer and 64-bit floating-point number) parameter types are |
| 69 | +/// supported. NSString parameter values can be up to 100 characters long. The "firebase_", |
| 70 | +/// "google_", and "ga_" prefixes are reserved and should not be used for parameter names. |
| 71 | ++ (void)logEventWithName:(NSString *)name |
| 72 | + parameters:(nullable NSDictionary<NSString *, id> *)parameters |
| 73 | + NS_SWIFT_NAME(logEvent(_:parameters:)); |
| 74 | + |
| 75 | +/// Sets a user property to a given value. Up to 25 user property names are supported. Once set, |
| 76 | +/// user property values persist throughout the app lifecycle and across sessions. |
| 77 | +/// |
| 78 | +/// The following user property names are reserved and cannot be used: |
| 79 | +/// <ul> |
| 80 | +/// <li>first_open_time</li> |
| 81 | +/// <li>last_deep_link_referrer</li> |
| 82 | +/// <li>user_id</li> |
| 83 | +/// </ul> |
| 84 | +/// |
| 85 | +/// @param value The value of the user property. Values can be up to 36 characters long. Setting the |
| 86 | +/// value to nil removes the user property. |
| 87 | +/// @param name The name of the user property to set. Should contain 1 to 24 alphanumeric characters |
| 88 | +/// or underscores and must start with an alphabetic character. The "firebase_", "google_", and |
| 89 | +/// "ga_" prefixes are reserved and should not be used for user property names. |
| 90 | ++ (void)setUserPropertyString:(nullable NSString *)value forName:(NSString *)name |
| 91 | + NS_SWIFT_NAME(setUserProperty(_:forName:)); |
| 92 | + |
| 93 | +/// Sets the user ID property. This feature must be used in accordance with |
| 94 | +/// <a href="https://www.google.com/policies/privacy">Google's Privacy Policy</a> |
| 95 | +/// |
| 96 | +/// @param userID The user ID to ascribe to the user of this app on this device, which must be |
| 97 | +/// non-empty and no more than 256 characters long. Setting userID to nil removes the user ID. |
| 98 | ++ (void)setUserID:(nullable NSString *)userID; |
| 99 | + |
| 100 | +/// Sets whether analytics collection is enabled for this app on this device. This setting is |
| 101 | +/// persisted across app sessions. By default it is enabled. |
| 102 | +/// |
| 103 | +/// @param analyticsCollectionEnabled A flag that enables or disables Analytics collection. |
| 104 | ++ (void)setAnalyticsCollectionEnabled:(BOOL)analyticsCollectionEnabled; |
| 105 | + |
| 106 | +/// Sets the interval of inactivity in seconds that terminates the current session. The default |
| 107 | +/// value is 1800 seconds (30 minutes). |
| 108 | +/// |
| 109 | +/// @param sessionTimeoutInterval The custom time of inactivity in seconds before the current |
| 110 | +/// session terminates. |
| 111 | ++ (void)setSessionTimeoutInterval:(NSTimeInterval)sessionTimeoutInterval; |
| 112 | + |
| 113 | +/// Returns the unique ID for this instance of the application or nil if |
| 114 | +/// `ConsentType.analyticsStorage` has been set to `ConsentStatus.denied`. |
| 115 | +/// |
| 116 | +/// @see `FIRAnalytics+Consent.h` |
| 117 | ++ (nullable NSString *)appInstanceID; |
| 118 | + |
| 119 | +/// Clears all analytics data for this instance from the device and resets the app instance ID. |
| 120 | +/// FIRAnalyticsConfiguration values will be reset to the default values. |
| 121 | ++ (void)resetAnalyticsData; |
| 122 | + |
| 123 | +/// Adds parameters that will be set on every event logged from the SDK, including automatic ones. |
| 124 | +/// The values passed in the parameters dictionary will be added to the dictionary of default event |
| 125 | +/// parameters. These parameters persist across app runs. They are of lower precedence than event |
| 126 | +/// parameters, so if an event parameter and a parameter set using this API have the same name, the |
| 127 | +/// value of the event parameter will be used. The same limitations on event parameters apply to |
| 128 | +/// default event parameters. |
| 129 | +/// |
| 130 | +/// @param parameters Parameters to be added to the dictionary of parameters added to every event. |
| 131 | +/// They will be added to the dictionary of default event parameters, replacing any existing |
| 132 | +/// parameter with the same name. Valid parameters are NSString and NSNumber (signed 64-bit |
| 133 | +/// integer and 64-bit floating-point number). Setting a key's value to [NSNull null] will clear |
| 134 | +/// that parameter. Passing in a nil dictionary will clear all parameters. |
| 135 | ++ (void)setDefaultEventParameters:(nullable NSDictionary<NSString *, id> *)parameters; |
| 136 | + |
| 137 | +/// Unavailable. |
| 138 | +- (instancetype)init NS_UNAVAILABLE; |
| 139 | + |
| 140 | +@end |
| 141 | + |
| 142 | +NS_ASSUME_NONNULL_END |
0 commit comments