# ShoppingEntity

# ShoppingEntity

*** ** * ** ***

[Kotlin](https://developer.android.com/reference/kotlin/com/google/android/engage/shopping/datamodel/ShoppingEntity "View this page in Kotlin")\|Java  

<br />

```
public final class ShoppingEntity extends Entity
```

<br />

|---|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object.html)                                                                                        |||
| ↳ | [com.google.android.engage.common.datamodel.Entity](https://developer.android.com/reference/com/google/android/engage/common/datamodel/Entity)                        ||
|   | ↳ | [com.google.android.engage.shopping.datamodel.ShoppingEntity](https://developer.android.com/reference/com/google/android/engage/shopping/datamodel/ShoppingEntity) |

*** ** * ** ***

An object representing a Shopping Entity.

## Summary

|                                                                                                                                          ### Nested types                                                                                                                                          |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `public final class `[ShoppingEntity.Builder](https://developer.android.com/reference/com/google/android/engage/shopping/datamodel/ShoppingEntity.Builder) Builder class for[ShoppingEntity](https://developer.android.com/reference/com/google/android/engage/shopping/datamodel/ShoppingEntity). |

|                              ### Public fields                              |
|-----------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------|
| `final `[Uri](https://developer.android.com/reference/android/net/Uri.html) | [actionLinkUri](https://developer.android.com/reference/com/google/android/engage/shopping/datamodel/ShoppingEntity#actionLinkUri()) |

|                                                                                         ### Public methods                                                                                         |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Uri](https://developer.android.com/reference/android/net/Uri.html)                                                                                                                                | [getActionLinkUri](https://developer.android.com/reference/com/google/android/engage/shopping/datamodel/ShoppingEntity#getActionLinkUri())`()` Returns the action link uri of the shopping entity.                                   |
| [Optional](https://guava.dev/releases/21.0/api/docs/com/google/common/base/Optional.html)`<`[String](https://developer.android.com/reference/java/lang/String.html)`>`                             | [getCallout](https://developer.android.com/reference/com/google/android/engage/shopping/datamodel/ShoppingEntity#getCallout())`()` Returns the callout for the shopping entity. e.g. "Thanksgiving deal"                             |
| [Optional](https://guava.dev/releases/21.0/api/docs/com/google/common/base/Optional.html)`<`[String](https://developer.android.com/reference/java/lang/String.html)`>`                             | [getCalloutFinePrint](https://developer.android.com/reference/com/google/android/engage/shopping/datamodel/ShoppingEntity#getCalloutFinePrint())`()` Returns the callout fine print of the shopping entity. e.g. "Limited time only" |
| [List](https://developer.android.com/reference/java/util/List.html)`<`[DisplayTimeWindow](https://developer.android.com/reference/com/google/android/engage/common/datamodel/DisplayTimeWindow)`>` | [getDisplayTimeWindows](https://developer.android.com/reference/com/google/android/engage/shopping/datamodel/ShoppingEntity#getDisplayTimeWindows())`()` Returns the display time window associated with the shopping entity.        |
| [Optional](https://guava.dev/releases/21.0/api/docs/com/google/common/base/Optional.html)`<`[String](https://developer.android.com/reference/java/lang/String.html)`>`                             | [getEntityId](https://developer.android.com/reference/com/google/android/engage/shopping/datamodel/ShoppingEntity#getEntityId())`()` Returns the id of the entity.                                                                   |
| [List](https://developer.android.com/reference/java/util/List.html)`<`[Image](https://developer.android.com/reference/com/google/android/engage/common/datamodel/Image)`>`                         | [getPosterImages](https://developer.android.com/reference/com/google/android/engage/shopping/datamodel/ShoppingEntity#getPosterImages())`()` Returns the poster image of the entity.                                                 |
| [Optional](https://guava.dev/releases/21.0/api/docs/com/google/common/base/Optional.html)`<`[Price](https://developer.android.com/reference/com/google/android/engage/common/datamodel/Price)`>`   | [getPrice](https://developer.android.com/reference/com/google/android/engage/shopping/datamodel/ShoppingEntity#getPrice())`()` Returns the price of the shopping entity.                                                             |
| [Optional](https://guava.dev/releases/21.0/api/docs/com/google/common/base/Optional.html)`<`[Rating](https://developer.android.com/reference/com/google/android/engage/common/datamodel/Rating)`>` | [getRating](https://developer.android.com/reference/com/google/android/engage/shopping/datamodel/ShoppingEntity#getRating())`()` Returns the rating of the shopping entity.                                                          |
| [Optional](https://guava.dev/releases/21.0/api/docs/com/google/common/base/Optional.html)`<`[String](https://developer.android.com/reference/java/lang/String.html)`>`                             | [getTitle](https://developer.android.com/reference/com/google/android/engage/shopping/datamodel/ShoppingEntity#getTitle())`()` Returns the title of the shopping entity.                                                             |

|                                                                                                                                                                                                          ### Inherited methods                                                                                                                                                                                                           |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| From[com.google.android.engage.common.datamodel.Entity](https://developer.android.com/reference/com/google/android/engage/common/datamodel/Entity) |-------|--------------------------------------------------------------------------------------------------------------------------------| | `int` | [getEntityType](https://developer.android.com/reference/com/google/android/engage/common/datamodel/Entity#getEntityType())`()` | |

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