AMAAppMetrica class

Methods of the class are used for configuring the library.

Instance methodsInstance methods

PropertiesProperties

Method descriptionsMethod descriptions

+activateReporterWithConfiguration:+activateReporterWithConfiguration:

+ (void)activateReporterWithConfiguration:(AMAReporterConfiguration *)configuration;

Initializes a reporter with the extended configuration.

The configuration of the reporter should be initialized before the first call to the reporter. Otherwise, the configuration of the reporter is ignored.

The reporter should be activated with the configuration using a different API key instead of the app's API key.

Parameters:

+activateWithConfiguration:+activateWithConfiguration:

+ (void)activateWithConfiguration:(AMAAppMetricaConfiguration *)configuration;

Initializes the library in an app with the extended startup configuration.

Parameters:

+clearAppEnvironment+clearAppEnvironment

+ (void)clearAppEnvironment;

Cleaning the app environment, such as deleting all key-value data associated with all future events.

+pauseSession+pauseSession

+ (void)pauseSession;

Pauses the session.

+reportAdRevenue:onFailure:+reportAdRevenue:onFailure:

+ (void)reportAdRevenue:(AMAAdRevenueInfo *)adRevenue
              onFailure:(nullable void (^)(NSError *error))onFailure;

Sends information about advertising revenue to the AppMetrica server.

Parameters:

+reportECommerce:onFailure:+reportECommerce:onFailure:

+ (void)reportECommerce:(AMAECommerce *)eCommerce
              onFailure:(nullable void (^)(NSError *error))onFailure;

Sends a message about an E-commerce event.

Parameters:

+reportEvent:onFailure:+reportEvent:onFailure:

+ (void)reportEvent:(NSString *)name
          onFailure:(nullable void (^)(NSError *error))onFailure;

Sends an event message.

Parameters:

+reportEvent:parameters:onFailure:+reportEvent:parameters:onFailure:

+ (void)reportEvent:(NSString *)name
         parameters:(nullable NSDictionary *)params
          onFailure:(nullable void (^)(NSError *error))onFailure;

Sends an event message with additional parameters.

Parameters:

+reportExternalAttribution:source:onFailure:+reportExternalAttribution:source:onFailure:

+ (void)reportExternalAttribution:(NSDictionary *)attribution
                           source:(AMAAttributionSource)source
                        onFailure:(nullable void (^)(NSError *error))onFailure;

Sends external attribution data to AppMetrica.

Parameters:

+reportRevenue:onFailure:+reportRevenue:onFailure:

+ (void)reportRevenue:(AMARevenueInfo *)revenueInfo
            onFailure:(nullable void (^)(NSError *error))onFailure;

Sends information about the purchase to the AppMetrica server.

Parameters:

+reportUserProfile:onFailure:+reportUserProfile:onFailure:

+ (void)reportUserProfile:(AMAUserProfile *)userProfile
                onFailure:(nullable void (^)(NSError *error))onFailure;

Sends information about a user profile update.

Parameters:

+reporterForAPIKey:+reporterForAPIKey:

+ (nullable id<AMAAppMetricaReporting>)reporterForAPIKey:(NSString *)APIKey;

Creates a reporter for sending events to an additional API key.

To initialize a reporter with the extended configuration, use the activateReporterWithConfiguration: method. The configuration of the reporter should be initialized before the first call to the reporter. Otherwise, the configuration of the reporter is ignored.

Parameters:

Returns:

The instance that implements the AMAAppMetricaReporting protocol for the specified API key.

+requestStartupIdentifiersWithCompletionQueue:completionBlock:+requestStartupIdentifiersWithCompletionQueue:completionBlock:

+ (void)requestStartupIdentifiersWithCompletionQueue:(nullable dispatch_queue_t)queue
                                     completionBlock:(AMAIdentifiersCompletionBlock)block;

Getting all predefined IDs

Parameters:

+requestStartupIdentifiersWithKeys:completionQueue:completionBlock:+requestStartupIdentifiersWithKeys:completionQueue:completionBlock:

+ (void)requestStartupIdentifiersWithKeys:(NSArray<AMAStartupKey> *)keys
                          completionQueue:(nullable dispatch_queue_t)queue
                          completionBlock:(AMAIdentifiersCompletionBlock)block;

Getting IDs for specific keys

Parameters:

+resumeSession+resumeSession

+ (void)resumeSession;

Resumes the session, or creates a new one if the session timeout has expired.

+sendEventsBuffer+sendEventsBuffer

+ (void)sendEventsBuffer;

Sends stored events from the buffer.

AppMetrica SDK does not send an event immediately after it occurred. The library stores event data in the buffer. The +sendEventsBuffer method sends data from the buffer and flushes it. Use the method to force sending stored events after passing important checkpoints of user scenarios.

+setAppEnvironmentValue:forKey:+setAppEnvironmentValue:forKey:

+ (void)setAppEnvironmentValue:(nullable NSString *)value
                        forKey:(NSString *)key;

Setting key-value data to be used as additional information associated with all future events.

If the value is zero, the previously set key value is deleted. Nothing is done if the key wasn't added.

Parameters:

+setDataSendingEnabled:+setDataSendingEnabled:

+ (void)setDataSendingEnabled:(BOOL)enabled;

Enables/disables sending statistics to the AppMetrica server.

For more information about using the method, see Disabling and enabling sending statistics.

Parameters:

+setupWebViewReporting:onFailure:+setupWebViewReporting:onFailure:

+ (void)setupWebViewReporting:(id<AMAJSControlling>)controller
                    onFailure:(nullable void (^)(NSError *error))onFailure;

Adds a JavaScript interface with the AppMetrica name in a window to the specified webview. This lets you send client events from JavaScript code.

Notes:

• The method must be called from the main queue.
• The method is not available on tvOS.
• Call this method before loading any content. We recommend calling this method before creating a webview and before adding your scripts to WKUserContentController. For more information, see Usage examples.

Parameters:

+trackOpeningURL:+trackOpeningURL:

+ (void)trackOpeningURL:(NSURL *)URL;

Processes the URL that opened the app.

Used for tracking app openings via deeplink

Parameters:

Property descriptionsProperty descriptions

uuiduuid

@property (class, nonatomic, readonly) NSString *UUID;

Retrieves the current UUID.

accurateLocationTrackingEnabledaccurateLocationTrackingEnabled

@property (class, nonatomic, getter=isAccurateLocationTrackingEnabled) BOOL accurateLocationTrackingEnabled;

Controls the accuracy of location tracking used by the internal location manager.

If set to YES, the location manager attempts to use the most accurate location data available. This property takes effect only if the isLocationTrackingEnabled parameter is set to YES, and the location wasn't set manually using the customLocation property.

activatedactivated

@property (class, assign, readonly, getter=isActivated) BOOL activated;

Indicates whether AppMetrica was activated.

allowsBackgroundLocationUpdatesallowsBackgroundLocationUpdates

@property (class, nonatomic) BOOL allowsBackgroundLocationUpdates;

Enable/disable background tracking of location updates. Disabled by default.

customLocationcustomLocation

@property (class, nonatomic, nullable) CLLocation *customLocation;

Sets custom location of the device.

deviceIDHashdeviceIDHash

@property (class, nonatomic, nullable, readonly) NSString *deviceIDHash;

Retrieves the appmetrica_device_id_hash.

deviceIDdeviceID

@property (class, nonatomic, nullable, readonly) NSString *deviceID;

Retrieves the appmetrica_device_id.

libraryVersionlibraryVersion

@property (class, nonatomic, readonly) NSString *libraryVersion;

Returns the current version of the AppMetrica library.

locationTrackingEnabledlocationTrackingEnabled

@property (class, nonatomic, getter=isLocationTrackingEnabled) BOOL locationTrackingEnabled;

Enables/disables sending location of the device .

userProfileIDuserProfileID

@property (class, nonatomic, nullable) NSString *userProfileID;

Sets the ID of the user profile. AppMetrica doesn't display predefined attributes in the web interface if ProfieId sending isn't configured.