| | |
| | | |
| | | #import <Foundation/Foundation.h> |
| | | |
| | | #if !TARGET_OS_TV |
| | | #import <WebKit/WebKit.h> |
| | | #endif |
| | | |
| | | #import <FBSDKCoreKit/FBSDKGraphRequestConnection.h> |
| | | |
| | | #import "FBSDKMacros.h" |
| | | |
| | | @class FBSDKAccessToken; |
| | | @class FBSDKGraphRequest; |
| | | |
| | | /*! @abstract NSNotificationCenter name indicating a result of a failed log flush attempt. The posted object will be an NSError instance. */ |
| | | /** NSNotificationCenter name indicating a result of a failed log flush attempt. The posted object will be an NSError instance. */ |
| | | FBSDK_EXTERN NSString *const FBSDKAppEventsLoggingResultNotification; |
| | | |
| | | /*! @abstract optional plist key ("FacebookLoggingOverrideAppID") for setting `loggingOverrideAppID` */ |
| | | /** optional plist key ("FacebookLoggingOverrideAppID") for setting `loggingOverrideAppID` */ |
| | | FBSDK_EXTERN NSString *const FBSDKAppEventsOverrideAppIDBundleKey; |
| | | |
| | | /*! |
| | | /** |
| | | |
| | | @typedef NS_ENUM (NSUInteger, FBSDKAppEventsFlushBehavior) |
| | | NS_ENUM (NSUInteger, FBSDKAppEventsFlushBehavior) |
| | | |
| | | @abstract Specifies when `FBSDKAppEvents` sends log events to the server. |
| | | Specifies when `FBSDKAppEvents` sends log events to the server. |
| | | |
| | | */ |
| | | typedef NS_ENUM(NSUInteger, FBSDKAppEventsFlushBehavior) |
| | | { |
| | | |
| | | /*! Flush automatically: periodically (once a minute or every 100 logged events) and always at app reactivation. */ |
| | | /** Flush automatically: periodically (once a minute or every 100 logged events) and always at app reactivation. */ |
| | | FBSDKAppEventsFlushBehaviorAuto = 0, |
| | | |
| | | /*! Only flush when the `flush` method is called. When an app is moved to background/terminated, the |
| | | /** Only flush when the `flush` method is called. When an app is moved to background/terminated, the |
| | | events are persisted and re-established at activation, but they will only be written with an |
| | | explicit call to `flush`. */ |
| | | FBSDKAppEventsFlushBehaviorExplicitOnly, |
| | | |
| | | }; |
| | | |
| | | /*! |
| | | /** |
| | | @methodgroup Predefined event names for logging events common to many apps. Logging occurs through the `logEvent` family of methods on `FBSDKAppEvents`. |
| | | Common event parameters are provided in the `FBSDKAppEventsParameterNames*` constants. |
| | | */ |
| | | |
| | | /*! Log this event when the user has achieved a level in the app. */ |
| | | /** Log this event when the user has achieved a level in the app. */ |
| | | FBSDK_EXTERN NSString *const FBSDKAppEventNameAchievedLevel; |
| | | |
| | | /*! Log this event when the user has entered their payment info. */ |
| | | /** Log this event when the user has entered their payment info. */ |
| | | FBSDK_EXTERN NSString *const FBSDKAppEventNameAddedPaymentInfo; |
| | | |
| | | /*! Log this event when the user has added an item to their cart. The valueToSum passed to logEvent should be the item's price. */ |
| | | /** Log this event when the user has added an item to their cart. The valueToSum passed to logEvent should be the item's price. */ |
| | | FBSDK_EXTERN NSString *const FBSDKAppEventNameAddedToCart; |
| | | |
| | | /*! Log this event when the user has added an item to their wishlist. The valueToSum passed to logEvent should be the item's price. */ |
| | | /** Log this event when the user has added an item to their wishlist. The valueToSum passed to logEvent should be the item's price. */ |
| | | FBSDK_EXTERN NSString *const FBSDKAppEventNameAddedToWishlist; |
| | | |
| | | /*! Log this event when a user has completed registration with the app. */ |
| | | /** Log this event when a user has completed registration with the app. */ |
| | | FBSDK_EXTERN NSString *const FBSDKAppEventNameCompletedRegistration; |
| | | |
| | | /*! Log this event when the user has completed a tutorial in the app. */ |
| | | /** Log this event when the user has completed a tutorial in the app. */ |
| | | FBSDK_EXTERN NSString *const FBSDKAppEventNameCompletedTutorial; |
| | | |
| | | /*! Log this event when the user has entered the checkout process. The valueToSum passed to logEvent should be the total price in the cart. */ |
| | | /** Log this event when the user has entered the checkout process. The valueToSum passed to logEvent should be the total price in the cart. */ |
| | | FBSDK_EXTERN NSString *const FBSDKAppEventNameInitiatedCheckout; |
| | | |
| | | /*! Log this event when the user has rated an item in the app. The valueToSum passed to logEvent should be the numeric rating. */ |
| | | /** Log this event when the user has rated an item in the app. The valueToSum passed to logEvent should be the numeric rating. */ |
| | | FBSDK_EXTERN NSString *const FBSDKAppEventNameRated; |
| | | |
| | | /*! Log this event when a user has performed a search within the app. */ |
| | | /** Log this event when a user has performed a search within the app. */ |
| | | FBSDK_EXTERN NSString *const FBSDKAppEventNameSearched; |
| | | |
| | | /*! Log this event when the user has spent app credits. The valueToSum passed to logEvent should be the number of credits spent. */ |
| | | /** Log this event when the user has spent app credits. The valueToSum passed to logEvent should be the number of credits spent. */ |
| | | FBSDK_EXTERN NSString *const FBSDKAppEventNameSpentCredits; |
| | | |
| | | /*! Log this event when the user has unlocked an achievement in the app. */ |
| | | /** Log this event when the user has unlocked an achievement in the app. */ |
| | | FBSDK_EXTERN NSString *const FBSDKAppEventNameUnlockedAchievement; |
| | | |
| | | /*! Log this event when a user has viewed a form of content in the app. */ |
| | | /** Log this event when a user has viewed a form of content in the app. */ |
| | | FBSDK_EXTERN NSString *const FBSDKAppEventNameViewedContent; |
| | | |
| | | /*! |
| | | /** |
| | | @methodgroup Predefined event name parameters for common additional information to accompany events logged through the `logEvent` family |
| | | of methods on `FBSDKAppEvents`. Common event names are provided in the `FBAppEventName*` constants. |
| | | */ |
| | | |
| | | /*! Parameter key used to specify an ID for the specific piece of content being logged about. Could be an EAN, article identifier, etc., depending on the nature of the app. */ |
| | | /** |
| | | * Parameter key used to specify data for the one or more pieces of content being logged about. |
| | | * Data should be a JSON encoded string. |
| | | * Example: |
| | | * "[{\"id\": \"1234\", \"quantity\": 2, \"item_price\": 5.99}, {\"id\": \"5678\", \"quantity\": 1, \"item_price\": 9.99}]" |
| | | */ |
| | | FBSDK_EXTERN NSString *const FBSDKAppEventParameterNameContent; |
| | | |
| | | /** Parameter key used to specify an ID for the specific piece of content being logged about. Could be an EAN, article identifier, etc., depending on the nature of the app. */ |
| | | FBSDK_EXTERN NSString *const FBSDKAppEventParameterNameContentID; |
| | | |
| | | /*! Parameter key used to specify a generic content type/family for the logged event, e.g. "music", "photo", "video". Options to use will vary based upon what the app is all about. */ |
| | | /** Parameter key used to specify a generic content type/family for the logged event, e.g. "music", "photo", "video". Options to use will vary based upon what the app is all about. */ |
| | | FBSDK_EXTERN NSString *const FBSDKAppEventParameterNameContentType; |
| | | |
| | | /*! Parameter key used to specify currency used with logged event. E.g. "USD", "EUR", "GBP". See ISO-4217 for specific values. One reference for these is <http://en.wikipedia.org/wiki/ISO_4217>. */ |
| | | /** Parameter key used to specify currency used with logged event. E.g. "USD", "EUR", "GBP". See ISO-4217 for specific values. One reference for these is <http://en.wikipedia.org/wiki/ISO_4217>. */ |
| | | FBSDK_EXTERN NSString *const FBSDKAppEventParameterNameCurrency; |
| | | |
| | | /*! Parameter key used to specify a description appropriate to the event being logged. E.g., the name of the achievement unlocked in the `FBAppEventNameAchievementUnlocked` event. */ |
| | | /** Parameter key used to specify a description appropriate to the event being logged. E.g., the name of the achievement unlocked in the `FBAppEventNameAchievementUnlocked` event. */ |
| | | FBSDK_EXTERN NSString *const FBSDKAppEventParameterNameDescription; |
| | | |
| | | /*! Parameter key used to specify the level achieved in a `FBAppEventNameAchieved` event. */ |
| | | /** Parameter key used to specify the level achieved in a `FBAppEventNameAchieved` event. */ |
| | | FBSDK_EXTERN NSString *const FBSDKAppEventParameterNameLevel; |
| | | |
| | | /*! Parameter key used to specify the maximum rating available for the `FBAppEventNameRate` event. E.g., "5" or "10". */ |
| | | /** Parameter key used to specify the maximum rating available for the `FBAppEventNameRate` event. E.g., "5" or "10". */ |
| | | FBSDK_EXTERN NSString *const FBSDKAppEventParameterNameMaxRatingValue; |
| | | |
| | | /*! Parameter key used to specify how many items are being processed for an `FBAppEventNameInitiatedCheckout` or `FBAppEventNamePurchased` event. */ |
| | | /** Parameter key used to specify how many items are being processed for an `FBAppEventNameInitiatedCheckout` or `FBAppEventNamePurchased` event. */ |
| | | FBSDK_EXTERN NSString *const FBSDKAppEventParameterNameNumItems; |
| | | |
| | | /*! Parameter key used to specify whether payment info is available for the `FBAppEventNameInitiatedCheckout` event. `FBSDKAppEventParameterValueYes` and `FBSDKAppEventParameterValueNo` are good canonical values to use for this parameter. */ |
| | | /** Parameter key used to specify whether payment info is available for the `FBAppEventNameInitiatedCheckout` event. `FBSDKAppEventParameterValueYes` and `FBSDKAppEventParameterValueNo` are good canonical values to use for this parameter. */ |
| | | FBSDK_EXTERN NSString *const FBSDKAppEventParameterNamePaymentInfoAvailable; |
| | | |
| | | /*! Parameter key used to specify method user has used to register for the app, e.g., "Facebook", "email", "Twitter", etc */ |
| | | /** Parameter key used to specify method user has used to register for the app, e.g., "Facebook", "email", "Twitter", etc */ |
| | | FBSDK_EXTERN NSString *const FBSDKAppEventParameterNameRegistrationMethod; |
| | | |
| | | /*! Parameter key used to specify the string provided by the user for a search operation. */ |
| | | /** Parameter key used to specify the string provided by the user for a search operation. */ |
| | | FBSDK_EXTERN NSString *const FBSDKAppEventParameterNameSearchString; |
| | | |
| | | /*! Parameter key used to specify whether the activity being logged about was successful or not. `FBSDKAppEventParameterValueYes` and `FBSDKAppEventParameterValueNo` are good canonical values to use for this parameter. */ |
| | | /** Parameter key used to specify whether the activity being logged about was successful or not. `FBSDKAppEventParameterValueYes` and `FBSDKAppEventParameterValueNo` are good canonical values to use for this parameter. */ |
| | | FBSDK_EXTERN NSString *const FBSDKAppEventParameterNameSuccess; |
| | | |
| | | /* |
| | |
| | | of methods on `FBSDKAppEvents`. Common event parameters are provided in the `FBSDKAppEventParameterName*` constants. |
| | | */ |
| | | |
| | | /*! Yes-valued parameter value to be used with parameter keys that need a Yes/No value */ |
| | | /** Yes-valued parameter value to be used with parameter keys that need a Yes/No value */ |
| | | FBSDK_EXTERN NSString *const FBSDKAppEventParameterValueYes; |
| | | |
| | | /*! No-valued parameter value to be used with parameter keys that need a Yes/No value */ |
| | | /** No-valued parameter value to be used with parameter keys that need a Yes/No value */ |
| | | FBSDK_EXTERN NSString *const FBSDKAppEventParameterValueNo; |
| | | |
| | | |
| | | /*! |
| | | /** |
| | | |
| | | @class FBSDKAppEvents |
| | | |
| | | @abstract |
| | | Client-side event logging for specialized application analytics available through Facebook App Insights |
| | | Client-side event logging for specialized application analytics available through Facebook App Insights |
| | | and for use with Facebook Ads conversion tracking and optimization. |
| | | |
| | | @discussion |
| | | |
| | | |
| | | The `FBSDKAppEvents` static class has a few related roles: |
| | | |
| | | + Logging predefined and application-defined events to Facebook App Insights with a |
| | |
| | | * Basic event logging |
| | | */ |
| | | |
| | | /*! |
| | | /** |
| | | |
| | | @abstract |
| | | Log an event with just an eventName. |
| | | Log an event with just an eventName. |
| | | |
| | | @param eventName The name of the event to record. Limitations on number of events and name length |
| | | - Parameter eventName: The name of the event to record. Limitations on number of events and name length |
| | | are given in the `FBSDKAppEvents` documentation. |
| | | |
| | | */ |
| | | + (void)logEvent:(NSString *)eventName; |
| | | |
| | | /*! |
| | | /** |
| | | |
| | | @abstract |
| | | Log an event with an eventName and a numeric value to be aggregated with other events of this name. |
| | | Log an event with an eventName and a numeric value to be aggregated with other events of this name. |
| | | |
| | | @param eventName The name of the event to record. Limitations on number of events and name length |
| | | - Parameter eventName: The name of the event to record. Limitations on number of events and name length |
| | | are given in the `FBSDKAppEvents` documentation. Common event names are provided in `FBAppEventName*` constants. |
| | | |
| | | @param valueToSum Amount to be aggregated into all events of this eventName, and App Insights will report |
| | | - Parameter valueToSum: Amount to be aggregated into all events of this eventName, and App Insights will report |
| | | the cumulative and average value of this amount. |
| | | */ |
| | | + (void)logEvent:(NSString *)eventName |
| | | valueToSum:(double)valueToSum; |
| | | |
| | | |
| | | /*! |
| | | /** |
| | | |
| | | @abstract |
| | | Log an event with an eventName and a set of key/value pairs in the parameters dictionary. |
| | | Log an event with an eventName and a set of key/value pairs in the parameters dictionary. |
| | | Parameter limitations are described above. |
| | | |
| | | @param eventName The name of the event to record. Limitations on number of events and name construction |
| | | - Parameter eventName: The name of the event to record. Limitations on number of events and name construction |
| | | are given in the `FBSDKAppEvents` documentation. Common event names are provided in `FBAppEventName*` constants. |
| | | |
| | | @param parameters Arbitrary parameter dictionary of characteristics. The keys to this dictionary must |
| | | - Parameter parameters: Arbitrary parameter dictionary of characteristics. The keys to this dictionary must |
| | | be NSString's, and the values are expected to be NSString or NSNumber. Limitations on the number of |
| | | parameters and name construction are given in the `FBSDKAppEvents` documentation. Commonly used parameter names |
| | | are provided in `FBSDKAppEventParameterName*` constants. |
| | |
| | | + (void)logEvent:(NSString *)eventName |
| | | parameters:(NSDictionary *)parameters; |
| | | |
| | | /*! |
| | | /** |
| | | |
| | | @abstract |
| | | Log an event with an eventName, a numeric value to be aggregated with other events of this name, |
| | | Log an event with an eventName, a numeric value to be aggregated with other events of this name, |
| | | and a set of key/value pairs in the parameters dictionary. |
| | | |
| | | @param eventName The name of the event to record. Limitations on number of events and name construction |
| | | - Parameter eventName: The name of the event to record. Limitations on number of events and name construction |
| | | are given in the `FBSDKAppEvents` documentation. Common event names are provided in `FBAppEventName*` constants. |
| | | |
| | | @param valueToSum Amount to be aggregated into all events of this eventName, and App Insights will report |
| | | - Parameter valueToSum: Amount to be aggregated into all events of this eventName, and App Insights will report |
| | | the cumulative and average value of this amount. |
| | | |
| | | @param parameters Arbitrary parameter dictionary of characteristics. The keys to this dictionary must |
| | | - Parameter parameters: Arbitrary parameter dictionary of characteristics. The keys to this dictionary must |
| | | be NSString's, and the values are expected to be NSString or NSNumber. Limitations on the number of |
| | | parameters and name construction are given in the `FBSDKAppEvents` documentation. Commonly used parameter names |
| | | are provided in `FBSDKAppEventParameterName*` constants. |
| | |
| | | parameters:(NSDictionary *)parameters; |
| | | |
| | | |
| | | /*! |
| | | /** |
| | | |
| | | @abstract |
| | | Log an event with an eventName, a numeric value to be aggregated with other events of this name, |
| | | Log an event with an eventName, a numeric value to be aggregated with other events of this name, |
| | | and a set of key/value pairs in the parameters dictionary. Providing session lets the developer |
| | | target a particular <FBSession>. If nil is provided, then `[FBSession activeSession]` will be used. |
| | | |
| | | @param eventName The name of the event to record. Limitations on number of events and name construction |
| | | - Parameter eventName: The name of the event to record. Limitations on number of events and name construction |
| | | are given in the `FBSDKAppEvents` documentation. Common event names are provided in `FBAppEventName*` constants. |
| | | |
| | | @param valueToSum Amount to be aggregated into all events of this eventName, and App Insights will report |
| | | - Parameter valueToSum: Amount to be aggregated into all events of this eventName, and App Insights will report |
| | | the cumulative and average value of this amount. Note that this is an NSNumber, and a value of `nil` denotes |
| | | that this event doesn't have a value associated with it for summation. |
| | | |
| | | @param parameters Arbitrary parameter dictionary of characteristics. The keys to this dictionary must |
| | | - Parameter parameters: Arbitrary parameter dictionary of characteristics. The keys to this dictionary must |
| | | be NSString's, and the values are expected to be NSString or NSNumber. Limitations on the number of |
| | | parameters and name construction are given in the `FBSDKAppEvents` documentation. Commonly used parameter names |
| | | are provided in `FBSDKAppEventParameterName*` constants. |
| | | |
| | | @param accessToken The optional access token to log the event as. |
| | | - Parameter accessToken: The optional access token to log the event as. |
| | | */ |
| | | + (void)logEvent:(NSString *)eventName |
| | | valueToSum:(NSNumber *)valueToSum |
| | |
| | | * Purchase logging |
| | | */ |
| | | |
| | | /*! |
| | | /** |
| | | |
| | | @abstract |
| | | Log a purchase of the specified amount, in the specified currency. |
| | | Log a purchase of the specified amount, in the specified currency. |
| | | |
| | | @param purchaseAmount Purchase amount to be logged, as expressed in the specified currency. This value |
| | | - Parameter purchaseAmount: Purchase amount to be logged, as expressed in the specified currency. This value |
| | | will be rounded to the thousandths place (e.g., 12.34567 becomes 12.346). |
| | | |
| | | @param currency Currency, is denoted as, e.g. "USD", "EUR", "GBP". See ISO-4217 for |
| | | - Parameter currency: Currency, is denoted as, e.g. "USD", "EUR", "GBP". See ISO-4217 for |
| | | specific values. One reference for these is <http://en.wikipedia.org/wiki/ISO_4217>. |
| | | |
| | | @discussion This event immediately triggers a flush of the `FBSDKAppEvents` event queue, unless the `flushBehavior` is set |
| | | |
| | | This event immediately triggers a flush of the `FBSDKAppEvents` event queue, unless the `flushBehavior` is set |
| | | to `FBSDKAppEventsFlushBehaviorExplicitOnly`. |
| | | |
| | | */ |
| | | + (void)logPurchase:(double)purchaseAmount |
| | | currency:(NSString *)currency; |
| | | |
| | | /*! |
| | | /** |
| | | |
| | | @abstract |
| | | Log a purchase of the specified amount, in the specified currency, also providing a set of |
| | | Log a purchase of the specified amount, in the specified currency, also providing a set of |
| | | additional characteristics describing the purchase. |
| | | |
| | | @param purchaseAmount Purchase amount to be logged, as expressed in the specified currency.This value |
| | | - Parameter purchaseAmount: Purchase amount to be logged, as expressed in the specified currency.This value |
| | | will be rounded to the thousandths place (e.g., 12.34567 becomes 12.346). |
| | | |
| | | @param currency Currency, is denoted as, e.g. "USD", "EUR", "GBP". See ISO-4217 for |
| | | - Parameter currency: Currency, is denoted as, e.g. "USD", "EUR", "GBP". See ISO-4217 for |
| | | specific values. One reference for these is <http://en.wikipedia.org/wiki/ISO_4217>. |
| | | |
| | | @param parameters Arbitrary parameter dictionary of characteristics. The keys to this dictionary must |
| | | - Parameter parameters: Arbitrary parameter dictionary of characteristics. The keys to this dictionary must |
| | | be NSString's, and the values are expected to be NSString or NSNumber. Limitations on the number of |
| | | parameters and name construction are given in the `FBSDKAppEvents` documentation. Commonly used parameter names |
| | | are provided in `FBSDKAppEventParameterName*` constants. |
| | | |
| | | @discussion This event immediately triggers a flush of the `FBSDKAppEvents` event queue, unless the `flushBehavior` is set |
| | | |
| | | This event immediately triggers a flush of the `FBSDKAppEvents` event queue, unless the `flushBehavior` is set |
| | | to `FBSDKAppEventsFlushBehaviorExplicitOnly`. |
| | | |
| | | */ |
| | |
| | | currency:(NSString *)currency |
| | | parameters:(NSDictionary *)parameters; |
| | | |
| | | /*! |
| | | /** |
| | | |
| | | @abstract |
| | | Log a purchase of the specified amount, in the specified currency, also providing a set of |
| | | Log a purchase of the specified amount, in the specified currency, also providing a set of |
| | | additional characteristics describing the purchase, as well as an <FBSession> to log to. |
| | | |
| | | @param purchaseAmount Purchase amount to be logged, as expressed in the specified currency.This value |
| | | - Parameter purchaseAmount: Purchase amount to be logged, as expressed in the specified currency.This value |
| | | will be rounded to the thousandths place (e.g., 12.34567 becomes 12.346). |
| | | |
| | | @param currency Currency, is denoted as, e.g. "USD", "EUR", "GBP". See ISO-4217 for |
| | | - Parameter currency: Currency, is denoted as, e.g. "USD", "EUR", "GBP". See ISO-4217 for |
| | | specific values. One reference for these is <http://en.wikipedia.org/wiki/ISO_4217>. |
| | | |
| | | @param parameters Arbitrary parameter dictionary of characteristics. The keys to this dictionary must |
| | | - Parameter parameters: Arbitrary parameter dictionary of characteristics. The keys to this dictionary must |
| | | be NSString's, and the values are expected to be NSString or NSNumber. Limitations on the number of |
| | | parameters and name construction are given in the `FBSDKAppEvents` documentation. Commonly used parameter names |
| | | are provided in `FBSDKAppEventParameterName*` constants. |
| | | |
| | | @param accessToken The optional access token to log the event as. |
| | | - Parameter accessToken: The optional access token to log the event as. |
| | | |
| | | @discussion This event immediately triggers a flush of the `FBSDKAppEvents` event queue, unless the `flushBehavior` is set |
| | | |
| | | This event immediately triggers a flush of the `FBSDKAppEvents` event queue, unless the `flushBehavior` is set |
| | | to `FBSDKAppEventsFlushBehaviorExplicitOnly`. |
| | | |
| | | */ |
| | |
| | | * Push Notifications Logging |
| | | */ |
| | | |
| | | /*! |
| | | @abstract |
| | | Log an app event that tracks that the application was open via Push Notification. |
| | | /** |
| | | Log an app event that tracks that the application was open via Push Notification. |
| | | |
| | | @param payload Notification payload received via `UIApplicationDelegate`. |
| | | - Parameter payload: Notification payload received via `UIApplicationDelegate`. |
| | | */ |
| | | + (void)logPushNotificationOpen:(NSDictionary *)payload; |
| | | |
| | | /*! |
| | | @abstract |
| | | Log an app event that tracks that a custom action was taken from a push notification. |
| | | /** |
| | | Log an app event that tracks that a custom action was taken from a push notification. |
| | | |
| | | @param payload Notification payload received via `UIApplicationDelegate`. |
| | | @param action Name of the action that was taken. |
| | | - Parameter payload: Notification payload received via `UIApplicationDelegate`. |
| | | - Parameter action: Name of the action that was taken. |
| | | */ |
| | | + (void)logPushNotificationOpen:(NSDictionary *)payload action:(NSString *)action; |
| | | |
| | | /*! |
| | | /** |
| | | |
| | | @abstract |
| | | Notifies the events system that the app has launched and, when appropriate, logs an "activated app" event. Should typically be placed in the |
| | | Notifies the events system that the app has launched and, when appropriate, logs an "activated app" event. |
| | | This function is called automatically from FBSDKApplicationDelegate applicationDidBecomeActive, unless |
| | | one overrides 'FacebookAutoLogAppEventsEnabled' key to false in the project info plist file. |
| | | In case 'FacebookAutoLogAppEventsEnabled' is set to false, then it should typically be placed in the |
| | | app delegates' `applicationDidBecomeActive:` method. |
| | | |
| | | This method also takes care of logging the event indicating the first time this app has been launched, which, among other things, is used to |
| | | track user acquisition and app install ads conversions. |
| | | |
| | | @discussion |
| | | |
| | | |
| | | `activateApp` will not log an event on every app launch, since launches happen every time the app is backgrounded and then foregrounded. |
| | | "activated app" events will be logged when the app has not been active for more than 60 seconds. This method also causes a "deactivated app" |
| | | event to be logged when sessions are "completed", and these events are logged with the session length, with an indication of how much |
| | |
| | | * Push Notifications Registration |
| | | */ |
| | | |
| | | /*! |
| | | @abstract |
| | | Sets a device token to register the current application installation for push notifications. |
| | | /** |
| | | Sets and sends device token to register the current application for push notifications. |
| | | |
| | | @discussion |
| | | Sets a device token from `NSData` representation that you get from `UIApplicationDelegate.-application:didRegisterForRemoteNotificationsWithDeviceToken:`. |
| | | |
| | | @param deviceToken Device token data. |
| | | |
| | | Sets and sends a device token from `NSData` representation that you get from `UIApplicationDelegate.-application:didRegisterForRemoteNotificationsWithDeviceToken:`. |
| | | |
| | | - Parameter deviceToken: Device token data. |
| | | */ |
| | | + (void)setPushNotificationsDeviceToken:(NSData *)deviceToken; |
| | | |
| | |
| | | * Control over event batching/flushing |
| | | */ |
| | | |
| | | /*! |
| | | /** |
| | | |
| | | @abstract |
| | | Get the current event flushing behavior specifying when events are sent back to Facebook servers. |
| | | Get the current event flushing behavior specifying when events are sent back to Facebook servers. |
| | | */ |
| | | + (FBSDKAppEventsFlushBehavior)flushBehavior; |
| | | |
| | | /*! |
| | | /** |
| | | |
| | | @abstract |
| | | Set the current event flushing behavior specifying when events are sent back to Facebook servers. |
| | | Set the current event flushing behavior specifying when events are sent back to Facebook servers. |
| | | |
| | | @param flushBehavior The desired `FBSDKAppEventsFlushBehavior` to be used. |
| | | - Parameter flushBehavior: The desired `FBSDKAppEventsFlushBehavior` to be used. |
| | | */ |
| | | + (void)setFlushBehavior:(FBSDKAppEventsFlushBehavior)flushBehavior; |
| | | |
| | | /*! |
| | | @abstract |
| | | Set the 'override' App ID for App Event logging. |
| | | /** |
| | | Set the 'override' App ID for App Event logging. |
| | | |
| | | @discussion |
| | | |
| | | |
| | | In some cases, apps want to use one Facebook App ID for login and social presence and another |
| | | for App Event logging. (An example is if multiple apps from the same company share an app ID for login, but |
| | | want distinct logging.) By default, this value is `nil`, and defers to the `FBSDKAppEventsOverrideAppIDBundleKey` |
| | |
| | | This should be set before any other calls are made to `FBSDKAppEvents`. Thus, you should set it in your application |
| | | delegate's `application:didFinishLaunchingWithOptions:` delegate. |
| | | |
| | | @param appID The Facebook App ID to be used for App Event logging. |
| | | - Parameter appID: The Facebook App ID to be used for App Event logging. |
| | | */ |
| | | + (void)setLoggingOverrideAppID:(NSString *)appID; |
| | | |
| | | /*! |
| | | @abstract |
| | | Get the 'override' App ID for App Event logging. |
| | | /** |
| | | Get the 'override' App ID for App Event logging. |
| | | |
| | | @see setLoggingOverrideAppID: |
| | | |
| | | - See:setLoggingOverrideAppID: |
| | | |
| | | */ |
| | | + (NSString *)loggingOverrideAppID; |
| | | |
| | | |
| | | /*! |
| | | @abstract |
| | | Explicitly kick off flushing of events to Facebook. This is an asynchronous method, but it does initiate an immediate |
| | | /** |
| | | Explicitly kick off flushing of events to Facebook. This is an asynchronous method, but it does initiate an immediate |
| | | kick off. Server failures will be reported through the NotificationCenter with notification ID `FBSDKAppEventsLoggingResultNotification`. |
| | | */ |
| | | + (void)flush; |
| | | |
| | | /*! |
| | | @abstract |
| | | Creates a request representing the Graph API call to retrieve a Custom Audience "third party ID" for the app's Facebook user. |
| | | /** |
| | | Creates a request representing the Graph API call to retrieve a Custom Audience "third party ID" for the app's Facebook user. |
| | | Callers will send this ID back to their own servers, collect up a set to create a Facebook Custom Audience with, |
| | | and then use the resultant Custom Audience to target ads. |
| | | |
| | | @param accessToken The access token to use to establish the user's identity for users logged into Facebook through this app. |
| | | - Parameter accessToken: The access token to use to establish the user's identity for users logged into Facebook through this app. |
| | | If `nil`, then the `[FBSDKAccessToken currentAccessToken]` is used. |
| | | |
| | | @discussion |
| | | |
| | | |
| | | The JSON in the request's response will include an "custom_audience_third_party_id" key/value pair, with the value being the ID retrieved. |
| | | This ID is an encrypted encoding of the Facebook user's ID and the invoking Facebook app ID. |
| | | Multiple calls with the same user will return different IDs, thus these IDs cannot be used to correlate behavior |
| | |
| | | via the `[FBSDKSettings limitEventAndDataUsage]` flag, or a specific Facebook user cannot be identified. |
| | | */ |
| | | + (FBSDKGraphRequest *)requestForCustomAudienceThirdPartyIDWithAccessToken:(FBSDKAccessToken *)accessToken; |
| | | |
| | | /* |
| | | Sets a custom user ID to associate with all app events. |
| | | |
| | | The userID is persisted until it is cleared by passing nil. |
| | | */ |
| | | + (void)setUserID:(NSString *)userID; |
| | | |
| | | /* |
| | | Clears the custom user ID to associate with all app events. |
| | | */ |
| | | + (void)clearUserID; |
| | | |
| | | /* |
| | | Returns the set custom user ID. |
| | | */ |
| | | + (NSString *)userID; |
| | | |
| | | /* |
| | | Sends a request to update the properties for the current user, set by `setUserID:` |
| | | |
| | | You must call `FBSDKAppEvents setUserID:` before making this call. |
| | | - Parameter properties: the custom user properties |
| | | - Parameter handler: the optional completion handler |
| | | */ |
| | | + (void)updateUserProperties:(NSDictionary *)properties handler:(FBSDKGraphRequestHandler)handler; |
| | | |
| | | #if !TARGET_OS_TV |
| | | /* |
| | | Intended to be used as part of a hybrid webapp. |
| | | If you call this method, the FB SDK will inject a new JavaScript object into your webview. |
| | | If the FB Pixel is used within the webview, and references the app ID of this app, |
| | | then it will detect the presence of this injected JavaScript object |
| | | and pass Pixel events back to the FB SDK for logging using the AppEvents framework. |
| | | |
| | | - Parameter webView: The webview to augment with the additional JavaScript behaviour |
| | | */ |
| | | + (void)augmentHybridWKWebView:(WKWebView *)webView; |
| | | #endif |
| | | |
| | | @end |