The AEMReporter module enables Aggregated Event Measurement (AEM) for iOS apps, allowing measurement of app events from iOS 14.5+ users who have opted out of app tracking.
AEM is iOS only and automatically bypassed on Android. This feature is designed to work with Apple’s App Tracking Transparency (ATT) framework.
Import
import { AEMReporter } from 'react-native-fbsdk-next';
What is AEM?
Aggregated Event Measurement allows you to measure app install and app event conversion data from iOS users who have opted out of tracking in iOS 14.5 and later. AEM provides privacy-safe measurement by:
- Aggregating conversion data before sending it to Facebook
- Operating without user-level identifiers
- Supporting up to 8 conversion values per campaign
Learn more in the Facebook AEM documentation.
Methods
logAEMEvent
Logs an event for Aggregated Event Measurement. This method automatically handles platform detection and only executes on iOS.
AEMReporter.logAEMEvent(
eventName: string,
value: number,
currency?: string,
otherParameters?: Record<string, string | number>
): void
The name of the event to log. Must match event names used in standard app event logging for proper attribution.
The value associated with the event (e.g., purchase amount, item count).
The ISO 4217 currency code (e.g., “USD”, “EUR”, “GBP”). Required for purchase events.
otherParameters
Record<string, string | number>
Additional event parameters as key-value pairs.
Usage Examples
Basic Event
import { AEMReporter } from 'react-native-fbsdk-next';
// Log a simple event (iOS only, no-op on Android)
AEMReporter.logAEMEvent('ViewedContent', 1);
Purchase Event
// Log a purchase with currency
AEMReporter.logAEMEvent('Purchase', 29.99, 'USD');
Event with Additional Parameters
// Log an event with extra data
AEMReporter.logAEMEvent(
'AddToCart',
49.99,
'USD',
{
content_type: 'product',
content_id: 'SKU-12345',
num_items: 2,
}
);
Combined with Standard Event Logging
import { AppEventsLogger, AEMReporter } from 'react-native-fbsdk-next';
const logPurchase = (amount: number, currency: string) => {
// Standard event logging
AppEventsLogger.logPurchase(amount, currency);
// AEM event logging (iOS only)
AEMReporter.logAEMEvent('Purchase', amount, currency);
};
logPurchase(99.99, 'USD');
// This is safe to call on any platform
// It will only execute on iOS
AEMReporter.logAEMEvent('Purchase', 29.99, 'USD');
// Internally, the SDK checks:
// if (Platform.OS !== 'ios') {
// return; // No-op on Android
// }
import { Platform } from 'react-native';
if (Platform.OS === 'ios') {
AEMReporter.logAEMEvent('Purchase', 29.99, 'USD');
}
Deep Link Handling
For AEM to work correctly, you must handle deep link URLs with AEM data.
import { Linking } from 'react-native';
import { AEMReporter } from 'react-native-fbsdk-next';
// Handle initial URL when app launches
Linking.getInitialURL().then((url) => {
if (url) {
// Process the URL - the SDK will extract AEM data automatically
console.log('Initial URL:', url);
}
});
// Handle URLs when app is already running
Linking.addEventListener('url', (event) => {
console.log('Received URL:', event.url);
// Process the URL - the SDK will extract AEM data automatically
});
Event Name Consistency
AEM event names must exactly match the event names used in your standard app event logging for proper attribution and measurement.
const EVENT_NAME = 'Purchase';
// Standard logging
AppEventsLogger.logEvent(EVENT_NAME, 99.99);
// AEM logging (same name)
AEMReporter.logAEMEvent(EVENT_NAME, 99.99, 'USD');
// Standard logging
AppEventsLogger.logEvent('Purchase', 99.99);
// AEM logging (different name - won't match!)
AEMReporter.logAEMEvent('fb_mobile_purchase', 99.99, 'USD');
Configuration Requirements
To use AEM effectively:
- Configure your ad campaigns in Facebook Events Manager with the events you want to measure
- Set up conversion values for up to 8 events per campaign
- Handle deep links in your app to capture attribution data
- Log events consistently using both standard and AEM logging
Best Practices
- Always log both standard and AEM events to ensure complete measurement across all user types
- Use consistent event names between standard and AEM logging
- Include currency for all purchase-related events
- Test deep link handling before releasing to production
- Monitor your Events Manager to verify AEM data is being received
TypeScript Types
// Method signature
logAEMEvent: (
eventName: string,
value: number,
currency?: string,
otherParameters?: Record<string, string | number>
) => void;
Additional Resources
