diff --git a/Flurry API Documentation/_flurry_8h_source.html b/Flurry API Documentation/_flurry_8h_source.html new file mode 100755 index 0000000..650198b --- /dev/null +++ b/Flurry API Documentation/_flurry_8h_source.html @@ -0,0 +1,191 @@ + + +
+ + + +Flurry | |
<FlurryAdDelegate> | Provides all available delegates for receiving callbacks related to Ad Serving |
FlurryAds | Provides all available methods for displaying ads |
This is the complete list of members for Flurry, including all inherited members.
+This is the complete list of members for FlurryAds, including all inherited members.
++ | addCustomAdNetwork:withProperties: | FlurryAds | static |
+ | adReadyForSpace: | FlurryAds | static |
+ | clearKeywords | FlurryAds | static |
+ | clearUserCookies | FlurryAds | static |
+ | displayAdForSpace:modallyForViewController: | FlurryAds | static |
+ | displayAdForSpace:onView: | FlurryAds | static |
+ | enableTestAds: | FlurryAds | static |
+ | fetchAdForSpace:frame:size: | FlurryAds | static |
+ | fetchAndDisplayAdForSpace:view:size: | FlurryAds | static |
+ | initialize: | FlurryAds | static |
+ | isAdAvailableForSpace:view:size:timeout: | FlurryAds | static |
+ | removeAdFromSpace: | FlurryAds | static |
+ | setAdDelegate: | FlurryAds | static |
+ | setKeywordsForTargeting: | FlurryAds | static |
+ | setUserCookies: | FlurryAds | static |
+ | showAdForSpace:view:size:timeout: | FlurryAds | static |
+Directories | |
directory | Flurry.Release.4.2.4 |
Downloads | |
Flurry.Release.4.2.4 | |
Flurry | |
Flurry.h | |
FlurryAds | |
FlurryAdDelegate.h | |
FlurryAds.h |
NSObject | |
Flurry | |
FlurryAds | Provides all available methods for displaying ads |
<NSObject> | |
<FlurryAdDelegate> | Provides all available delegates for receiving callbacks related to Ad Serving |
Inherits NSObject.
++Class Methods | |
(void) | + startSession: |
Start a Flurry session for the project denoted by apiKey . More... | |
(void) | + startSession:withOptions: |
Start a Flurry session for the project denoted by apiKey . More... | |
(void) | + pauseBackgroundSession |
Pauses a Flurry session left running in background. More... | |
Pre-Session Calls | |
Optional sdk settings that should be called before start session. + | |
(void) | + setAppVersion: |
Explicitly specifies the App Version that Flurry will use to group Analytics data. More... | |
(NSString *) | + getFlurryAgentVersion |
Retrieves the Flurry Agent Build Version. More... | |
(void) | + setShowErrorInLogEnabled: |
Displays an exception in the debug log if thrown during a Session. More... | |
(void) | + setDebugLogEnabled: |
Generates debug logs to console. More... | |
(void) | + setLogLevel: |
Generates debug logs to console. More... | |
(void) | + setSessionContinueSeconds: |
Set the timeout for expiring a Flurry session. More... | |
(void) | + setSecureTransportEnabled: |
Send data over a secure transport. More... | |
(void) | + setCrashReportingEnabled: |
Enable automatic collection of crash reports. More... | |
Event and Error Logging | |
Methods for reporting custom events and errors during the session. + | |
(void) | + logEvent: |
Records a custom event specified by eventName . More... | |
(void) | + logEvent:withParameters: |
Records a custom parameterized event specified by eventName with parameters . More... | |
(void) | + logError:message:exception: |
Records an app exception. Commonly used to catch unhandled exceptions. More... | |
(void) | + logError:message:error: |
Records an app error. More... | |
(void) | + logEvent:timed: |
Records a timed event specified by eventName . More... | |
(void) | + logEvent:withParameters:timed: |
Records a custom parameterized timed event specified by eventName with parameters . More... | |
(void) | + endTimedEvent:withParameters: |
Ends a timed event specified by eventName and optionally updates parameters with parameters . More... | |
Page View Methods | |
Count page views. + | |
(void) | + logAllPageViews: |
Automatically track page views on a UINavigationController or UITabBarController . More... | |
(void) | + logPageView |
Explicitly track a page view during a session. More... | |
User Info | |
Methods to set user information. + | |
(void) | + setUserID: |
Assign a unique id for a user in your app. More... | |
(void) | + setAge: |
Set your user's age in years. More... | |
(void) | + setGender: |
Set your user's gender. More... | |
Location Reporting | |
Methods for setting location information. + | |
(void) | + setLatitude:longitude:horizontalAccuracy:verticalAccuracy: |
Set the location of the session. More... | |
Session Reporting Calls | |
Optional methods that can be called at any point to control session reporting. + | |
(void) | + setSessionReportsOnCloseEnabled: |
Set session to report when app closes. More... | |
(void) | + setSessionReportsOnPauseEnabled: |
Set session to report when app is sent to the background. More... | |
(void) | + setBackgroundSessionEnabled: |
Set session to support background execution. More... | |
(void) | + setEventLoggingEnabled: |
Enable custom event logging. More... | |
(void) | + setPushToken: |
Set device push token. More... | |
+ (void) endTimedEvent: | ++ | (NSString *) | +eventName | +
withParameters: | ++ | (NSDictionary *) | +parameters | +
+ | + | + |
Ends a timed event specified by eventName
and optionally updates parameters with parameters
.
This method ends an existing timed event. If parameters are provided, this will overwrite existing parameters with the same name or create new parameters if the name does not exist in the parameter map set by logEvent:withParameters:timed:.
+eventName | Name of the event. For maximum effectiveness, we recommend using a naming scheme that can be easily understood by non-technical people in your business domain. |
parameters | A map containing Name-Value pairs of parameters. |
+ (NSString *) getFlurryAgentVersion | ++ | + | + |
Retrieves the Flurry Agent Build Version.
+This is an optional method that retrieves the Flurry Agent Version the app is running under. It is most often used if reporting an unexpected behavior of the SDK to Flurry Support
++ (void) logAllPageViews: | ++ | (id) | +target | ++ |
Automatically track page views on a UINavigationController
or UITabBarController
.
This method increments the page view count for a session based on traversing a UINavigationController or UITabBarController. The page view count is only a counter for the number of transitions in your app. It does not associate a name with the page count. To associate a name with a count of occurences see logEvent:.
+target | The navigation or tab bar controller. |
+ (void) logError: | ++ | (NSString *) | +errorID | +
message: | ++ | (NSString *) | +message | +
error: | ++ | (NSError *) | +error | +
+ | + | + |
Records an app error.
+This method captures an error for reporting to Flurry.
+errorID | Name of the error. |
message | The message to associate with the error. |
error | The error object to report. |
+ (void) logError: | ++ | (NSString *) | +errorID | +
message: | ++ | (NSString *) | +message | +
exception: | ++ | (NSException *) | +exception | +
+ | + | + |
Records an app exception. Commonly used to catch unhandled exceptions.
+This method captures an exception for reporting to Flurry. We recommend adding an uncaught exception listener to capture any exceptions that occur during usage that is not anticipated by your app.
+errorID | Name of the error. |
message | The message to associate with the error. |
exception | The exception object to report. |
+ (void) logEvent: | ++ | (NSString *) | +eventName | ++ |
Records a custom event specified by eventName
.
This method allows you to specify custom events within your app. As a general rule you should capture events related to user navigation within your app, any action around monetization, and other events as they are applicable to tracking progress towards your business goals.
+eventName | Name of the event. For maximum effectiveness, we recommend using a naming scheme that can be easily understood by non-technical people in your business domain. |
+ (void) logEvent: | ++ | (NSString *) | +eventName | +
timed: | ++ | (BOOL) | +timed | +
+ | + | + |
Records a timed event specified by eventName
.
This method overrides #logEvent to allow you to capture the length of an event. This can be extremely valuable to understand the level of engagement with a particular action. For example, you can capture how long a user spends on a level or reading an article.
+eventName | Name of the event. For maximum effectiveness, we recommend using a naming scheme that can be easily understood by non-technical people in your business domain. |
timed | Specifies the event will be timed. |
+ (void) logEvent: | ++ | (NSString *) | +eventName | +
withParameters: | ++ | (NSDictionary *) | +parameters | +
+ | + | + |
Records a custom parameterized event specified by eventName
with parameters
.
This method overrides #logEvent to allow you to associate parameters with an event. Parameters are extremely valuable as they allow you to store characteristics of an action. For example, if a user purchased an item it may be helpful to know what level that user was on. By setting this parameter you will be able to view a distribution of levels for the purcahsed event on the Flurrly Dev Portal.
+eventName | Name of the event. For maximum effectiveness, we recommend using a naming scheme that can be easily understood by non-technical people in your business domain. |
parameters | A map containing Name-Value pairs of parameters. |
+ (void) logEvent: | ++ | (NSString *) | +eventName | +
withParameters: | ++ | (NSDictionary *) | +parameters | +
timed: | ++ | (BOOL) | +timed | +
+ | + | + |
Records a custom parameterized timed event specified by eventName
with parameters
.
This method overrides #logEvent to allow you to capture the length of an event with parameters. This can be extremely valuable to understand the level of engagement with a particular action and the characteristics associated with that action. For example, you can capture how long a user spends on a level or reading an article. Parameters can be used to capture, for example, the author of an article or if something was purchased while on the level.
+eventName | Name of the event. For maximum effectiveness, we recommend using a naming scheme that can be easily understood by non-technical people in your business domain. |
parameters | A map containing Name-Value pairs of parameters. |
timed | Specifies the event will be timed. |
+ (void) logPageView | ++ | + | + |
Explicitly track a page view during a session.
+This method increments the page view count for a session when invoked. It does not associate a name with the page count. To associate a name with a count of occurences see logEvent:.
++ (void) pauseBackgroundSession | ++ | + | + |
Pauses a Flurry session left running in background.
+This method should be used in case of setBackgroundSessionEnabled: set to YES. It can be called when application finished all background tasks (such as playing music) to pause session.
++ (void) setAge: | ++ | (int) | +age | ++ |
Set your user's age in years.
+Use this method to capture the age of your user. Only use this method if you collect this information explictly from your user (i.e. - there is no need to set a default value).
+age | Reported age of user. |
+ (void) setAppVersion: | ++ | (NSString *) | +version | ++ |
Explicitly specifies the App Version that Flurry will use to group Analytics data.
+This is an optional method that overrides the App Version Flurry uses for reporting. Flurry will use the CFBundleVersion in your info.plist file when this method is not invoked.
+version | The custom version name. |
+ (void) setBackgroundSessionEnabled: | ++ | (BOOL) | +setBackgroundSessionEnabled | ++ |
Set session to support background execution.
+Use this method to enable reporting of errors and events when application is running in backgorund (such applications have UIBackgroundModes in Info.plist). You should call pauseBackgroundSession when appropriate in background mode to pause the session (for example when played song completed in background)
+Default value is NO
setBackgroundSessionEnabled | YES to enbale background support and continue log events and errors for running session. |
+ (void) setCrashReportingEnabled: | ++ | (BOOL) | +value | ++ |
Enable automatic collection of crash reports.
+This is an optional method that collects crash reports when enabled. The default value is NO
.
value | YES to enable collection of crash reports. |
+ (void) setDebugLogEnabled: | ++ | (BOOL) | +value | ++ |
Generates debug logs to console.
+This is an optional method that displays debug information related to the Flurry SDK. display information to the console. The default setting for this method is NO
which sets the log level to FlurryLogLevelCriticalOnly
. When set to YES
the debug log level is set to FlurryLogLevelDebug
value | YES to show debug logs, NO to omit debug logs. |
+ (void) setEventLoggingEnabled: | ++ | (BOOL) | +value | ++ |
Enable custom event logging.
+Use this method to allow the capture of custom events. The default value is YES
.
value | YES to enable event logging, NO to stop custom logging. |
+ (void) setGender: | ++ | (NSString *) | +gender | ++ |
Set your user's gender.
+Use this method to capture the gender of your user. Only use this method if you collect this information explictly from your user (i.e. - there is no need to set a default value). Allowable values are "m" or @c @"f"
gender | Reported gender of user. |
+ (void) setLatitude: | ++ | (double) | +latitude | +
longitude: | ++ | (double) | +longitude | +
horizontalAccuracy: | ++ | (float) | +horizontalAccuracy | +
verticalAccuracy: | ++ | (float) | +verticalAccuracy | +
+ | + | + |
Set the location of the session.
+Use information from the CLLocationManager to specify the location of the session. Flurry does not automatically track this information or include the CLLocation framework.
+After starting the location manager, you can set the location with Flurry. You can implement CLLocationManagerDelegate to be aware of when the location is updated. Below is an example of how to use this method, after you have recieved a location update from the locationManager.
+latitude | The latitude. |
longitude | The longitude. |
horizontalAccuracy | The radius of uncertainty for the location in meters. |
verticalAccuracy | The accuracy of the altitude value in meters. |
+ (void) setLogLevel: | ++ | (FlurryLogLevel) | +value | ++ |
Generates debug logs to console.
+This is an optional method that displays debug information related to the Flurry SDK. display information to the console. The default setting for this method is FlurryLogLevelCritycalOnly
.
value | Log level |
+ (void) setPushToken: | ++ | (NSString *) | +pushToken | ++ |
Set device push token.
+After the device has successfully registered with APNS, call this method to set the push token received from APNS.
+ ++ (void) setSecureTransportEnabled: | ++ | (BOOL) | +value | ++ |
Send data over a secure transport.
+This is an optional method that sends data over an SSL connection when enabled. The default value is NO
.
value | YES to send data over secure connection. |
+ (void) setSessionContinueSeconds: | ++ | (int) | +seconds | ++ |
Set the timeout for expiring a Flurry session.
+This is an optional method that sets the time the app may be in the background before starting a new session upon resume. The default value for the session timeout is 10 seconds in the background.
+seconds | The time in seconds to set the session timeout to. |
+ (void) setSessionReportsOnCloseEnabled: | ++ | (BOOL) | +sendSessionReportsOnClose | ++ |
Set session to report when app closes.
+Use this method report session data when the app is closed. The default value is YES
.
sendSessionReportsOnClose | YES to send on close, NO to omit reporting on close. |
+ (void) setSessionReportsOnPauseEnabled: | ++ | (BOOL) | +setSessionReportsOnPauseEnabled | ++ |
Set session to report when app is sent to the background.
+Use this method report session data when the app is paused. The default value is YES
.
setSessionReportsOnPauseEnabled | YES to send on pause, NO to omit reporting on pause. |
+ (void) setShowErrorInLogEnabled: | ++ | (BOOL) | +value | ++ |
Displays an exception in the debug log if thrown during a Session.
+This is an optional method that augments the debug logs with exceptions that occur during the session. You must both capture exceptions to Flurry and set debug logging to enabled for this method to display information to the console. The default setting for this method is NO
.
value | YES to show errors in debug logs, NO to omit errors in debug logs. |
+ (void) setUserID: | ++ | (NSString *) | +userID | ++ |
Assign a unique id for a user in your app.
+userID | The app id for a user. |
+ (void) startSession: | ++ | (NSString *) | +apiKey | ++ |
Start a Flurry session for the project denoted by apiKey
.
This method serves as the entry point to Flurry Analytics collection. It must be called in the scope of applicationDidFinishLaunching
. The session will continue for the period the app is in the foreground until your app is backgrounded for the time specified in setSessionContinueSeconds:. If the app is resumed in that period the session will continue, otherwise a new session will begin.
Crash reporting will not be enabled. See setCrashReportingEnabled: for more information.
+apiKey | The API key for this project. |
+ (void) startSession: | ++ | (NSString *) | +apiKey | +
withOptions: | ++ | (id) | +options | +
+ | + | + |
Start a Flurry session for the project denoted by apiKey
.
This method serves as the entry point to Flurry Analytics collection. It must be called in the scope of applicationDidFinishLaunching
passing in the launchOptions param. The session will continue for the period the app is in the foreground until your app is backgrounded for the time specified in setSessionContinueSeconds:. If the app is resumed in that period the session will continue, otherwise a new session will begin.
apiKey | The API key for this project. |
options | passed launchOptions from the applicatin's didFinishLaunchingWithOptions:(NSDictionary *)launchOptions |
Provides all available methods for displaying ads. + More...
+ +#import <FlurryAds.h>
Inherits NSObject.
++Class Methods | |
(void) | + fetchAdForSpace:frame:size: |
Retrieves an ad for the given space . More... | |
(BOOL) | + adReadyForSpace: |
Returns if an ad is currently ready to display for a given space . More... | |
(void) | + displayAdForSpace:onView: |
Display an ad for the given space . More... | |
(void) | + displayAdForSpace:modallyForViewController: |
Display an ad for the given interstitial space . More... | |
(BOOL) | + isAdAvailableForSpace:view:size:timeout: |
[Deprecated] Check if an ad is available for the given space . More... | |
(BOOL) | + showAdForSpace:view:size:timeout: |
[Deprecated] Display an ad for the given space . More... | |
(void) | + fetchAndDisplayAdForSpace:view:size: |
Fetch and Display an ad for the given space . More... | |
(void) | + removeAdFromSpace: |
Removes an ad for the given space . More... | |
(void) | + initialize: |
Initializes the ad serving system. More... | |
(void) | + setAdDelegate: |
Sets the object to receive various delegate methods. More... | |
(void) | + enableTestAds: |
Informs server to send test ads. More... | |
(void) | + setUserCookies: |
Sets a dictionary of key/value pairs, which will be transmitted to Flurry servers when a user clicks on an ad. More... | |
(void) | + clearUserCookies |
Removes a previously set dictionary of key/value pairs. More... | |
(void) | + setKeywordsForTargeting: |
Sets a dictionary of key/value pairs, which will be transmitted to Flurry servers when an ad is requested. More... | |
(void) | + clearKeywords |
Removes a previously set dictionary of key/value pairs. More... | |
(void) | + addCustomAdNetwork:withProperties: |
Method to add a custom ad network to be served through the standard Flurry ad system. More... | |
Provides all available methods for displaying ads.
+Set of methods that allow publishers to configure, target, and deliver ads to their customers.
++ (void) addCustomAdNetwork: | ++ | (Class< FlurryCustomAdNetwork >) | +adNetworkClass | +
withProperties: | ++ | (id< FlurryCustomAdNetworkProperties >) | +adNetworkProperties | +
+ | + | + |
+ (BOOL) adReadyForSpace: | ++ | (NSString *) | +space | ++ |
Returns if an ad is currently ready to display for a given space
.
This method will verify if there is an ad is currently available for this user. If an ad is not available, you may call #fetchAdForSpace:view:size: to load a new ad.
+space
simply represents the placement of the ad in your app and should be unique for each placement. For example, if you are displaying a full screen ad on your splash screen and after level completeion, you may have the following spaces "SPLASH_AD" and @c @"LEVEL_AD"
.space | The placement of an ad in your app, where placement may be splash screen for SPLASH_AD. |
+ (void) clearKeywords | ++ | + | + |
Removes a previously set dictionary of key/value pairs.
+This method removes information from the one keywords object.
++ (void) clearUserCookies | ++ | + | + |
Removes a previously set dictionary of key/value pairs.
+This method removes information from the one UserCookie object.
++ (void) displayAdForSpace: | ++ | (NSString *) | +space | +
modallyForViewController: | ++ | (UIViewController *) | +viewController | +
+ | + | + |
Display an ad for the given interstitial space
.
This method will display an interstitial ad if one is ready for display on the device for specified UIViewController instance
+space
simply represents the placement of the ad in your app and should be unique for each placement. Only one ad will show at a time for any given ad space. For example, if you are displaying a full screen ad on your splash screen and after level completeion, you may have the following spaces "SPLASH_AD" and @c @"LEVEL_AD"
.space | The placement of an ad in your app, where placement may |
viewController | The viewController to show the fullscreen ad modally. Note this method should not be used for banners. |
+ (void) displayAdForSpace: | ++ | (NSString *) | +space | +
onView: | ++ | (UIView *) | +view | +
+ | + | + |
Display an ad for the given space
.
This method will display an ad if one is ready for display on the device.
+space
simply represents the placement of the ad in your app and should be unique for each placement. Only one ad will show at a time for any given ad space. For example, if you are displaying a full screen ad on your splash screen and after level completeion, you may have the following spaces "SPLASH_AD" and @c @"LEVEL_AD"
.space | The placement of an ad in your app, where placement may |
view | The view to place the ad. The view frame should be identical to the view frame passed in #fetchAdForSpace:frame:size. Note view is not used for interstitials. be splash screen for SPLASH_AD. |
+ (void) enableTestAds: | ++ | (BOOL) | +enable | ++ |
Informs server to send test ads.
+This method allows you to request test ads from the server. These ads do not generate revenue so it is CRITICAL this call is removed prior to app submission.
+enable | YES to receive test ads to the device. Not including this method is equivalent to passing NO. |
+ (void) fetchAdForSpace: | ++ | (NSString *) | +space | +
frame: | ++ | (CGRect) | +frame | +
size: | ++ | (FlurryAdSize) | +size | +
+ | + | + |
Retrieves an ad for the given space
.
This method will attempt to retrieve ads for the given space from the Flurry server.
+space
simply represents the placement of the ad in your app and should be unique for each placement. For example, if you are displaying a full screen ad on your splash screen and after level completeion, you may have the following spaces "SPLASH_AD" and @c @"LEVEL_AD"
.space | The placement of an ad in your app, where placement may be splash screen for SPLASH_AD. |
frame | The frame of the view that will be used for the ad container. |
size | The default size of an ad space. This can be overriden on the server. See FlurryAdSize in the FlurryAds.h file for allowable values. |
+ (void) fetchAndDisplayAdForSpace: | ++ | (NSString *) | +space | +
view: | ++ | (UIView *) | +viewContainer | +
size: | ++ | (FlurryAdSize) | +size | +
+ | + | + |
Fetch and Display an ad for the given space
.
This method will display an ad if one is available from the Flurry server for this user.
+timeout
. space
simply represents the placement of the ad in your app and should be unique for each placement. Only one ad will show at a time for any given ad space. For example, if you are displaying a full screen ad on your splash screen and after level completeion, you may have the following spaces "SPLASH_AD" and @c @"LEVEL_AD"
.space | The placement of an ad in your app, where placement may be splash screen for SPLASH_AD. |
view | The UIView in your app that the ad will be placed as a subview. Note: for fullscreen ads, this view is not used as a container, but the size of the view may still be used for determining what types of ads will fit in this space. |
size | The default size of an ad space. This can be overriden on the server. See FlurryAdSize in the FlurryAds.h file for allowable values. |
+ (void) initialize: | ++ | (UIViewController *) | +rvc | ++ |
Initializes the ad serving system.
+This method initializes the ad serving system and can be used to pre-cache ads from the server (this is done when ad spaces are configured on the server).
+rvc | The primary root view controller of your app. |
+ (BOOL) isAdAvailableForSpace: | ++ | (NSString *) | +space | +
view: | ++ | (UIView *) | +view | +
size: | ++ | (FlurryAdSize) | +size | +
+ | + | + |
[Deprecated] Check if an ad is available for the given space
.
[Deprecated] This method will verify with the Flurry server if an ad is currently available for this user. If an ad is not available, we recommend not providing the user the option to view. For example, you may have a button that reads "See other great apps!". That button should only be displayed if this method returns YES.
+space | The placement of an ad in your app, where placement may be splash screen for SPLASH_AD. |
view | The UIView in your app that the ad will be placed as a subview. Note: for fullscreen ads, this view is not used as a container, but the size of the view may still be used for determining what types of ads will fit in this space. |
size | The default size of an ad space. This can be overriden on the server. See FlurryAdSize in the FlurryAds.h file for allowable values. |
timeout | The maximum amount of time to wait for the server to return a result. Set this to 0 to check the cache and return immediately. |
+ (void) removeAdFromSpace: | ++ | (NSString *) | +space | ++ |
Removes an ad for the given space
.
This method will remove an ad if one is currently displaying.
+space
simply represents the placement of the ad in your app and should be unique for each placement. Only one ad will show at a time for any given ad space.space | The placement of an ad in your app, where placement may be splash screen for SPLASH_AD. |
+ (void) setAdDelegate: | ++ | (id) | +delegate | ++ |
Sets the object to receive various delegate methods.
+This method allows you to register an object that will receive notifications at different phases of ad serving.
+delegate | The object to receive notifications of various ad actions. |
+ (void) setKeywordsForTargeting: | ++ | (NSDictionary *) | +keywords | ++ |
Sets a dictionary of key/value pairs, which will be transmitted to Flurry servers when an ad is requested.
+Keywords allow the developer to specify information on a user executing an ad action for the purposes of targeting. There is one keywords object that is transmitted to the Flurry servers on each ad request. If corresponding keywords are matched on the ad server, a subset of targeted ads will be delivered. This allows partners to supply information they track internally, which is not available to Flurry's targeting system.
+keywords | The information about the user to be used in targeting an ad. Note: do not transmit personally identifiable information in keywords. |
+ (void) setUserCookies: | ++ | (NSDictionary *) | +userCookies | ++ |
Sets a dictionary of key/value pairs, which will be transmitted to Flurry servers when a user clicks on an ad.
+UserCookies allow the developer to specify information on a user executing an ad action. There is one UserCookie object, and on each ad click that UserCookie is transmitted to the Flurry servers. The UserCookie key/value pairs will be transmitted back to the developer via the app callback if one is set. This is useful for rewarded inventory, to identify which of your users should be rewarded when a reward callback is sent.
+userCookies | The information about the user executing ad actions. Note: do not transmit personally identifiable information in the user cookies. |
+ (BOOL) showAdForSpace: | ++ | (NSString *) | +space | +
view: | ++ | (UIView *) | +viewContainer | +
size: | ++ | (FlurryAdSize) | +size | +
+ | + | + |
[Deprecated] Display an ad for the given space
.
[Deprecated] This method will display an ad if one is available from the Flurry server for this user.
+space | The placement of an ad in your app, where placement may be splash screen for SPLASH_AD. |
view | The UIView in your app that the ad will be placed as a subview. Note: for fullscreen ads, this view is not used as a container, but the size of the view may still be used for determining what types of ads will fit in this space. |
size | The default size of an ad space. This can be overriden on the server. See FlurryAdSize in the FlurryAds.h file for allowable values. |
timeout | The maximum amount of time to wait for the server to return a valid ad. Set this to 0 to display an ad in the background (e.g. - for showing banners). |
t |
Deprecated List |
This is the complete list of members for <FlurryAdDelegate>, including all inherited members.
+Provides all available delegates for receiving callbacks related to Ad Serving. + More...
+ +#import <FlurryAdDelegate.h>
Inherits <NSObject>.
++Instance Methods | |
(void) | - spaceDidReceiveAd: |
Invoked when an ad is received for the specified adSpace . More... | |
(void) | - spaceDidFailToReceiveAd:error: |
Invoked when an ad can not be retrieved for the specified adSpace . More... | |
(BOOL) | - spaceShouldDisplay:interstitial: |
Invoked when an ad is about to display on the specified adSpace . More... | |
+(BOOL) | - spaceShouldDisplay:forType: |
[Deprecated] This method is deprecated. -[spaceShouldDisplay:interstitial:] should be used. | |
(void) | - spaceDidFailToRender:error: |
Invoked when an ad fails to render. More... | |
(void) | - spaceWillDismiss:interstitial: |
Invoked when the ad will be removed. More... | |
(void) | - spaceDidDismiss:interstitial: |
Invoked when the ad has been removed. More... | |
(void) | - spaceWillLeaveApplication: |
Invoked when the ad has been selected that will take the user out of the app. More... | |
(void) | - spaceWillExpand: |
Invoked when a space will be expanded. More... | |
(void) | - spaceWillCollapse: |
Invoked when a space will be collapsed. More... | |
(void) | - spaceDidCollapse: |
Invoked when a space has been collapsed. More... | |
(void) | - spaceDidReceiveClick: |
Informational callback invoked when an ad is clicked for the specified adSpace . More... | |
(void) | - videoDidFinish: |
Invoked when a video finishes playing. More... | |
Third party network Calls | |
Optional calls to pass information needed to display ads through 3rd parties. + | |
(NSString *) | - appSpotMillennialAppKey |
The Millennial APID. More... | |
(NSString *) | - appSpotMillennialInterstitalAppKey |
The Millennial APID for interstitials. More... | |
(NSString *) | - appSpotInMobiAppKey |
The InMobi APID. More... | |
(NSString *) | - appSpotAdMobPublisherID |
The AdMob Publisher Id. More... | |
(NSString *) | - appSpotMobclixApplicationID |
The Mobclix Application Id. More... | |
(NSString *) | - appSpotJumptapPublisherID |
The Jumptap Publisher Id. More... | |
(NSString *) | - appSpotJumptapSiteID |
The Jumptap Site Id. More... | |
(NSString *) | - appSpotJumptapBannerAdSpotID |
Jumptap Banner Ad Spot ID. More... | |
(NSString *) | - appSpotJumptapLeaderboardAdSpotID |
Jumptap Leaderboard Ad Spot ID. More... | |
(NSString *) | - appSpotJumptapMediumRectangleAdSpotID |
Jumptap Medium Rectange Ad Spot ID. More... | |
(NSString *) | - appSpotGreystripeApplicationID |
The Greystripe Application Id. More... | |
((deprecated) | - __attribute__ |
[Deprecated] Allow you to set your rootViewController. More... | |
(BOOL) | - appSpotAccelerometerEnabled |
For networks that support accelerometer-enabled ads. More... | |
Provides all available delegates for receiving callbacks related to Ad Serving.
+Set of methods that allow developers to manage and take actions within different phases of App ad display.
+- ((deprecated) __attribute__ | ++ | + | + |
[Deprecated] Allow you to set your rootViewController.
+This method has been deprecated. Please call FlurryAds::initialze: instead.
+ +- (BOOL) appSpotAccelerometerEnabled | ++ | + | + |
For networks that support accelerometer-enabled ads.
+Some networks support accelerometer-enabled ads.
+This method allows you to enable accelerometer based ads for networks that support this setting via the client sdk. Set to NO if your app uses the accelerometer to avoid conflict. Set to YES if you want the special ads. Default is NO.
+ +- (NSString *) appSpotAdMobPublisherID | ++ | + | + |
The AdMob Publisher Id.
+This is the id for your app as set in AdMob, found here: http://www.admob.com/my_sites/ (click manage settings)
+ +- (NSString *) appSpotGreystripeApplicationID | ++ | + | + |
The Greystripe Application Id.
+This is the id for your app as set in Greystripe
+ +- (NSString *) appSpotInMobiAppKey | ++ | + | + |
The InMobi APID.
+This is the id for your app as set in InMobi, found here: https://www.inmobi.com/pub/mysite.html?platFormType=all
+ +- (NSString *) appSpotJumptapBannerAdSpotID | ++ | + | + |
Jumptap Banner Ad Spot ID.
+This is the ad spot id for a Banner (320x50) ad spot set in JumpTap
+ +- (NSString *) appSpotJumptapLeaderboardAdSpotID | ++ | + | + |
Jumptap Leaderboard Ad Spot ID.
+This is the ad spot id for a Leaderboard (720x90) ad spot set in JumpTap
+ +- (NSString *) appSpotJumptapMediumRectangleAdSpotID | ++ | + | + |
Jumptap Medium Rectange Ad Spot ID.
+This is the ad spot id for a Medium Rectangle (320x50) ad spot set in JumpTap. The Medium Rectangle Ad Spot ID will be used whenever the ad frame can fit it (e.g. interstitial ads).
+ +- (NSString *) appSpotJumptapPublisherID | ++ | + | + |
The Jumptap Publisher Id.
+This is the pub id for your app as set in Jumptap
+ +- (NSString *) appSpotJumptapSiteID | ++ | + | + |
The Jumptap Site Id.
+This is the site id for your app as set in Jumptap. It is an optional parameter.
+ +- (NSString *) appSpotMillennialAppKey | ++ | + | + |
The Millennial APID.
+This is the id for your app as set in Millennial, found here: https://developer.millennialmedia.com/Application/index.php#manageApps.
+ +- (NSString *) appSpotMillennialInterstitalAppKey | ++ | + | + |
The Millennial APID for interstitials.
+This is the id for your app as set in Millennial, found here: https://developer.millennialmedia.com/Application/index.php#manageApps.
+ +- (NSString *) appSpotMobclixApplicationID | ++ | + | + |
The Mobclix Application Id.
+This is the id for your app as set in Mobclix
+ +
+
|
+ +optional | +
Invoked when a space has been collapsed.
+This method informs the app an ad space (typcially a banner) has been collapsed. Apps should resume their state when they receive this notification
+adSpace | The placement of an ad in your app, where placement may be splash screen for SPLASH_AD. |
+
|
+ +optional | +
Invoked when the ad has been removed.
+This method informs the app that an ad has closed. You can use this to resume app states.
+adSpace | The placement of an ad in your app, where placement may be splash screen for SPLASH_AD. |
interstitial | YES/NO indicates if space being removed is an interstitial |
+
|
+ +optional | +
Invoked when an ad can not be retrieved for the specified adSpace
.
This method informs the app that an ad has failed to be received for the given adSpace.
+adSpace | The placement of an ad in your app, where placement may |
error | The error, if known, that caused ads not to be received. be splash screen for SPLASH_AD. |
+
|
+ +optional | +
Invoked when an ad fails to render.
+This method informs the user an ad was retrieved, however, was unsuccessful in displaying to the user (could be lost network connectivity for example).
+adSpace | The placement of an ad in your app, where placement may |
error | The error, if known, that caused ads not to be rendered. be splash screen for SPLASH_AD. |
+
|
+ +optional | +
Invoked when an ad is received for the specified adSpace
.
This method informs the app that an ad has been received and is available for display.
+adSpace | The placement of an ad in your app, where placement may be splash screen for SPLASH_AD. |
+
|
+ +optional | +
Informational callback invoked when an ad is clicked for the specified adSpace
.
This method informs the app that an ad has been clicked. This should not be used to adjust state of an app. It is only intended for informational purposes.
+adSpace | The placement of an ad in your app, where placement may be splash screen for SPLASH_AD. |
+
|
+ +optional | +
Invoked when an ad is about to display on the specified adSpace
.
This method informs the app that an ad is about to be displayed. You can decide at this point not to show this ad by simply returning NO.
+adSpace | The placement of an ad in your app, where placement may be splash screen for SPLASH_AD. |
interstitial | YES/NO if the space to display will be an interstitial. |
+
|
+ +optional | +
Invoked when a space will be collapsed.
+This method informs the app an ad space (typcially a banner) will be collapsed.
+adSpace | The placement of an ad in your app, where placement may be splash screen for SPLASH_AD. |
+
|
+ +optional | +
Invoked when the ad will be removed.
+This method informs the app that an ad will be removed.
+adSpace | The placement of an ad in your app, where placement may be splash screen for SPLASH_AD. |
interstitial | YES/NO indicates if space being removed is an interstitial |
+
|
+ +optional | +
Invoked when a space will be expanded.
+This method informs the app an ad space (typcially a banner) will be expanded. Apps should pause their state when they receive this notification
+adSpace | The placement of an ad in your app, where placement may be splash screen for SPLASH_AD. |
+
|
+ +optional | +
Invoked when the ad has been selected that will take the user out of the app.
+This method informs the app that an ad has been clicked and the user is about to be taken outside the app.
+adSpace | The placement of an ad in your app, where placement may be splash screen for SPLASH_AD. |
+
|
+ +optional | +
Invoked when a video finishes playing.
+This method informs the app that a video associated with an ad has finished playing
+adSpace | The placement of an ad in your app, where placement may be splash screen for SPLASH_AD. |