Package com.algolia.model.insights

Class PurchasedObjectIDsAfterSearch

java.lang.Object

com.algolia.model.insights.PurchasedObjectIDsAfterSearch

All Implemented Interfaces:

EventsItems

public class PurchasedObjectIDsAfterSearch
extends Object
implements EventsItems

Use this event to track when users make a purchase after a previous Algolia request. If you're building your category pages with Algolia, you'll also use this event.

Nested Class Summary

Nested classes/interfaces inherited from interface com.algolia.model.insights.EventsItems

EventsItems.Deserializer

Constructor Summary

Constructors

Constructor	Description
PurchasedObjectIDsAfterSearch()

Method Summary

Modifier and Type	Method	Description
PurchasedObjectIDsAfterSearch	addObjectData(ObjectDataAfterSearch objectDataItem)
PurchasedObjectIDsAfterSearch	addObjectIDs(String objectIDsItem)
boolean	equals(Object o)
String	getAuthenticatedUserToken()	An identifier for authenticated users.
String	getCurrency()	Three-letter [currency code](https://www.iso.org/iso-4217-currency-codes.html).
String	getEventName()	The name of the event, up to 64 ASCII characters.
PurchaseEvent	getEventSubtype()	Get eventSubtype
ConversionEvent	getEventType()	Get eventType
String	getIndex()	The name of an Algolia index.
List<ObjectDataAfterSearch>	getObjectData()	Extra information about the records involved in a purchase or add-to-cart events.
List<String>	getObjectIDs()	The object IDs of the records that are part of the event.
Long	getTimestamp()	The timestamp of the event in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time).
String	getUserToken()	An anonymous or pseudonymous user identifier.
Value	getValue()	Get value
int	hashCode()
PurchasedObjectIDsAfterSearch	setAuthenticatedUserToken(String authenticatedUserToken)
PurchasedObjectIDsAfterSearch	setCurrency(String currency)
PurchasedObjectIDsAfterSearch	setEventName(String eventName)
PurchasedObjectIDsAfterSearch	setEventSubtype(PurchaseEvent eventSubtype)
PurchasedObjectIDsAfterSearch	setEventType(ConversionEvent eventType)
PurchasedObjectIDsAfterSearch	setIndex(String index)
PurchasedObjectIDsAfterSearch	setObjectData(List<ObjectDataAfterSearch> objectData)
PurchasedObjectIDsAfterSearch	setObjectIDs(List<String> objectIDs)
PurchasedObjectIDsAfterSearch	setTimestamp(Long timestamp)
PurchasedObjectIDsAfterSearch	setUserToken(String userToken)
PurchasedObjectIDsAfterSearch	setValue(Value value)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

PurchasedObjectIDsAfterSearch

public PurchasedObjectIDsAfterSearch()

Method Details

setEventName

public PurchasedObjectIDsAfterSearch setEventName(String eventName)

getEventName

@Nonnull
public String getEventName()

The name of the event, up to 64 ASCII characters. Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework.

setEventType

public PurchasedObjectIDsAfterSearch setEventType(ConversionEvent eventType)

getEventType

@Nonnull
public ConversionEvent getEventType()

Get eventType

setEventSubtype

public PurchasedObjectIDsAfterSearch setEventSubtype(PurchaseEvent eventSubtype)

getEventSubtype

@Nonnull
public PurchaseEvent getEventSubtype()

Get eventSubtype

setIndex

public PurchasedObjectIDsAfterSearch setIndex(String index)

getIndex

@Nonnull
public String getIndex()

The name of an Algolia index.

setObjectIDs

public PurchasedObjectIDsAfterSearch setObjectIDs(List<String> objectIDs)

addObjectIDs

public PurchasedObjectIDsAfterSearch addObjectIDs(String objectIDsItem)

getObjectIDs

@Nonnull
public List<String> getObjectIDs()

The object IDs of the records that are part of the event.

setUserToken

public PurchasedObjectIDsAfterSearch setUserToken(String userToken)

getUserToken

@Nonnull
public String getUserToken()

An anonymous or pseudonymous user identifier. > **Note**: Never include personally identifiable information in user tokens.

setAuthenticatedUserToken

public PurchasedObjectIDsAfterSearch setAuthenticatedUserToken(String authenticatedUserToken)

getAuthenticatedUserToken

@Nullable
public String getAuthenticatedUserToken()

An identifier for authenticated users. > **Note**: Never include personally identifiable information in user tokens.

setCurrency

public PurchasedObjectIDsAfterSearch setCurrency(String currency)

getCurrency

@Nullable
public String getCurrency()

Three-letter [currency code](https://www.iso.org/iso-4217-currency-codes.html).

setObjectData

public PurchasedObjectIDsAfterSearch setObjectData(List<ObjectDataAfterSearch> objectData)

addObjectData

public PurchasedObjectIDsAfterSearch addObjectData(ObjectDataAfterSearch objectDataItem)

getObjectData

@Nullable
public List<ObjectDataAfterSearch> getObjectData()

Extra information about the records involved in a purchase or add-to-cart events. If provided, it must be the same length as `objectIDs`.

setTimestamp

public PurchasedObjectIDsAfterSearch setTimestamp(Long timestamp)

getTimestamp

@Nullable
public Long getTimestamp()

The timestamp of the event in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it receives an event as its timestamp.

setValue

public PurchasedObjectIDsAfterSearch setValue(Value value)

getValue

@Nullable
public Value getValue()

Get value

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object