Event (main 1.12.0 API)

java.lang.Object
- com.amplitude.Event

public class Event
extends java.lang.Object

Field Summary

Fields
Modifier and Type	Field and Description
`java.lang.String`	`adid` (Android) Google Play Services advertising ID
`java.lang.String`	`androidId` (Android) Android ID (not the advertising ID)
`java.lang.String`	`appVersion` The current version of your application.
`protected AmplitudeCallbacks`	`callback` Callback for Event
`java.lang.String`	`carrier` The carrier that the user is using.
`java.lang.String`	`city` The current city of the user.
`java.lang.String`	`country` The current country of the user.
`java.lang.String`	`deviceBrand` The device brand that the user is using.
`java.lang.String`	`deviceId` A device-specific identifier, such as the Identifier for Vendor on iOS.
`java.lang.String`	`deviceManufacturer` The device manufacturer that the user is using.
`java.lang.String`	`deviceModel` The device model that the user is using.
`java.lang.String`	`dma` The current Designated Market Area of the user.
`int`	`eventId` An incrementing counter to distinguish events with the same user_id and timestamp from each other.
`org.json.JSONObject`	`eventProperties` A dictionary of key-value pairs that represent additional data to be sent along with the event.
`java.lang.String`	`eventType` A unique identifier for your event.
`org.json.JSONObject`	`groupProperties` This feature is only available to Enterprise customers who have purchased the Accounts add-on.
`org.json.JSONObject`	`groups` This feature is only available to Enterprise customers who have purchased the Accounts add-on.
`java.lang.String`	`idfa` (iOS) Identifier for Advertiser.
`java.lang.String`	`idfv` (iOS) Identifier for Vendor.
`IngestionMetadata`	`ingestionMetadata` The ingestion metadata.
`java.lang.String`	`insertId` A unique identifier for the event.
`java.lang.String`	`ip` The IP address of the user.
`java.lang.String`	`language` The (human) language set by the user.
`double`	`locationLat` The current Latitude of the user.
`double`	`locationLng` The current Longitude of the user.
`java.lang.String`	`osName` The name of the mobile operating system or browser that the user is using.
`java.lang.String`	`osVersion` The version of the mobile operating system or browser the user is using.
`java.lang.String`	`partnerId` The partner id of event
`Plan`	`plan` The tracking plan.
`java.lang.String`	`platform` Platform of the device.
`java.lang.Double`	`price` The price of the item purchased.
`java.lang.String`	`productId` An identifier for the item purchased.
`int`	`quantity` The quantity of the item purchased.
`java.lang.String`	`region` The current region of the user.
`java.lang.Double`	`revenue` revenue = price * quantity.
`java.lang.String`	`revenueType` The type of revenue for the item purchased.
`long`	`sessionId` The start time of the session in milliseconds since epoch (Unix Timestamp), necessary if you want to associate events with a particular system.
`long`	`timestamp` The timestamp of the event in milliseconds since epoch.
`java.lang.String`	`userId` A readable ID specified by you.
`org.json.JSONObject`	`userProperties` A dictionary of key-value pairs that represent additional data tied to the user.
`java.lang.String`	`versionName` Legacy SDK API, only for use with older API.

Constructor Summary

Constructors
Constructor and Description
`Event(java.lang.String eventType, java.lang.String userId)` Create a new event with the required items.
`Event(java.lang.String eventType, java.lang.String userId, java.lang.String deviceId)` Create a new event with the required items.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected java.lang.Object`	`replaceWithJSONNull(java.lang.Object obj)` internal method
`org.json.JSONObject`	`toJsonObject()`
`java.lang.String`	`toString()`
`protected org.json.JSONArray`	`truncate(org.json.JSONArray array)`
`protected org.json.JSONObject`	`truncate(org.json.JSONObject object)`
`protected java.lang.String`	`truncate(java.lang.String value)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - eventType
```
public java.lang.String eventType
```
    A unique identifier for your event.
  - userId
```
public java.lang.String userId
```
    A readable ID specified by you. Must have a minimum length of 5 characters. Required unless device_id is present.
  - deviceId
```
public java.lang.String deviceId
```
    A device-specific identifier, such as the Identifier for Vendor on iOS. Required unless user_id is present. If a device_id is not sent with the event, it will be set to a hashed version of the user_id.
  - timestamp
```
public long timestamp
```
    The timestamp of the event in milliseconds since epoch. If time is not sent with the event, it will be set to the request upload time.
  - locationLat
```
public double locationLat
```
    The current Latitude of the user.
  - locationLng
```
public double locationLng
```
    The current Longitude of the user.
  - appVersion
```
public java.lang.String appVersion
```
    The current version of your application.
  - versionName
```
public java.lang.String versionName
```
    Legacy SDK API, only for use with older API. The application's version name.
  - platform
```
public java.lang.String platform
```
    Platform of the device.
  - osName
```
public java.lang.String osName
```
    The name of the mobile operating system or browser that the user is using.
  - osVersion
```
public java.lang.String osVersion
```
    The version of the mobile operating system or browser the user is using.
  - deviceBrand
```
public java.lang.String deviceBrand
```
    The device brand that the user is using.
  - deviceManufacturer
```
public java.lang.String deviceManufacturer
```
    The device manufacturer that the user is using.
  - deviceModel
```
public java.lang.String deviceModel
```
    The device model that the user is using.
  - carrier
```
public java.lang.String carrier
```
    The carrier that the user is using.
  - country
```
public java.lang.String country
```
    The current country of the user.
  - region
```
public java.lang.String region
```
    The current region of the user.
  - city
```
public java.lang.String city
```
    The current city of the user.
  - dma
```
public java.lang.String dma
```
    The current Designated Market Area of the user.
  - idfa
```
public java.lang.String idfa
```
    (iOS) Identifier for Advertiser.
  - idfv
```
public java.lang.String idfv
```
    (iOS) Identifier for Vendor.
  - adid
```
public java.lang.String adid
```
    (Android) Google Play Services advertising ID
  - androidId
```
public java.lang.String androidId
```
    (Android) Android ID (not the advertising ID)
  - language
```
public java.lang.String language
```
    The (human) language set by the user.
  - partnerId
```
public java.lang.String partnerId
```
    The partner id of event
  - ip
```
public java.lang.String ip
```
    The IP address of the user. Use "$remote" to use the IP address on the upload request. We will use the IP address to reverse lookup a user's location (city, country, region, and DMA). Amplitude has the ability to drop the location and IP address from events once it reaches our servers. You can submit a request to our platform specialist team here to configure this for you.
  - eventProperties
```
public org.json.JSONObject eventProperties
```
    A dictionary of key-value pairs that represent additional data to be sent along with the event. You can store property values in an array. Date values are transformed into string values. Object depth may not exceed 40 layers.
  - userProperties
```
public org.json.JSONObject userProperties
```
    A dictionary of key-value pairs that represent additional data tied to the user. You can store property values in an array. Date values are transformed into string values. Object depth may not exceed 40 layers.
  - price
```
public java.lang.Double price
```
    The price of the item purchased. Required for revenue data if the revenue field is not sent. You can use negative values to indicate refunds.
  - quantity
```
public int quantity
```
    The quantity of the item purchased. Defaults to 1 if not specified.
  - revenue
```
public java.lang.Double revenue
```
    revenue = price * quantity. If you send all 3 fields of price, quantity, and revenue, then (price * quantity) will be used as the revenue value. You can use negative values to indicate refunds.
  - productId
```
public java.lang.String productId
```
    An identifier for the item purchased. You must send a price and quantity or revenue with this field.
  - revenueType
```
public java.lang.String revenueType
```
    The type of revenue for the item purchased. You must send a price and quantity or revenue with this field.
  - eventId
```
public int eventId
```
    An incrementing counter to distinguish events with the same user_id and timestamp from each other. We recommend you send an event_id, increasing over time, especially if you expect events to occur simultanenously.
  - sessionId
```
public long sessionId
```
    The start time of the session in milliseconds since epoch (Unix Timestamp), necessary if you want to associate events with a particular system. A session_id of -1 is the same as no session_id specified.
  - insertId
```
public java.lang.String insertId
```
    A unique identifier for the event. We will deduplicate subsequent events sent with an insert_id we have already seen before within the past 7 days. We recommend generation a UUID or using some combination of device_id, user_id, event_type, event_id, and time.
  - groups
```
public org.json.JSONObject groups
```
    This feature is only available to Enterprise customers who have purchased the Accounts add-on. This field adds a dictionary of key-value pairs that represent groups of users to the event as an event-level group. You can only track up to 5 groups.
  - groupProperties
```
public org.json.JSONObject groupProperties
```
    This feature is only available to Enterprise customers who have purchased the Accounts add-on. A dictionary of key-value pairs that represent data tied to the groups.
  - plan
```
public Plan plan
```
    The tracking plan.
  - ingestionMetadata
```
public IngestionMetadata ingestionMetadata
```
    The ingestion metadata.
  - callback
```
protected AmplitudeCallbacks callback
```
    Callback for Event
- Constructor Detail
  - Event
```
public Event(java.lang.String eventType,
             java.lang.String userId)
```
    Create a new event with the required items. `eventType` is required, and at least one of `userId` or `deviceId` is required. This method sets deviceId to null.
    
    Parameters:
    
    eventType - A unique identifier for your event
    
    userId - A readable ID specified by you. Must have a minimum length of 5 characters. Required unless device_id is present.
  - Event
```
public Event(java.lang.String eventType,
             java.lang.String userId,
             java.lang.String deviceId)
```
    Create a new event with the required items. `eventType` is required, and at least one of `userId` or `deviceId` is required.
    
    Parameters:
    
    eventType - A unique identifier for your event
    
    userId - A readable ID specified by you. Must have a minimum length of 5 characters. Required unless device_id is present.
    
    deviceId - A device-specific identifier, such as the Identifier for Vendor on iOS. Required unless user_id is present. If a device_id is not sent with the event, it will be set to a hashed version of the user_id.
- Method Detail
  - toJsonObject
```
public org.json.JSONObject toJsonObject()
```
    Returns:
    
    the JSONObject that represents the event data of this event
  - replaceWithJSONNull
```
protected java.lang.Object replaceWithJSONNull(java.lang.Object obj)
```
    internal method
  - truncate
```
protected org.json.JSONObject truncate(org.json.JSONObject object)
```
  - truncate
```
protected org.json.JSONArray truncate(org.json.JSONArray array)
                               throws org.json.JSONException
```
    Throws:
    
    org.json.JSONException
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - truncate
```
protected java.lang.String truncate(java.lang.String value)
```

Class Event

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

eventType

userId

deviceId

timestamp

locationLat

locationLng

appVersion

versionName

platform

osName

osVersion

deviceBrand

deviceManufacturer

deviceModel

carrier

country

region

city

dma

idfa

idfv

adid

androidId

language

partnerId

ip

eventProperties

userProperties

price

quantity

revenue

productId

revenueType

eventId

sessionId

insertId

groups

groupProperties

plan

ingestionMetadata

callback

Constructor Detail

Event

Event

Method Detail

toJsonObject

replaceWithJSONNull

truncate

truncate

toString

truncate