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	getCurrency()	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.
String	getEventName()	Can contain up to 64 ASCII characters.
PurchaseEvent	getEventSubtype()	Get eventSubtype
ConversionEvent	getEventType()	Get eventType
String	getIndex()	Name of the Algolia index.
List<ObjectDataAfterSearch>	getObjectData()	Extra information about the records involved in the event—for example, to add price and quantities of purchased products.
List<String>	getObjectIDs()	List of object identifiers for items of an Algolia index.
String	getQueryID()	Unique identifier for a search query.
Long	getTimestamp()	Time of the event in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time).
String	getUserToken()	Anonymous or pseudonymous user identifier.
int	hashCode()
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	setQueryID(String queryID)
PurchasedObjectIDsAfterSearch	setTimestamp(Long timestamp)
PurchasedObjectIDsAfterSearch	setUserToken(String userToken)
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()

Can contain 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()

Name of the Algolia index.

setQueryID

public PurchasedObjectIDsAfterSearch setQueryID(String queryID)

getQueryID

@Nonnull
public String getQueryID()

Unique identifier for a search query. The query ID is required for events related to search or browse requests. If you add `clickAnalytics: true` as a search request parameter, the query ID is included in the API response.

setObjectIDs

public PurchasedObjectIDsAfterSearch setObjectIDs(List<String> objectIDs)

addObjectIDs

public PurchasedObjectIDsAfterSearch addObjectIDs(String objectIDsItem)

getObjectIDs

@Nonnull
public List<String> getObjectIDs()

List of object identifiers for items of an Algolia index.

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 the event—for example, to add price and quantities of purchased products. If provided, must be the same length as `objectIDs`.

setCurrency

public PurchasedObjectIDsAfterSearch setCurrency(String currency)

getCurrency

@Nullable
public String getCurrency()

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.

setUserToken

public PurchasedObjectIDsAfterSearch setUserToken(String userToken)

getUserToken

@Nonnull
public String getUserToken()

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

setTimestamp

public PurchasedObjectIDsAfterSearch setTimestamp(Long timestamp)

getTimestamp

@Nullable
public Long getTimestamp()

Time 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.

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