React Native SDK (Maintenance)

This is the official documentation for the Amplitude Analytics React Native SDK.

Compatibility Matrix¶

The following matrix lists the support for Amplitude React Native SDK version for different versions of React Native and React Native CLI.

Learn more about the Android Gradle Plugin compatibility.

SDK installation¶

Add dependencies¶

Run yarn add @amplitude/react-native in your project directory, the same level with package.json.

yarn add @amplitude/react-native

iOS installation¶

cd ios && pod install

Usage and examples¶

Initialize the SDK¶

Before you can instrument, you must initialize the SDK using the API key for your Amplitude project.

import * as React from 'react';
import { Button } from 'react-native';
import { Amplitude, Identify } from '@amplitude/react-native';

const ampInstance = Amplitude.getInstance();
ampInstance.init(AMPLITUDE_API_KEY);

export function MyApp() {
  return (
    <Button
      title="Log Event"
      onPress={() => ampInstance.logEvent('BUTTON_CLICKED')}
    />
  );
}

Configuration¶

Amplitude React Native SDK runs on the top of the Amplitude Android Maintenance SDK, Amplitude iOS Maintenance SDK. The following are the ts/js settable config options. For other default configurations:

• on Android side, check the Android Configuration
• on iOS side, check the iOS configuration

Configure batching behavior¶

To support high-performance environments, the SDK sends events in batches. Every event logged by the logEvent method is queued in memory. Events are flushed in batches in background. You can customize batch behavior with setEventUploadThreshold and setEventUploadPeriodMillis. By default, the serverUrl will be https://api2.amplitude.com/. This SDK doesn't support batch mode, the batch API endpoint.

// Events queued in memory will flush when number of events exceed upload threshold
// Default value is 30
Amplitude.getInstance().setEventUploadThreshold(100);
// Events queue will flush every certain milliseconds based on setting
// Default value is 30 second.
Amplitude.getInstance().setEventUploadPeriodMillis(100000);

EU data residency¶

Beginning with version 2.6.0, you can configure the server zone after initializing the client for sending data to Amplitude's EU servers. The SDK sends data based on the server zone if it's set. The server zone configuration supports dynamic configuration as well.

For earlier versions, you need to configure the serverURL property after initializing the client.

// For versions starting from 2.6.0
// No need to call setServerUrl for sending data to Amplitude's EU servers
Amplitude.getInstance().setServerZone('EU');

// For earlier versions
Amplitude.getInstance().setServerUrl("https://api.eu.amplitude.com"));

Send events¶

Basic events¶

Events represent how users interact with your application. For example, "button clicked" may be an action you want to track.

Amplitude.getInstance().logEvent('BUTTON_CLICKED');

Events with properties¶

Events can also contain properties that give context about the event. For example, "hover time" may be a relevant event property to "button click"

Amplitude.getInstance().logEvent("BUTTON_CLICKED", {"Hover Time": "100ms"});

Flush events¶

Events are typically stored in a buffer and flushed periodically. This behavior is configurable. You can also flush events manually

Amplitude.getInstance().uploadEvents();

User properties¶

User properties help you understand your users at the time they performed some action within your app such as their device details, their preferences, or language. Amplitude-ReactNative's Identify class manages these features. You need to import the Identify before using it.

import { Identify } from '@amplitude/react-native';

Set a user property¶

set¶

set sets the value of a user property. You can also chain together multiple identify calls.

const identify = new Identify();
identify.set("gender", "female").set("age", 20);
Amplitude.getInstance().identify(identify);

setOnce¶

setOnce sets the value of a user property once. Later calls using setOnce are ignored.

const identify1 = new Identify();
identify1.setOnce("sign_up_date", "2015-08-24");
Amplitude.getInstance().identify(identify1);
const identify2 = new Identify();
identify2.setOnce("sign_up_date", "2015-08-24");
Amplitude.getInstance().identify(identify2);// is ignored

add¶

add increments a user property by some numerical value. If the user property doesn't have a value set yet, it will be initialized to 0 before being incremented.

const identify = new Identify();
identify.add("karma", 0.123);
Amplitude.getInstance().identify(identify);

Set multiple user properties¶

You can use setUserProperties as a shorthand to set multiple user properties at once. This method is simply a wrapper around Identify.set and identify.

const userProperties = {
    "KEY": "VALUE",
    "OTHER_KEY": "OTHER_VALUE",
}
Amplitude.getInstance().setUserProperties(userProperties);

Arrays in user properties¶

Arrays can be used as user properties. You can directly set arrays or use append to generate an array.

const colors = ["rose", "gold"];
const numbers = [4, 5];
const identify = new Identify();
identify.set("colors", colors)
        .append("ab-tests", "campaign_a")
        .append("existing_list", numbers);
Amplitude.getInstance().identify(identify);

append¶

append appends a value or values to a user property array. If the user property doesn't have a value set yet, it will be initialized to an empty list before the new values are added. If the user property has an existing value and it's not a list, it will be converted into a list with the new value added.

const array = ["some_string", 56];
const identify = new Identify();
identify.append("ab-tests", "new-user-test")
Amplitude.getInstance().identify(identify);

preInsert¶

preInsert insert a value or values to a user property if it doesn't exist in the user property yet. Pre-insert means inserting the value at the beginning of a given list. If the user property doesn't have a value set yet, it will be initialized to an empty list before the new values are pre-inserted. If the user property has an existing value, it will be no operation.

const array = ["some_string", 56];
const identify = new Identify();
identify.preInsert("ab-tests", "new-user-test")
Amplitude.getInstance().identify(identify);

postInsert¶

postInsert insert a value or values to a user property if it doesn't exist in the user property yet. Post-insert means inserting the value at the end of a given list. If the user property doesn't have a value set yet, it will be initialized to an empty list before the new values are post-inserted. If the user property has an existing value, it will be no operation.

const array = ["some_string", 56];
const identify = new Identify();
identify.postInsert("ab-tests", "new-user-test")
Amplitude.getInstance().identify(identify);

Remove user properties¶

Clear all user properties¶

clearUserProperties wipes all the current user's user properties.

Amplitude.getInstance().clearUserProperties();

remove¶

remove removes a value or values to a user property if it does exist in the user property. If the item doesn't exist in the user property, nothing happens.

const array = ["some_string", 56];
const identify = new Identify();
identify.remove("ab-tests", "new-user-test")
        .remove("some_list",array);
Amplitude.getInstance().identify(identify);

unset¶

unset unsets and removes a user property.

const identify = new Identify();
identify.unset("karma").unset("gender");
Amplitude.getInstance().identify(identify);

Track revenue¶

Amplitude can track revenue generated by a user. Revenue is tracked through distinct revenue objects, which have special fields that are used in Amplitude's Event Segmentation and Revenue LTV charts. This allows Amplitude to automatically display data relevant to revenue in the platform. Revenue objects support the following special properties, as well as user-defined properties through the eventProperties field.

Price can be a negative value, which is useful for tracking lost revenue.

type RevenueProperties = {
  price: number;
  productId?: string;
  quantity?: number;
  revenueType?: string;
  receipt?: string;
  receiptSignature?: string;
  eventProperties?: PropertiesObject;
};

const userProperties = {
    price: 100;
    productId: "123";
    quantity: 2;
    revenueType: "productRevenue";
    receipt: "11111";
    receiptSignature: "signature";
    eventProperties: {
        "KAY": "VALUE",
      "OTHER_KEY": "OTHER_VALUE"
    };
}
Amplitude.getInstance().logRevenue(userProperties);

Group user properties¶

Use the Group Identify API to set or update the properties of particular groups. Keep these considerations in mind:

• Updates affect only future events, and don't update historical events.
• You can track up to 5 unique group types and 10 total groups.

The groupIdentify method accepts a group type string parameter and group name object parameter, and an Identify object that's applied to the group.

const identify = new Identify();
identify.set("gender", "female").set("age", 20);
Amplitude.getInstance().groupIdentify("groupType", "groupValue", identify);

User sessions¶

A session is a period of time that a user has the app in the foreground. Events that are logged within the same session have the same session_id. Sessions are handled automatically so you don't have to manually call an API like startSession() or endSession(). Amplitude groups events together by session. A session represents a single period of user activity, with a start and end time. Different SDKs track sessions differently, depending on the requirements of the platform. You are able to determine whether to automatically log start and end session events corresponding to the start and end of a user's session.

//Enable automatically log start and end session events
Amplitude.getInstance().trackingSessionEvents(true);
//Disable automatically log start and end session events
Amplitude.getInstance().trackingSessionEvents(false);

Set custom user ID¶

If your app has its login system that you want to track users with, you can call setUserId at any time.

Amplitude.getInstance().setUserId("test_user_id");

Advanced topics¶

COPPA Control¶

COPPA (Children's Online Privacy Protection Act) restrictions on IDFA, IDFV, city, IP address and location tracking can be enabled or disabled all at once. Remember that apps asking for information from children under 13 years of age must comply with COPPA.

// Enable COPPA Control
Amplitude.instance().enableCoppaControl();
// Disable COPPA Control
Amplitude.instance().disableCoppaControl();

Opt out of tracking¶

Users may wish to opt out of tracking entirely, which means no events and no records of their browsing history. setOptOut provides a way to fulfill certain users' requests for privacy.

//Disables instrumentation
Amplitude.getInstance().setOptOut(true);
//Enables instrumentation
Amplitude.getInstance().setOptOut(false);

Dynamic configuration¶

React Native SDK allows users to configure their apps to use dynamic configuration. This feature finds the best server URL automatically based on app users' location.

• If you have your own proxy server and use setServerUrl API, don't use dynamic configuration.
• If you have users in Mainland China, Amplitude recommends that you use dynamic configuration.
• By default, this feature is off. You must explicitly enable it to use it.
• By default, this feature returns the server URL of Amplitude's US servers. If you need to send data to Amplitude's EU servers, use setServerZone to set it to EU zone.

Amplitude.getInstance().setUseDynamicConfig(true);

Migration guide¶

The JavaScript SDK no longer has support for React Native. If you already have installed the amplitude-js or the old version of @amplitude/react-native, follow the Migration Guide to implement @amplitude/react-native v2.

Troubleshooting¶

Using an older React Native version and having trouble with iOS?

Amplitude supports versions of React Native >= 0.61. Here's the process to set up with React Native 0.71. See the compatibility matrix for more details.

1. Swift Setup (Xcode)
   • Open your [project-name].xcodeproj file in Xcode
   • Right click your project name in the file navigator and then click New File, pick swift, it prompts you to create a bridging headers file. This is necessary to support swift in RN 0.61.
   • Source of this fix: https://stackoverflow.com/a/54586937
2. Podfile changes
   • Make sure you are targeting iOS 10 or greater
   • Add use_modular_headers! globally to the top of the Podfile
   • Disable modular headers for DoubleConversion, Glog and Folly using :use_modular_headers => false.

More resources¶

If you have any problems with the SDK, create a GitHub issue or submit a request on Amplitude Help.