algoliasearch-scala/algoliasearch/algoliasearch.insights/PurchasedObjectIDs

PurchasedObjectIDs

algoliasearch.insights.PurchasedObjectIDs

case class PurchasedObjectIDs(eventName: String, eventType: ConversionEvent, eventSubtype: PurchaseEvent, index: String, objectIDs: Seq[String], objectData: Option[Seq[ObjectData]], currency: Option[String], userToken: String, timestamp: Option[Long], authenticatedUserToken: Option[String]) extends EventsItemsTrait

Use this event to track when users make a purchase unrelated to a previous Algolia request. For example, if you don't use Algolia to build your category pages, use this event. To track purchase events related to Algolia requests, use the "Purchased object IDs after search" event.

Value parameters

authenticatedUserToken: User token for authenticated users.
currency: If you include pricing information in the objectData parameter, you must also specify the currency as ISO-4217 currency code, such as USD or EUR.
eventName: Can contain up to 64 ASCII characters. Consider naming events consistently—for example, by adopting Segment's object-action framework.
index: Name of the Algolia index.
objectData: Extra information about the records involved in the event—for example, to add price and quantities of purchased products. If provided, must be the same length as objectIDs.
objectIDs: List of object identifiers for items of an Algolia index.
timestamp: Time of the event in milliseconds in Unix epoch time. By default, the Insights API uses the time it receives an event as its timestamp.
userToken: Anonymous or pseudonymous user identifier. > Note: Never include personally identifiable information in user tokens.

Attributes

Graph
Supertypes: trait Serializable

trait Product

trait Equals

trait EventsItemsTrait

trait EventsItems

class Object

trait Matchable

class Any
Show all

Members list

Value members

Inherited methods

Attributes

Inherited from:: Product

Attributes

Inherited from:: Product

In this article

Generated with