# ShoppingEntity.Builder

# ShoppingEntity.Builder

*** ** * ** ***

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

<br />

```
class ShoppingEntity.Builder
```

<br />

*** ** * ** ***

Builder class for[ShoppingEntity](https://developer.android.com/reference/kotlin/com/google/android/engage/shopping/datamodel/ShoppingEntity).

## Summary

|                                                           ### Public constructors                                                           |
|---------------------------------------------------------------------------------------------------------------------------------------------|
| [Builder](https://developer.android.com/reference/kotlin/com/google/android/engage/shopping/datamodel/ShoppingEntity.Builder#Builder())`()` |

|                                                              ### Public functions                                                               |
|-------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [ShoppingEntity.Builder](https://developer.android.com/reference/kotlin/com/google/android/engage/shopping/datamodel/ShoppingEntity.Builder)`!` | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [addAllDisplayTimeWindow](https://developer.android.com/reference/kotlin/com/google/android/engage/shopping/datamodel/ShoppingEntity.Builder#addAllDisplayTimeWindow(java.util.List<com.google.android.engage.common.datamodel.DisplayTimeWindow>))`(` ` displayTimeWindows: (`[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)`!>!` `)` Adds the display time window for the shopping entity. |
| [ShoppingEntity.Builder](https://developer.android.com/reference/kotlin/com/google/android/engage/shopping/datamodel/ShoppingEntity.Builder)`!` | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [addDisplayTimeWindow](https://developer.android.com/reference/kotlin/com/google/android/engage/shopping/datamodel/ShoppingEntity.Builder#addDisplayTimeWindow(com.google.android.engage.common.datamodel.DisplayTimeWindow))`(displayTimeWindow: `[DisplayTimeWindow](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/DisplayTimeWindow)`!)` Adds the display time window for the shopping entity.                                                                                                                                                                                                                                   |
| [ShoppingEntity.Builder](https://developer.android.com/reference/kotlin/com/google/android/engage/shopping/datamodel/ShoppingEntity.Builder)`!` | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [addPosterImage](https://developer.android.com/reference/kotlin/com/google/android/engage/shopping/datamodel/ShoppingEntity.Builder#addPosterImage(com.google.android.engage.common.datamodel.Image))`(image: `[Image](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/Image)`!)` Add a poster image of the entity.                                                                                                                                                                                                                                                                                                                   |
| [ShoppingEntity.Builder](https://developer.android.com/reference/kotlin/com/google/android/engage/shopping/datamodel/ShoppingEntity.Builder)`!` | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [addPosterImages](https://developer.android.com/reference/kotlin/com/google/android/engage/shopping/datamodel/ShoppingEntity.Builder#addPosterImages(java.util.List<com.google.android.engage.common.datamodel.Image>))`(images: (`[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)`!>!)` Add poster images of the entity.                                                                                             |
| [ShoppingEntity](https://developer.android.com/reference/kotlin/com/google/android/engage/shopping/datamodel/ShoppingEntity)`!`                 | [build](https://developer.android.com/reference/kotlin/com/google/android/engage/shopping/datamodel/ShoppingEntity.Builder#build())`()`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| [ShoppingEntity.Builder](https://developer.android.com/reference/kotlin/com/google/android/engage/shopping/datamodel/ShoppingEntity.Builder)`!` | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [setActionLinkUri](https://developer.android.com/reference/kotlin/com/google/android/engage/shopping/datamodel/ShoppingEntity.Builder#setActionLinkUri(android.net.Uri))`(actionLinkUri: `[Uri](https://developer.android.com/reference/android/net/Uri.html)`!)` Sets the action link uri for the shopping entity.                                                                                                                                                                                                                                                                                                                                                             |
| [ShoppingEntity.Builder](https://developer.android.com/reference/kotlin/com/google/android/engage/shopping/datamodel/ShoppingEntity.Builder)`!` | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [setCallout](https://developer.android.com/reference/kotlin/com/google/android/engage/shopping/datamodel/ShoppingEntity.Builder#setCallout(java.lang.String))`(callout: `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`!)` Sets the callout text for the shopping entity. e.g. "Thanksgiving deal"                                                                                                                                                                                                                                                                                                                                           |
| [ShoppingEntity.Builder](https://developer.android.com/reference/kotlin/com/google/android/engage/shopping/datamodel/ShoppingEntity.Builder)`!` | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [setCalloutFinePrint](https://developer.android.com/reference/kotlin/com/google/android/engage/shopping/datamodel/ShoppingEntity.Builder#setCalloutFinePrint(java.lang.String))`(calloutFinePrint: `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`!)` Sets the callout fine print for the shopping entity e.g. "Limited time only"                                                                                                                                                                                                                                                                                                           |
| [ShoppingEntity.Builder](https://developer.android.com/reference/kotlin/com/google/android/engage/shopping/datamodel/ShoppingEntity.Builder)`!` | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [setEntityId](https://developer.android.com/reference/kotlin/com/google/android/engage/shopping/datamodel/ShoppingEntity.Builder#setEntityId(java.lang.String))`(entityId: `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`!)` Sets content id of the video entity.                                                                                                                                                                                                                                                                                                                                                                           |
| [ShoppingEntity.Builder](https://developer.android.com/reference/kotlin/com/google/android/engage/shopping/datamodel/ShoppingEntity.Builder)`!` | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [setPrice](https://developer.android.com/reference/kotlin/com/google/android/engage/shopping/datamodel/ShoppingEntity.Builder#setPrice(com.google.android.engage.common.datamodel.Price))`(price: `[Price](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/Price)`!)` Sets the price for the shopping entity;                                                                                                                                                                                                                                                                                                                         |
| [ShoppingEntity.Builder](https://developer.android.com/reference/kotlin/com/google/android/engage/shopping/datamodel/ShoppingEntity.Builder)`!` | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [setRating](https://developer.android.com/reference/kotlin/com/google/android/engage/shopping/datamodel/ShoppingEntity.Builder#setRating(com.google.android.engage.common.datamodel.Rating))`(rating: `[Rating](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/Rating)`!)` Sets the rating for the shopping entity.                                                                                                                                                                                                                                                                                                                  |
| [ShoppingEntity.Builder](https://developer.android.com/reference/kotlin/com/google/android/engage/shopping/datamodel/ShoppingEntity.Builder)`!` | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [setTitle](https://developer.android.com/reference/kotlin/com/google/android/engage/shopping/datamodel/ShoppingEntity.Builder#setTitle(java.lang.String))`(title: `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`!)` Sets the title of the shopping entity.                                                                                                                                                                                                                                                                                                                                                                                  |

## Public constructors

### Builder

```
Builder()
```  

## Public functions

### addAllDisplayTimeWindow

```
@CanIgnoreReturnValue
fun addAllDisplayTimeWindow(
    displayTimeWindows: (Mutable)List<DisplayTimeWindow!>!
): ShoppingEntity.Builder!
```

Adds the display time window for the shopping entity.

Optional.  

### addDisplayTimeWindow

```
@CanIgnoreReturnValue
fun addDisplayTimeWindow(displayTimeWindow: DisplayTimeWindow!): ShoppingEntity.Builder!
```

Adds the display time window for the shopping entity.

Optional.  

### addPosterImage

```
@CanIgnoreReturnValue
fun addPosterImage(image: Image!): ShoppingEntity.Builder!
```

Add a poster image of the entity.

Required.  

### addPosterImages

```
@CanIgnoreReturnValue
fun addPosterImages(images: (Mutable)List<Image!>!): ShoppingEntity.Builder!
```

Add poster images of the entity.

Required.  

### build

```
fun build(): ShoppingEntity!
```  

### setActionLinkUri

```
@CanIgnoreReturnValue
fun setActionLinkUri(actionLinkUri: Uri!): ShoppingEntity.Builder!
```

Sets the action link uri for the shopping entity.

Required.  

### setCallout

```
@CanIgnoreReturnValue
fun setCallout(callout: String!): ShoppingEntity.Builder!
```

Sets the callout text for the shopping entity. e.g. "Thanksgiving deal"

Optional.  

### setCalloutFinePrint

```
@CanIgnoreReturnValue
fun setCalloutFinePrint(calloutFinePrint: String!): ShoppingEntity.Builder!
```

Sets the callout fine print for the shopping entity e.g. "Limited time only"

Optional.  

### setEntityId

```
@CanIgnoreReturnValue
fun setEntityId(entityId: String!): ShoppingEntity.Builder!
```

Sets content id of the video entity.

Optional.  

### setPrice

```
@CanIgnoreReturnValue
fun setPrice(price: Price!): ShoppingEntity.Builder!
```

Sets the price for the shopping entity;

Optional.  

### setRating

```
@CanIgnoreReturnValue
fun setRating(rating: Rating!): ShoppingEntity.Builder!
```

Sets the rating for the shopping entity.

Optional.  

### setTitle

```
@CanIgnoreReturnValue
fun setTitle(title: String!): ShoppingEntity.Builder!
```

Sets the title of the shopping entity.

Optional.