com.google.api.services.content.model

Class ProductCluster

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class ProductCluster
extends com.google.api.client.json.GenericJson

Product cluster fields. A product cluster is a grouping for different offers that represent the same product. Values are only set for fields requested explicitly in the request's search query.

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

com.google.api.client.util.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
ProductCluster()

Method Summary

Modifier and Type	Method and Description
ProductCluster	clone()
String	getBrand() Brand of the product cluster.
String	getBrandInventoryStatus() Tells if there is at least one product of the brand currently `IN_STOCK` in your product feed across multiple countries, all products are `OUT_OF_STOCK` in your product feed, or `NOT_IN_INVENTORY`.
String	getCategoryL1() Product category (1st level) of the product cluster, represented in Google's product taxonomy.
String	getCategoryL2() Product category (2nd level) of the product cluster, represented in Google's product taxonomy.
String	getCategoryL3() Product category (3rd level) of the product cluster, represented in Google's product taxonomy.
String	getCategoryL4() Product category (4th level) of the product cluster, represented in Google's product taxonomy.
String	getCategoryL5() Product category (5th level) of the product cluster, represented in Google's product taxonomy.
String	getInventoryStatus() Tells whether the product cluster is `IN_STOCK` in your product feed across multiple countries, `OUT_OF_STOCK` in your product feed, or `NOT_IN_INVENTORY` at all.
String	getTitle() Title of the product cluster.
List<String>	getVariantGtins() GTINs of example variants of the product cluster.
ProductCluster	set(String fieldName, Object value)
ProductCluster	setBrand(String brand) Brand of the product cluster.
ProductCluster	setBrandInventoryStatus(String brandInventoryStatus) Tells if there is at least one product of the brand currently `IN_STOCK` in your product feed across multiple countries, all products are `OUT_OF_STOCK` in your product feed, or `NOT_IN_INVENTORY`.
ProductCluster	setCategoryL1(String categoryL1) Product category (1st level) of the product cluster, represented in Google's product taxonomy.
ProductCluster	setCategoryL2(String categoryL2) Product category (2nd level) of the product cluster, represented in Google's product taxonomy.
ProductCluster	setCategoryL3(String categoryL3) Product category (3rd level) of the product cluster, represented in Google's product taxonomy.
ProductCluster	setCategoryL4(String categoryL4) Product category (4th level) of the product cluster, represented in Google's product taxonomy.
ProductCluster	setCategoryL5(String categoryL5) Product category (5th level) of the product cluster, represented in Google's product taxonomy.
ProductCluster	setInventoryStatus(String inventoryStatus) Tells whether the product cluster is `IN_STOCK` in your product feed across multiple countries, `OUT_OF_STOCK` in your product feed, or `NOT_IN_INVENTORY` at all.
ProductCluster	setTitle(String title) Title of the product cluster.
ProductCluster	setVariantGtins(List<String> variantGtins) GTINs of example variants of the product cluster.

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

ProductCluster

public ProductCluster()

Method Detail

getBrand

public String getBrand()

Brand of the product cluster.

Returns:

value or null for none

setBrand

public ProductCluster setBrand(String brand)

Brand of the product cluster.

Parameters:

brand - brand or null for none

getBrandInventoryStatus

public String getBrandInventoryStatus()

Tells if there is at least one product of the brand currently `IN_STOCK` in your product feed across multiple countries, all products are `OUT_OF_STOCK` in your product feed, or `NOT_IN_INVENTORY`. The field doesn't take the Best Sellers report country filter into account.

Returns:

value or null for none

setBrandInventoryStatus

public ProductCluster setBrandInventoryStatus(String brandInventoryStatus)

Tells if there is at least one product of the brand currently `IN_STOCK` in your product feed across multiple countries, all products are `OUT_OF_STOCK` in your product feed, or `NOT_IN_INVENTORY`. The field doesn't take the Best Sellers report country filter into account.

Parameters:

brandInventoryStatus - brandInventoryStatus or null for none

getCategoryL1

public String getCategoryL1()

Product category (1st level) of the product cluster, represented in Google's product taxonomy.

Returns:

value or null for none

setCategoryL1

public ProductCluster setCategoryL1(String categoryL1)

Product category (1st level) of the product cluster, represented in Google's product taxonomy.

Parameters:

categoryL1 - categoryL1 or null for none

getCategoryL2

public String getCategoryL2()

Product category (2nd level) of the product cluster, represented in Google's product taxonomy.

Returns:

value or null for none

setCategoryL2

public ProductCluster setCategoryL2(String categoryL2)

Product category (2nd level) of the product cluster, represented in Google's product taxonomy.

Parameters:

categoryL2 - categoryL2 or null for none

getCategoryL3

public String getCategoryL3()

Product category (3rd level) of the product cluster, represented in Google's product taxonomy.

Returns:

value or null for none

setCategoryL3

public ProductCluster setCategoryL3(String categoryL3)

Product category (3rd level) of the product cluster, represented in Google's product taxonomy.

Parameters:

categoryL3 - categoryL3 or null for none

getCategoryL4

public String getCategoryL4()

Product category (4th level) of the product cluster, represented in Google's product taxonomy.

Returns:

value or null for none

setCategoryL4

public ProductCluster setCategoryL4(String categoryL4)

Product category (4th level) of the product cluster, represented in Google's product taxonomy.

Parameters:

categoryL4 - categoryL4 or null for none

getCategoryL5

public String getCategoryL5()

Product category (5th level) of the product cluster, represented in Google's product taxonomy.

Returns:

value or null for none

setCategoryL5

public ProductCluster setCategoryL5(String categoryL5)

Product category (5th level) of the product cluster, represented in Google's product taxonomy.

Parameters:

categoryL5 - categoryL5 or null for none

getInventoryStatus

public String getInventoryStatus()

Tells whether the product cluster is `IN_STOCK` in your product feed across multiple countries, `OUT_OF_STOCK` in your product feed, or `NOT_IN_INVENTORY` at all. The field doesn't take the Best Sellers report country filter into account.

Returns:

value or null for none

setInventoryStatus

public ProductCluster setInventoryStatus(String inventoryStatus)

Tells whether the product cluster is `IN_STOCK` in your product feed across multiple countries, `OUT_OF_STOCK` in your product feed, or `NOT_IN_INVENTORY` at all. The field doesn't take the Best Sellers report country filter into account.

Parameters:

inventoryStatus - inventoryStatus or null for none

getTitle

public String getTitle()

Title of the product cluster.

Returns:

value or null for none

setTitle

public ProductCluster setTitle(String title)

Title of the product cluster.

Parameters:

title - title or null for none

getVariantGtins

public List<String> getVariantGtins()

GTINs of example variants of the product cluster.

Returns:

value or null for none

setVariantGtins

public ProductCluster setVariantGtins(List<String> variantGtins)

GTINs of example variants of the product cluster.

Parameters:

variantGtins - variantGtins or null for none

set

public ProductCluster set(String fieldName,
                          Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public ProductCluster clone()

Overrides:

clone in class com.google.api.client.json.GenericJson