Package com.algolia.model.insights

Class ConvertedObjectIDsAfterSearch

java.lang.Object
com.algolia.model.insights.ConvertedObjectIDsAfterSearch
All Implemented Interfaces:
EventsItems
public class ConvertedObjectIDsAfterSearch extends Object implements EventsItems
Use this event to track when users convert after a previous Algolia request. For example, a user clicks on an item in the search results to view the product detail page. Then, the user adds the item to their shopping cart. If you're building your category pages with Algolia, you'll also use this event.

  • Constructor Details

    • ConvertedObjectIDsAfterSearch

      public ConvertedObjectIDsAfterSearch()

  • Method Details

    • setEventName

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

    • getEventType

      @Nonnull public ConversionEvent getEventType()
      Get eventType

    • setIndex

      public ConvertedObjectIDsAfterSearch setIndex(String index)

    • getIndex

      @Nonnull public String getIndex()
      The name of an Algolia index.

    • setObjectIDs

      public ConvertedObjectIDsAfterSearch setObjectIDs(List<String> objectIDs)

    • addObjectIDs

      public ConvertedObjectIDsAfterSearch addObjectIDs(String objectIDsItem)

    • getObjectIDs

      @Nonnull public List<String> getObjectIDs()
      The object IDs of the records that are part of the event.

    • setQueryID

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

    • setUserToken

      public ConvertedObjectIDsAfterSearch 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 ConvertedObjectIDsAfterSearch setAuthenticatedUserToken(String authenticatedUserToken)

    • getAuthenticatedUserToken

      @Nullable public String getAuthenticatedUserToken()
      An identifier for authenticated users. > **Note**: Never include personally identifiable information in user tokens.

    • setTimestamp

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

    • 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