com.loop54.model.request

Class GetPopularOrRecentEntitiesRequest

java.lang.Object

com.loop54.model.request.Request

com.loop54.model.request.GetPopularOrRecentEntitiesRequest

Direct Known Subclasses:

GetPopularEntitiesRequest, GetRecentEntitiesRequest

public abstract class GetPopularOrRecentEntitiesRequest
extends Request

Base class for requests to get the most popular or most recent entities.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	behaviorType The interaction or navigation type to include (such as click, purchase or search).
static java.lang.String	CURRENT_USER_PLACEHOLDER Represents a placeholder value used in `GetRecentEntitiesRequest` and `GetPopularEntitiesRequest` to indicate that the request should target the current user's data.
java.util.List<java.lang.String>	entityType The entity types to include (such as Product or Query) or null for all.
java.lang.String	forUserId A user ID to retrieve the most common/recent entities for that user or null to retrieve the globally most common/recent entities.
EntityCollectionParameters	resultsOptions Parameters for specifying which recommendations results to retrieve and how to format them.

Fields inherited from class com.loop54.model.request.Request

customData

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GetPopularOrRecentEntitiesRequest(java.lang.String behaviorType, java.lang.String forUserId, java.util.List<java.lang.String> entityType)

Method Summary

Methods inherited from class com.loop54.model.request.Request

addCustomData

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CURRENT_USER_PLACEHOLDER

public static final java.lang.String CURRENT_USER_PLACEHOLDER

Represents a placeholder value used in `GetRecentEntitiesRequest` and `GetPopularEntitiesRequest` to indicate that the request should target the current user's data.

See Also:

Constant Field Values

behaviorType

public java.lang.String behaviorType

The interaction or navigation type to include (such as click, purchase or search).

forUserId

public java.lang.String forUserId

A user ID to retrieve the most common/recent entities for that user or null to retrieve the globally most common/recent entities. GetGetPopularOrRecentEntitiesRequest#CURRENT_USER_PLACEHOLDER can be specified to use the user ID from the User-Id request header.

entityType

public java.util.List<java.lang.String> entityType

The entity types to include (such as Product or Query) or null for all.

resultsOptions

public final EntityCollectionParameters resultsOptions

Parameters for specifying which recommendations results to retrieve and how to format them.

Constructor Detail

GetPopularOrRecentEntitiesRequest

protected GetPopularOrRecentEntitiesRequest(java.lang.String behaviorType,
                                            java.lang.String forUserId,
                                            java.util.List<java.lang.String> entityType)