ShoppingEntity

public final class ShoppingEntity extends Entity

java.lang.Object
   ↳ com.google.android.engage.common.datamodel.Entity
     ↳ com.google.android.engage.shopping.datamodel.ShoppingEntity

An object representing a Shopping Entity.

Summary

Nested types
public final class ShoppingEntity.Builder

Builder class for ShoppingEntity.

Public fields
final Uri

Public methods
Uri

Returns the action link uri of the shopping entity.
Optional<String>

Returns the callout for the shopping entity. e.g. "Thanksgiving deal"
Optional<String>

Returns the callout fine print of the shopping entity. e.g. "Limited time only"
List<DisplayTimeWindow>

Returns the display time window associated with the shopping entity.
Optional<String>

Returns the id of the entity.
List<Image>

Returns the poster image of the entity.
Optional<Price>

Returns the price of the shopping entity.
Optional<Rating>

Returns the rating of the shopping entity.
Optional<String>

Returns the title of the shopping entity.

Inherited methods
From com.google.android.engage.common.datamodel.Entity
int

Public fields

actionLinkUri

public final Uri actionLinkUri

Public methods

getActionLinkUri

public Uri getActionLinkUri()

Returns the action link uri of the shopping entity.

getCallout

public Optional<String> getCallout()

Returns the callout for the shopping entity. e.g. "Thanksgiving deal"

getCalloutFinePrint

public Optional<String> getCalloutFinePrint()

Returns the callout fine print of the shopping entity. e.g. "Limited time only"

getDisplayTimeWindows

public List<DisplayTimeWindow> getDisplayTimeWindows()

Returns the display time window associated with the shopping entity.

This can be used for several use cases like offer expiry time window, preorder availability time window.

getEntityId

public Optional<String> getEntityId()

Returns the id of the entity.

getPosterImages

public List<Image> getPosterImages()

Returns the poster image of the entity.

getPrice

public Optional<Price> getPrice()

Returns the price of the shopping entity.

getRating

public Optional<Rating> getRating()

Returns the rating of the shopping entity.

getTitle

public Optional<String> getTitle()

Returns the title of the shopping entity.