Skip to content

JRE Ampli Wrapper

Overview

The Ampli Wrapper is a generated, strongly typed API for tracking Analytics events based on your Tracking Plan in Amplitude Data. The tracking library exposes a function for every event in your team’s tracking plan. The function’s arguments correspond to the event’s properties.

Ampli can benefit your app by providing autocompletion for events & properties defined in Data and enforce your event schemas in code to prevent bad instrumentation.

Amplitude Data supports tracking analytics events from JRE programs written in Java (6 and higher).

Ampli Wrapper versus the Amplitude SDK

We recommend using the Ampli wrapper for all the benefits mentioned above. However, if you want to send events without creating a tracking plan in Amplitude Data, you can learn more about the underlying Amplitude SDK in our SDK Quickstart Guide. Visit the Amplitude Java SDK documentation.

Deprecated Itly runtime

This page covers the JRE Java and Kotlin runtimes. All (Itly) runtimes have been deprecated. If you are still using an (Itly) runtime, see the migration guide to upgrade to the newest runtime. Docs for the Itly version are available here.

Quick Start

  1. (Prerequisite) Create a Tracking Plan in Amplitude Data

    Plan your events and properties in Amplitude Data. See detailed instructions here

  2. Install the Amplitude SDK

    implementation 'com.amplitude:java-sdk:1.10.0'
    implementation 'org.json:json:20201115'
    
  3. Install the Ampli CLI

    npm install -g @amplitude/ampli
    
  4. Pull the Ampli Wrapper into your project

    ampli pull [--path ./src/main/java/com/amplitude/ampli]
    
  5. Initialize the Ampli Wrapper

    import com.amplitude.ampli.*;
    
    Ampli.getInstance().load(
      new LoadOptions().setEnvironment(Ampli.Environment.PRODUCTION)
    );
    
  6. Identify users and set user properties

    Ampli.getInstance().identify("user-id",
       Identify.builder().userProp("A user property").build()
    );
    
  7. Track events with strongly typed methods and classes

    Ampli.getInstance().songPlayed("user_id",
      SongPlayed.builder().songId("song-1").build()
    );
    Ampli.getInstance().track("user_id",
      SongFavorited.builder().songId("song-2").build()
    );
    
  8. Flush events before application exit

    Ampli.getInstance().flush()
    
  9. Verify implementation status with CLI

    ampli status [--update]
    

Installation

Install the Amplitude SDK

If you haven't already, install the core Amplitude SDK dependencies.

  • Inside <dependencies>, add:
<dependency>
    <groupId>com.amplitude</groupId>
    <artifactId>java-sdk</artifactId>
    <version>1.6.0</version>
</dependency>
<dependency>
    <groupId>org.json</groupId>
    <artifactId>json</artifactId>
    <version>20201115</version>
</dependency>
implementation 'com.amplitude:java-sdk:1.6.0'
implementation 'org.json:json:20201115'

Install the Ampli CLI

You can install the Ampli CLI from Homebrew or NPM.

brew tap amplitude/ampli
brew install ampli
npm install -g @amplitude/ampli

Pull the Ampli Wrapper into your project

Run the Ampli CLI pull command to log in to Amplitude Data and download the strongly typed Ampli Wrapper for your tracking plan. Ampli CLI commands are usually run from the project root directory.

ampli pull

API

Load

Initialize Ampli in your code. The load() method accepts configuration option arguments:

import com.amplitude.ampli.*;

Ampli.getInstance().load(new LoadOptions()
  .setEnvironment(Ampli.Environment.PRODUCTION)
);
import com.amplitude.ampli.*

ampli.load(LoadOptions(
  environment = Ampli.Environment.PRODUCTION
));
Arg
Description
LoadOptions Required. Specifies configuration options for the Ampli Wrapper.
environment Required. String. Specifies the environment the Ampli Wrapper is running in. For example, production or development. Create, rename, and manage environments in Amplitude Data.

Environment determines which API token is used when sending events.

If a client.apiKey or client.instance is provided, environment is ignored, and can be omitted.
disabled Optional. Specifies whether the Ampli Wrapper does any work. When true, all calls to the Ampli Wrapper are no-ops. Useful in local or development environments.
client Optional. Specifies an Amplitude instance. By default Ampli creates an instance for you.
apiKey Optional. Specifies an API Key. This option overrides the default, which is the API Key configured in your tracking plan.

Identify

Call identify() to set user properties.

Just as Ampli creates types for events and their properties, it creates types for user properties.

The identify() function accepts an optional userId, optional user properties, and optional options.

For example your tracking plan contains a user property called userProp. The property's type is a string.

Ampli.getInstance().identify("user-id", Identify.builder()
  .userProp("A user property")
  .build()
);
ampli.identify("user-id", Identify(
    userProp = "A trait associated with this user"
))

The options argument allows you to pass Amplitude fields for this call, such as deviceId.

Ampli.getInstance().identify(
  userId,
  Identify.builder().userProp("A trait associated with this user"),.build(),
  new EventOptions().setDeviceId(deviceId).setUserId("some-user"),
);
ampli.identify(userId, Identify(
    userProp = "A trait associated with this user",
  )
  EventOptions(deviceId = "device-id"),
)

Group

Feature availability

This feature is available in accounts with a Growth or Enterprise plan with the Accounts add-on.

Call setGroup() to associate a user with their group (for example, their department or company). The setGroup() function accepts a required groupType, and groupName.

Ampli.getInstance().setGroup("user-id", "GroupType", "GroupName");
ampli.setGroup("user-id", "GroupType", "GroupName");

Amplitude supports assigning users to groups and performing queries, such as Count by Distinct, on those groups. If at least one member of the group has performed the specific event, then the count includes the group.

For example, you want to group your users based on what organization they're in by using an 'orgId'. Joe is in 'orgId' '10', and Sue is in 'orgId' '15'. Sue and Joe both perform a certain event. You can query their organizations in the Event Segmentation Chart.

When setting groups, define a groupType and groupName. In the previous example, 'orgId' is the groupType and '10' and '15' are the values for groupName. Another example of a groupType could be 'sport' with groupName values like 'tennis' and 'baseball'.

Setting a group also sets the groupType:groupName as a user property, and overwrites any existing groupName value set for that user's groupType, and the corresponding user property value. groupType is a string, and groupName can be either a string or an array of strings to indicate that a user is in multiple groups.

For example, if Joe is in 'orgId' '10' and '20', then the groupName is '[10, 20]').

Your code might look like this:

Ampli.getInstance().setGroup("user-id", "orgID", ["10", "20"]);
ampli.setGroup("user-id", "orgId", ["10", "20"]);

Track

To track an event, call the event's corresponding function. Every event in your tracking plan gets its own function in the Ampli Wrapper. The call is structured like this:

Ampli.getInstance().track(String userId, Event event, EventOptions options, MiddlewareExtra extra)
ampli.track(userId: String, event: Event, options: EventOptions, extra: MiddlewareExtra)

The options argument allows you to pass Amplitude fields, like price, quantity and revenue. The extra argument lets you pass data to middleware.

For example, in the following code snippet, your tracking plan contains an event called songPlayed. The event is defined with two required properties: songId and songFavorited. The property type for songId is string, and songFavorited is a boolean.

The event has an Amplitude field defined: deviceId. Learn more about Amplitude fields here. The event has one MiddlewareExtra defined: extra. Learn more about Middleware.

MiddlewareExtra extra = new MiddlewareExtra();
extra.put("extra-key", "extra-value");

Ampli.getInstance().songPlayed("user-id",
  SongPlayed.builder()
    .songId('songId') // String
    .songFavorited(true) // Boolean
    .build(),
  new EventOptions().setDeviceId(deviceId),
  extra
);
ampli.songPlayed("user-id",
  SongPlayed(
    songId = 'songId', // String,
    songFavorited = true, // Boolean
  ),
  options = EventOptions(deviceId = "device-id"),
  extra = MiddlewareExtra(mapOf("extra-key" to "extra-value")
);

Ampli also generates a class for each event.

SongPlayed event = SongPlayed.builder()
  .songId('songId') // String
  .songFavorited(true) // Boolean
  .build()
val myEventObject = SongPlayed(
  songId = 'songId', // String,
  songFavorited = true, // Boolean
);

Send Event objects using the generic track method.

Ampli.getInstance().track("user-id", SongPlayed.builder()
  .songId('songId') // String
  .songFavorited(true) // Boolean
  .build()
);
ampli.track("user-id", SongPlayed(
  songId = 'songId', // String,
  songFavorited = true, // Boolean
);

Flush

The Ampli wrapper queues events and sends them on an interval based on the configuration.

Call flush() to immediately send any pending events.

The flush() method returns a promise that can be used to ensure all pending events have been sent before continuing. This can be useful to call prior to application exit.

ampli.flush()
ampli.flush()

Ampli CLI

Pull

The pull command downloads the Ampli Wrapper code to your project. Run the pull command from the project root.

ampli pull

You will be prompted to log in to your workspace and select a source.

 ampli pull
Ampli project is not initialized. No existing `ampli.json` configuration found.
? Create a new Ampli project here? Yes
? Organization: Amplitude
? Workspace: My Workspace
? Source: My Source

Learn more about ampli pull.

Status

Verify that events are implemented in your code with the status command:

ampli status [--update]

The output displays status and indicates what events are missing.

➜ ampli status
✘ Verifying event tracking implementation in source code
 ✔ Song Played (1 location)
 ✘ Song Stopped Called when a user stops playing a song.
Events Tracked: 1 missed, 2 total

Learn more about ampli status.

Migrate from an Itly JRE Runtime

Migrate from an Itly JRE runtime to Ampli by following these steps.

  1. Remove legacy Itly dependencies from your project. This includes anything with a ly.iterative.itly.

    implementation "ly.iterative.itly:sdk-jvm:$itlySdkVersion"
    implementation "ly.iterative.itly:plugin-iteratively:$itlySdkVersion"
    implementation "ly.iterative.itly:plugin-schema-validator:$itlySdkVersion"
    implementation "ly.iterative.itly:plugin-segment-jvm:$itlySdkVersion"
    
  2. Add Amplitude dependencies.

    implementation 'com.amplitude:java-sdk:1.6.0'
    implementation 'org.json:json:20201115'
    
  3. Pull the latest Ampli Wrapper.

    ampli pull
    
  4. Check your Ampli Wrapper path.

    ampli pull prints the download location of the SDK. If the path contains itly, you can update the Path by hand in the ampli.json file, or pull again using the --path parameter: ampli pull -p ./path/to/ampli.

  5. Find and replace:

    Kotlin and Java:

    • import ly.iterative.itly.* => import com.amplitude.ampli.*
    • itly. => ampli.
    • itly.group(groupId) => ampli.setGroup(groupType, groupValue)

    Kotlin only:

    • Itly.load() => ampli.load()
    • Itly. => ampli.

    Java only:

    • Itly.getInstance().load() => Ampli.getInstance().load()
    • Itly. => Ampli.
  6. See updated Event tracking details on your Implementation page in the web app.


Still have questions? Ask them in the Community.