# ShoppingEntity

# ShoppingEntity

*** ** * ** ***

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

<br />

```
class ShoppingEntity : Entity
```

<br />

|---|---|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)                                                                                               |||
| ↳ | [com.google.android.engage.common.datamodel.Entity](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/Entity)                        ||
|   | ↳ | [com.google.android.engage.shopping.datamodel.ShoppingEntity](https://developer.android.com/reference/kotlin/com/google/android/engage/shopping/datamodel/ShoppingEntity) |

*** ** * ** ***

An object representing a Shopping Entity.

## Summary

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

|                                                                                                                                                           ### Public functions                                                                                                                                                            |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Optional](https://guava.dev/releases/21.0/api/docs/com/google/common/base/Optional.html)`<`[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`!>!`                                                                                                                                                         | [getCallout](https://developer.android.com/reference/kotlin/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://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`!>!`                                                                                                                                                         | [getCalloutFinePrint](https://developer.android.com/reference/kotlin/com/google/android/engage/shopping/datamodel/ShoppingEntity#getCalloutFinePrint())`()` Returns the callout fine print of the shopping entity. e.g. "Limited time only" |
| `(`[Mutable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-list/index.html)`)`[List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[DisplayTimeWindow](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/DisplayTimeWindow)`!>!` | [getDisplayTimeWindows](https://developer.android.com/reference/kotlin/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://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`!>!`                                                                                                                                                         | [getEntityId](https://developer.android.com/reference/kotlin/com/google/android/engage/shopping/datamodel/ShoppingEntity#getEntityId())`()` Returns the id of the entity.                                                                   |
| `(`[Mutable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-list/index.html)`)`[List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[Image](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/Image)`!>!`                         | [getPosterImages](https://developer.android.com/reference/kotlin/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/kotlin/com/google/android/engage/common/datamodel/Price)`!>!`                                                                                                                                 | [getPrice](https://developer.android.com/reference/kotlin/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/kotlin/com/google/android/engage/common/datamodel/Rating)`!>!`                                                                                                                               | [getRating](https://developer.android.com/reference/kotlin/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://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`!>!`                                                                                                                                                         | [getTitle](https://developer.android.com/reference/kotlin/com/google/android/engage/shopping/datamodel/ShoppingEntity#getTitle())`()` Returns the title of the shopping entity.                                                             |

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

|                                                                                                                                                                                                                                                                                         ### Inherited functions                                                                                                                                                                                                                                                                                         |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| From[com.google.android.engage.common.datamodel.Entity](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/Entity) |----------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------| | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [getEntityType](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/Entity#getEntityType())`()` | |

## Public functions

### getCallout

```
fun getCallout(): Optional<String!>!
```

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

### getCalloutFinePrint

```
fun getCalloutFinePrint(): Optional<String!>!
```

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

### getDisplayTimeWindows

```
fun getDisplayTimeWindows(): (Mutable)List<DisplayTimeWindow!>!
```

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

```
fun getEntityId(): Optional<String!>!
```

Returns the id of the entity.  

### getPosterImages

```
fun getPosterImages(): (Mutable)List<Image!>!
```

Returns the poster image of the entity.  

### getPrice

```
fun getPrice(): Optional<Price!>!
```

Returns the price of the shopping entity.  

### getRating

```
fun getRating(): Optional<Rating!>!
```

Returns the rating of the shopping entity.  

### getTitle

```
fun getTitle(): Optional<String!>!
```

Returns the title of the shopping entity.  

## Public properties

### actionLinkUri

```
val actionLinkUri: Uri!
```