Android event taxonomy
Every attribute the Android SDK captures, by event, with the type it carries and whether it is required.
Overview
What the Android SDK captures, event by event.
📘 Android carries these as records, not as provisioned collections
Every other source on this page provisions collections in the shared events namespace, and its attributes come with a description and an example value. Android provisions no collections: what it sends arrives as SDK records instead. Two things follow, and both are visible below.
- There is no Example column, because the Android schemas carry names and types only.
- Attributes are grouped by the record the SDK sends, named above each table.
The full wire record for each, envelope included, is in Android record taxonomy.
The shared envelope
Identical on every event below, so it is stated once here rather than repeated in each table: eventId, profileId, userId, sessionId, pageId and timestamp. Only eventId, profileId and timestamp always arrive.
Events
Session start
Sent as the sessionStart record.
| Attribute | Type | Required |
|---|---|---|
userAttributes.deviceType | String | No |
userAttributes.carrier | String | No |
userAttributes.platform | String | No |
userAttributes.ipAddress | String | No |
userAttributes.region | String | No |
userAttributes.country | String | No |
userAttributes.city | String | No |
sessionAttributes.sessionStartEventName | String | No |
sessionAttributes.deviceName | String | No |
sessionAttributes.source | String | No |
sessionAttributes.appName | String | No |
sessionAttributes.appVersion | String | No |
sessionAttributes.advertiserId | String | No |
sessionAttributes.appIdentifier | String | No |
sessionAttributes.androidId | String | No |
Session end
Sent as the sessionEnd record.
| Attribute | Type | Required |
|---|---|---|
userAttributes.deviceType | String | No |
userAttributes.carrier | String | No |
userAttributes.platform | String | No |
userAttributes.ipAddress | String | No |
userAttributes.region | String | No |
userAttributes.country | String | No |
userAttributes.city | String | No |
data.sessionStartEventName | String | No |
data.deviceName | String | No |
data.source | String | No |
data.appName | String | No |
data.appVersion | String | No |
data.advertiserId | String | No |
data.appIdentifier | String | No |
data.androidId | String | No |
data.sessionEndEventName | String | No |
data.sessionDuration | Decimal | No |
data.sessionEventCount | Decimal | No |
View screen
Sent as the viewScreen record.
| Attribute | Type | Required |
|---|---|---|
data.activity | String | No |
data.fullActivity | String | No |
data.screenName | String | No |
Leave screen
Sent as the leaveScreen record.
| Attribute | Type | Required |
|---|---|---|
data.activity | String | No |
data.fullActivity | String | No |
data.screenName | String | No |
data.timeOnScreen | Decimal | No |
App install or upgrade
Sent as the appInstall record.
| Attribute | Type | Required |
|---|---|---|
data.currentVersionCode | Decimal | No |
data.previousVersionCode | Decimal | No |
data.previousBuildType | String | No |
data.currentBuildType | String | No |
data.isUpgrade | Boolean | No |
data.appVisibilityState | Boolean | No |
userAttributes.device_token | String | No |
Touch
Sent as the touch record.
| Attribute | Type | Required |
|---|---|---|
data.targetElement | String | No |
data.hierarchy | String | No |
data.targetText | String | No |
data.targetClass | String | No |
data.targetId | String | No |
data.fullTargetId | String | No |
data.targetValue | String | No |
data.targetResourceId | String | No |
Change event
Sent as the change record.
| Attribute | Type | Required |
|---|---|---|
data.targetElement | String | No |
data.hierarchy | String | No |
data.targetText | String | No |
data.targetClass | String | No |
data.targetId | String | No |
data.fullTargetId | String | No |
data.targetResourceId | String | No |
data.targetValue | String | No |
Fragment transition
Sent as the fragmentTransition record.
| Attribute | Type | Required |
|---|---|---|
data.visibleFragment | String | No |
data.addedFragment | String | No |
data.removedFragment | String | No |
Added to cart
Sent as the addedToCart record.
| Attribute | Type | Required |
|---|---|---|
data.productId | String | No |
data.quantity | Decimal | No |
Removed from cart
Sent as the removedFromCart record.
| Attribute | Type | Required |
|---|---|---|
data.productId | String | No |
data.quantity | Decimal | No |
Product ordered
Sent as the productOrdered record.
| Attribute | Type | Required |
|---|---|---|
data.productId | String | No |
data.quantity | Decimal | No |
Product viewed
Sent as the productViewed record.
| Attribute | Type | Required |
|---|---|---|
data.productId | String | No |
Identify
Sent as the identify record.
Carries the shared envelope only. Nothing beyond identity is captured on this event.