# ShoppingEntity.Builder

# ShoppingEntity.Builder

*** ** * ** ***

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

<br />

```
public final class ShoppingEntity.Builder
```

<br />

*** ** * ** ***

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

## Summary

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

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

## Public constructors

### Builder

```
public Builder()
```  

## Public methods

### addAllDisplayTimeWindow

```
@CanIgnoreReturnValue
public ShoppingEntity.Builder addAllDisplayTimeWindow(List<DisplayTimeWindow> displayTimeWindows)
```

Adds the display time window for the shopping entity.

Optional.  

### addDisplayTimeWindow

```
@CanIgnoreReturnValue
public ShoppingEntity.Builder addDisplayTimeWindow(DisplayTimeWindow displayTimeWindow)
```

Adds the display time window for the shopping entity.

Optional.  

### addPosterImage

```
@CanIgnoreReturnValue
public ShoppingEntity.Builder addPosterImage(Image image)
```

Add a poster image of the entity.

Required.  

### addPosterImages

```
@CanIgnoreReturnValue
public ShoppingEntity.Builder addPosterImages(List<Image> images)
```

Add poster images of the entity.

Required.  

### build

```
public ShoppingEntity build()
```  

### setActionLinkUri

```
@CanIgnoreReturnValue
public ShoppingEntity.Builder setActionLinkUri(Uri actionLinkUri)
```

Sets the action link uri for the shopping entity.

Required.  

### setCallout

```
@CanIgnoreReturnValue
public ShoppingEntity.Builder setCallout(String callout)
```

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

Optional.  

### setCalloutFinePrint

```
@CanIgnoreReturnValue
public ShoppingEntity.Builder setCalloutFinePrint(String calloutFinePrint)
```

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

Optional.  

### setEntityId

```
@CanIgnoreReturnValue
public ShoppingEntity.Builder setEntityId(String entityId)
```

Sets content id of the video entity.

Optional.  

### setPrice

```
@CanIgnoreReturnValue
public ShoppingEntity.Builder setPrice(Price price)
```

Sets the price for the shopping entity;

Optional.  

### setRating

```
@CanIgnoreReturnValue
public ShoppingEntity.Builder setRating(Rating rating)
```

Sets the rating for the shopping entity.

Optional.  

### setTitle

```
@CanIgnoreReturnValue
public ShoppingEntity.Builder setTitle(String title)
```

Sets the title of the shopping entity.

Optional.