Inventory (Content API for Shopping v2-rev20210203-1.31.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.content.model.Inventory

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class Inventory
extends GenericJson
```
Model definition for Inventory.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Content API for Shopping. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

Inventory()

Constructors
Constructor and Description
`Inventory()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Inventory`	`clone()`
`String`	`getAvailability()` The availability of the product.
`String`	`getCustomLabel0()` Custom label 0 for custom grouping of items in a Shopping campaign.
`String`	`getCustomLabel1()` Custom label 1 for custom grouping of items in a Shopping campaign.
`String`	`getCustomLabel2()` Custom label 2 for custom grouping of items in a Shopping campaign.
`String`	`getCustomLabel3()` Custom label 3 for custom grouping of items in a Shopping campaign.
`String`	`getCustomLabel4()` Custom label 3 for custom grouping of items in a Shopping campaign.
`Installment`	`getInstallment()` Number and amount of installments to pay for an item.
`String`	`getInstoreProductLocation()` The instore product location.
`String`	`getKind()` Identifies what kind of resource this is.
`LoyaltyPoints`	`getLoyaltyPoints()` Loyalty points that users receive after purchasing the item.
`InventoryPickup`	`getPickup()` Store pickup information.
`Price`	`getPrice()` The price of the product.
`Long`	`getQuantity()` The quantity of the product.
`Price`	`getSalePrice()` The sale price of the product.
`String`	`getSalePriceEffectiveDate()` A date range represented by a pair of ISO 8601 dates separated by a space, comma, or slash.
`Long`	`getSellOnGoogleQuantity()` The quantity of the product that is available for selling on Google.
`Inventory`	`set(String fieldName, Object value)`
`Inventory`	`setAvailability(String availability)` The availability of the product.
`Inventory`	`setCustomLabel0(String customLabel0)` Custom label 0 for custom grouping of items in a Shopping campaign.
`Inventory`	`setCustomLabel1(String customLabel1)` Custom label 1 for custom grouping of items in a Shopping campaign.
`Inventory`	`setCustomLabel2(String customLabel2)` Custom label 2 for custom grouping of items in a Shopping campaign.
`Inventory`	`setCustomLabel3(String customLabel3)` Custom label 3 for custom grouping of items in a Shopping campaign.
`Inventory`	`setCustomLabel4(String customLabel4)` Custom label 3 for custom grouping of items in a Shopping campaign.
`Inventory`	`setInstallment(Installment installment)` Number and amount of installments to pay for an item.
`Inventory`	`setInstoreProductLocation(String instoreProductLocation)` The instore product location.
`Inventory`	`setKind(String kind)` Identifies what kind of resource this is.
`Inventory`	`setLoyaltyPoints(LoyaltyPoints loyaltyPoints)` Loyalty points that users receive after purchasing the item.
`Inventory`	`setPickup(InventoryPickup pickup)` Store pickup information.
`Inventory`	`setPrice(Price price)` The price of the product.
`Inventory`	`setQuantity(Long quantity)` The quantity of the product.
`Inventory`	`setSalePrice(Price salePrice)` The sale price of the product.
`Inventory`	`setSalePriceEffectiveDate(String salePriceEffectiveDate)` A date range represented by a pair of ISO 8601 dates separated by a space, comma, or slash.
`Inventory`	`setSellOnGoogleQuantity(Long sellOnGoogleQuantity)` The quantity of the product that is available for selling on Google.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - Inventory
```
public Inventory()
```
- Method Detail
  - getAvailability
```
public String getAvailability()
```
    The availability of the product. Acceptable values are: - "`in stock`" - "`out of stock`" - "`preorder`"
    
    Returns:
    
    value or null for none
  - setAvailability
```
public Inventory setAvailability(String availability)
```
    The availability of the product. Acceptable values are: - "`in stock`" - "`out of stock`" - "`preorder`"
    
    Parameters:
    
    availability - availability or null for none
  - getCustomLabel0
```
public String getCustomLabel0()
```
    Custom label 0 for custom grouping of items in a Shopping campaign. Only supported for online products.
    
    Returns:
    
    value or null for none
  - setCustomLabel0
```
public Inventory setCustomLabel0(String customLabel0)
```
    Custom label 0 for custom grouping of items in a Shopping campaign. Only supported for online products.
    
    Parameters:
    
    customLabel0 - customLabel0 or null for none
  - getCustomLabel1
```
public String getCustomLabel1()
```
    Custom label 1 for custom grouping of items in a Shopping campaign. Only supported for online products.
    
    Returns:
    
    value or null for none
  - setCustomLabel1
```
public Inventory setCustomLabel1(String customLabel1)
```
    Custom label 1 for custom grouping of items in a Shopping campaign. Only supported for online products.
    
    Parameters:
    
    customLabel1 - customLabel1 or null for none
  - getCustomLabel2
```
public String getCustomLabel2()
```
    Custom label 2 for custom grouping of items in a Shopping campaign. Only supported for online products.
    
    Returns:
    
    value or null for none
  - setCustomLabel2
```
public Inventory setCustomLabel2(String customLabel2)
```
    Custom label 2 for custom grouping of items in a Shopping campaign. Only supported for online products.
    
    Parameters:
    
    customLabel2 - customLabel2 or null for none
  - getCustomLabel3
```
public String getCustomLabel3()
```
    Custom label 3 for custom grouping of items in a Shopping campaign. Only supported for online products.
    
    Returns:
    
    value or null for none
  - setCustomLabel3
```
public Inventory setCustomLabel3(String customLabel3)
```
    Custom label 3 for custom grouping of items in a Shopping campaign. Only supported for online products.
    
    Parameters:
    
    customLabel3 - customLabel3 or null for none
  - getCustomLabel4
```
public String getCustomLabel4()
```
    Custom label 3 for custom grouping of items in a Shopping campaign. Only supported for online products.
    
    Returns:
    
    value or null for none
  - setCustomLabel4
```
public Inventory setCustomLabel4(String customLabel4)
```
    Custom label 3 for custom grouping of items in a Shopping campaign. Only supported for online products.
    
    Parameters:
    
    customLabel4 - customLabel4 or null for none
  - getInstallment
```
public Installment getInstallment()
```
    Number and amount of installments to pay for an item. Brazil only.
    
    Returns:
    
    value or null for none
  - setInstallment
```
public Inventory setInstallment(Installment installment)
```
    Number and amount of installments to pay for an item. Brazil only.
    
    Parameters:
    
    installment - installment or null for none
  - getInstoreProductLocation
```
public String getInstoreProductLocation()
```
    The instore product location. Supported only for local products.
    
    Returns:
    
    value or null for none
  - setInstoreProductLocation
```
public Inventory setInstoreProductLocation(String instoreProductLocation)
```
    The instore product location. Supported only for local products.
    
    Parameters:
    
    instoreProductLocation - instoreProductLocation or null for none
  - getKind
```
public String getKind()
```
    Identifies what kind of resource this is. Value: the fixed string "`content#inventory`"
    
    Returns:
    
    value or null for none
  - setKind
```
public Inventory setKind(String kind)
```
    Identifies what kind of resource this is. Value: the fixed string "`content#inventory`"
    
    Parameters:
    
    kind - kind or null for none
  - getLoyaltyPoints
```
public LoyaltyPoints getLoyaltyPoints()
```
    Loyalty points that users receive after purchasing the item. Japan only.
    
    Returns:
    
    value or null for none
  - setLoyaltyPoints
```
public Inventory setLoyaltyPoints(LoyaltyPoints loyaltyPoints)
```
    Loyalty points that users receive after purchasing the item. Japan only.
    
    Parameters:
    
    loyaltyPoints - loyaltyPoints or null for none
  - getPickup
```
public InventoryPickup getPickup()
```
    Store pickup information. Only supported for local inventory. Not setting `pickup` means "don't update" while setting it to the empty value (`{}` in JSON) means "delete". Otherwise, `pickupMethod` and `pickupSla` must be set together, unless `pickupMethod` is "not supported".
    
    Returns:
    
    value or null for none
  - setPickup
```
public Inventory setPickup(InventoryPickup pickup)
```
    Store pickup information. Only supported for local inventory. Not setting `pickup` means "don't update" while setting it to the empty value (`{}` in JSON) means "delete". Otherwise, `pickupMethod` and `pickupSla` must be set together, unless `pickupMethod` is "not supported".
    
    Parameters:
    
    pickup - pickup or null for none
  - getPrice
```
public Price getPrice()
```
    The price of the product.
    
    Returns:
    
    value or null for none
  - setPrice
```
public Inventory setPrice(Price price)
```
    The price of the product.
    
    Parameters:
    
    price - price or null for none
  - getQuantity
```
public Long getQuantity()
```
    The quantity of the product. Must be equal to or greater than zero. Supported only for local products.
    
    Returns:
    
    value or null for none
  - setQuantity
```
public Inventory setQuantity(Long quantity)
```
    The quantity of the product. Must be equal to or greater than zero. Supported only for local products.
    
    Parameters:
    
    quantity - quantity or null for none
  - getSalePrice
```
public Price getSalePrice()
```
    The sale price of the product. Mandatory if `sale_price_effective_date` is defined.
    
    Returns:
    
    value or null for none
  - setSalePrice
```
public Inventory setSalePrice(Price salePrice)
```
    The sale price of the product. Mandatory if `sale_price_effective_date` is defined.
    
    Parameters:
    
    salePrice - salePrice or null for none
  - getSalePriceEffectiveDate
```
public String getSalePriceEffectiveDate()
```
    A date range represented by a pair of ISO 8601 dates separated by a space, comma, or slash. Both dates might be specified as 'null' if undecided.
    
    Returns:
    
    value or null for none
  - setSalePriceEffectiveDate
```
public Inventory setSalePriceEffectiveDate(String salePriceEffectiveDate)
```
    A date range represented by a pair of ISO 8601 dates separated by a space, comma, or slash. Both dates might be specified as 'null' if undecided.
    
    Parameters:
    
    salePriceEffectiveDate - salePriceEffectiveDate or null for none
  - getSellOnGoogleQuantity
```
public Long getSellOnGoogleQuantity()
```
    The quantity of the product that is available for selling on Google. Supported only for online products.
    
    Returns:
    
    value or null for none
  - setSellOnGoogleQuantity
```
public Inventory setSellOnGoogleQuantity(Long sellOnGoogleQuantity)
```
    The quantity of the product that is available for selling on Google. Supported only for online products.
    
    Parameters:
    
    sellOnGoogleQuantity - sellOnGoogleQuantity or null for none
  - set
```
public Inventory set(String fieldName,
                     Object value)
```
    Overrides:
    
    set in class GenericJson
  - clone
```
public Inventory clone()
```
    Overrides:
    
    clone in class GenericJson

Class Inventory

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Inventory

Method Detail

getAvailability

setAvailability

getCustomLabel0

setCustomLabel0

getCustomLabel1

setCustomLabel1

getCustomLabel2

setCustomLabel2

getCustomLabel3

setCustomLabel3

getCustomLabel4

setCustomLabel4

getInstallment

setInstallment

getInstoreProductLocation

setInstoreProductLocation

getKind

setKind

getLoyaltyPoints

setLoyaltyPoints

getPickup

setPickup

getPrice

setPrice

getQuantity

setQuantity

getSalePrice

setSalePrice

getSalePriceEffectiveDate

setSalePriceEffectiveDate

getSellOnGoogleQuantity

setSellOnGoogleQuantity

set

clone