Package com.algolia.model.insights

Class PurchasedObjectIDs

java.lang.Object
com.algolia.model.insights.PurchasedObjectIDs
All Implemented Interfaces:
EventsItems
public class PurchasedObjectIDs extends Object implements EventsItems
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.

  • Constructor Details

    • PurchasedObjectIDs

      public PurchasedObjectIDs()

  • Method Details

    • setEventName

      public PurchasedObjectIDs 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 PurchasedObjectIDs setEventType(ConversionEvent eventType)

    • getEventType

      @Nonnull public ConversionEvent getEventType()
      Get eventType

    • setEventSubtype

      public PurchasedObjectIDs setEventSubtype(PurchaseEvent eventSubtype)

    • getEventSubtype

      @Nonnull public PurchaseEvent getEventSubtype()
      Get eventSubtype

    • setIndex

      public PurchasedObjectIDs setIndex(String index)

    • getIndex

      @Nonnull public String getIndex()
      Name of the Algolia index.

    • setObjectIDs

      public PurchasedObjectIDs setObjectIDs(List<String> objectIDs)

    • addObjectIDs

      public PurchasedObjectIDs addObjectIDs(String objectIDsItem)

    • getObjectIDs

      @Nonnull public List<String> getObjectIDs()
      List of object identifiers for items of an Algolia index.

    • setObjectData

      public PurchasedObjectIDs setObjectData(List<ObjectData> objectData)

    • addObjectData

      public PurchasedObjectIDs addObjectData(ObjectData objectDataItem)

    • getObjectData

      @Nullable public List<ObjectData> 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 PurchasedObjectIDs 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 PurchasedObjectIDs setUserToken(String userToken)

    • getUserToken

      @Nonnull public String getUserToken()
      Anonymous or pseudonymous user identifier. > **Note**: Never include personally identifiable information in user tokens.

    • setTimestamp

      public PurchasedObjectIDs 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.

    • setAuthenticatedUserToken

      public PurchasedObjectIDs setAuthenticatedUserToken(String authenticatedUserToken)

    • getAuthenticatedUserToken

      @Nullable public String getAuthenticatedUserToken()
      User token for authenticated users.

    • 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