Data Type Reference
For each trigger (see "When to send" for each data type), send the correct event with the below fields. There is no need to filter the data you send or check for duplicates. Amazon does this as necessary.
Watch activity
| Field Name | Required (Y/N) | Description |
|---|---|---|
| Event Type | Y | The event can be either Active or Off-Device. See details. |
| Content ID | Y | ID of the content the customer is watching as specified through catalog integration. |
| Live Channel Station ID | Y* | ID of the live linear channel playing the content as specified through catalog integration. * Required for live content only. |
| Internal Profile ID | Y | Provide an obfuscated Profile ID so Fire TV can associate the activity with the correct app customer. |
| Duration | Y | Length of content in milliseconds. |
| Current Playback Position | Y | Offset from start of content in milliseconds, excluding interstitial content (previews, ads, etc.). |
| Credits Position | N | Position of the credits in the content. Offset from start of content in milliseconds, excluding interstitial content (previews, ads, etc.). This field will help Fire TV understand when a customer has finished watching the content. |
| Event Timestamp | N* | * This is required for Off-Device events, but not for Active events. |
| Playback State | Y | Enum with the following possible values: PLAYING, PAUSED, EXIT, or INTERSTITIAL. |
Individual content entitlements
| Field Name | Required (Y/N) | Description |
|---|---|---|
| Content ID | Y | Corresponds to a content ID provided to Fire TV through the catalog integration. |
| Type | Y | One of the following: Recording, Purchase, or Rental. This allows Fire TV to correctly label the content for the customer in the UI. |
| Expiration Date | N | Timestamp for when this content entitlement expires. Absence means it doesn't expire. |
| Entitlement Acquisition Date | Y | Timestamp for when the customer purchased the content. It could be the time an episode was recorded. |
| Acquisition Profile ID | N | Optionally used for personalization purposes. We assume entitlement applies to all profiles. |
Watchlist
| Field Name | Required (Y/N) | Description |
|---|---|---|
| Content ID | Y | Corresponds to the content ID provided to Fire TV through the catalog integration. |
| Activity Date | Y | Timestamp of when the customer added or removed the entitlement. |
| List Action | Y | ADDED or REMOVED. |
| Internal Profile ID | Y | Provide an obfuscated Profile ID so that Fire TV can associate the activity with the correct app customer. |
Next Steps
Take a look at another handy reference for triggers and SDK calls in the Summary Reference Table.
Last updated: Mar 13, 2024