Collection (Content API for Shopping v2.1-rev20240325-2.0.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.Collection

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class Collection
extends com.google.api.client.json.GenericJson
```
The collection message.
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

Collection()

Constructors
Constructor and Description
`Collection()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Collection`	`clone()`
`String`	`getCustomLabel0()` Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.
`String`	`getCustomLabel1()` Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.
`String`	`getCustomLabel2()` Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.
`String`	`getCustomLabel3()` Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.
`String`	`getCustomLabel4()` Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.
`List<CollectionFeaturedProduct>`	`getFeaturedProduct()` This identifies one or more products associated with the collection.
`List<String>`	`getHeadline()` Your collection's name.
`String`	`getId()` Required.
`List<String>`	`getImageLink()` The URL of a collection’s image.
`String`	`getLanguage()` The language of a collection and the language of any featured products linked to the collection.
`String`	`getLink()` A collection’s landing page.
`String`	`getMobileLink()` A collection’s mobile-optimized landing page when you have a different URL for mobile and desktop traffic.
`String`	`getProductCountry()` [product_country attribute](https://support.google.com/merchants/answer/9674155)
`Collection`	`set(String fieldName, Object value)`
`Collection`	`setCustomLabel0(String customLabel0)` Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.
`Collection`	`setCustomLabel1(String customLabel1)` Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.
`Collection`	`setCustomLabel2(String customLabel2)` Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.
`Collection`	`setCustomLabel3(String customLabel3)` Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.
`Collection`	`setCustomLabel4(String customLabel4)` Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.
`Collection`	`setFeaturedProduct(List<CollectionFeaturedProduct> featuredProduct)` This identifies one or more products associated with the collection.
`Collection`	`setHeadline(List<String> headline)` Your collection's name.
`Collection`	`setId(String id)` Required.
`Collection`	`setImageLink(List<String> imageLink)` The URL of a collection’s image.
`Collection`	`setLanguage(String language)` The language of a collection and the language of any featured products linked to the collection.
`Collection`	`setLink(String link)` A collection’s landing page.
`Collection`	`setMobileLink(String mobileLink)` A collection’s mobile-optimized landing page when you have a different URL for mobile and desktop traffic.
`Collection`	`setProductCountry(String productCountry)` [product_country attribute](https://support.google.com/merchants/answer/9674155)

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
  - Collection
```
public Collection()
```
- Method Detail
  - getCustomLabel0
```
public String getCustomLabel0()
```
    Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns. [Custom label](https://support.google.com/merchants/answer/9674217)
    
    Returns:
    
    value or null for none
  - setCustomLabel0
```
public Collection setCustomLabel0(String customLabel0)
```
    Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns. [Custom label](https://support.google.com/merchants/answer/9674217)
    
    Parameters:
    
    customLabel0 - customLabel0 or null for none
  - getCustomLabel1
```
public String getCustomLabel1()
```
    Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.
    
    Returns:
    
    value or null for none
  - setCustomLabel1
```
public Collection setCustomLabel1(String customLabel1)
```
    Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.
    
    Parameters:
    
    customLabel1 - customLabel1 or null for none
  - getCustomLabel2
```
public String getCustomLabel2()
```
    Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.
    
    Returns:
    
    value or null for none
  - setCustomLabel2
```
public Collection setCustomLabel2(String customLabel2)
```
    Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.
    
    Parameters:
    
    customLabel2 - customLabel2 or null for none
  - getCustomLabel3
```
public String getCustomLabel3()
```
    Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.
    
    Returns:
    
    value or null for none
  - setCustomLabel3
```
public Collection setCustomLabel3(String customLabel3)
```
    Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.
    
    Parameters:
    
    customLabel3 - customLabel3 or null for none
  - getCustomLabel4
```
public String getCustomLabel4()
```
    Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.
    
    Returns:
    
    value or null for none
  - setCustomLabel4
```
public Collection setCustomLabel4(String customLabel4)
```
    Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.
    
    Parameters:
    
    customLabel4 - customLabel4 or null for none
  - getFeaturedProduct
```
public List<CollectionFeaturedProduct> getFeaturedProduct()
```
    This identifies one or more products associated with the collection. Used as a lookup to the corresponding product ID in your product feeds. Provide a maximum of 100 featuredProduct (for collections). Provide up to 10 featuredProduct (for Shoppable Images only) with ID and X and Y coordinates. [featured_product attribute](https://support.google.com/merchants/answer/9703736)
    
    Returns:
    
    value or null for none
  - setFeaturedProduct
```
public Collection setFeaturedProduct(List<CollectionFeaturedProduct> featuredProduct)
```
    This identifies one or more products associated with the collection. Used as a lookup to the corresponding product ID in your product feeds. Provide a maximum of 100 featuredProduct (for collections). Provide up to 10 featuredProduct (for Shoppable Images only) with ID and X and Y coordinates. [featured_product attribute](https://support.google.com/merchants/answer/9703736)
    
    Parameters:
    
    featuredProduct - featuredProduct or null for none
  - getHeadline
```
public List<String> getHeadline()
```
    Your collection's name. [headline attribute](https://support.google.com/merchants/answer/9673580)
    
    Returns:
    
    value or null for none
  - setHeadline
```
public Collection setHeadline(List<String> headline)
```
    Your collection's name. [headline attribute](https://support.google.com/merchants/answer/9673580)
    
    Parameters:
    
    headline - headline or null for none
  - getId
```
public String getId()
```
    Required. The REST ID of the collection. Content API methods that operate on collections take this as their collectionId parameter. The REST ID for a collection is of the form collectionId. [id attribute](https://support.google.com/merchants/answer/9649290)
    
    Returns:
    
    value or null for none
  - setId
```
public Collection setId(String id)
```
    Required. The REST ID of the collection. Content API methods that operate on collections take this as their collectionId parameter. The REST ID for a collection is of the form collectionId. [id attribute](https://support.google.com/merchants/answer/9649290)
    
    Parameters:
    
    id - id or null for none
  - getImageLink
```
public List<String> getImageLink()
```
    The URL of a collection’s image. [image_link attribute](https://support.google.com/merchants/answer/9703236)
    
    Returns:
    
    value or null for none
  - setImageLink
```
public Collection setImageLink(List<String> imageLink)
```
    The URL of a collection’s image. [image_link attribute](https://support.google.com/merchants/answer/9703236)
    
    Parameters:
    
    imageLink - imageLink or null for none
  - getLanguage
```
public String getLanguage()
```
    The language of a collection and the language of any featured products linked to the collection. [language attribute](https://support.google.com/merchants/answer/9673781)
    
    Returns:
    
    value or null for none
  - setLanguage
```
public Collection setLanguage(String language)
```
    The language of a collection and the language of any featured products linked to the collection. [language attribute](https://support.google.com/merchants/answer/9673781)
    
    Parameters:
    
    language - language or null for none
  - getLink
```
public String getLink()
```
    A collection’s landing page. URL directly linking to your collection's page on your website. [link attribute](https://support.google.com/merchants/answer/9673983)
    
    Returns:
    
    value or null for none
  - setLink
```
public Collection setLink(String link)
```
    A collection’s landing page. URL directly linking to your collection's page on your website. [link attribute](https://support.google.com/merchants/answer/9673983)
    
    Parameters:
    
    link - link or null for none
  - getMobileLink
```
public String getMobileLink()
```
    A collection’s mobile-optimized landing page when you have a different URL for mobile and desktop traffic. [mobile_link attribute](https://support.google.com/merchants/answer/9646123)
    
    Returns:
    
    value or null for none
  - setMobileLink
```
public Collection setMobileLink(String mobileLink)
```
    A collection’s mobile-optimized landing page when you have a different URL for mobile and desktop traffic. [mobile_link attribute](https://support.google.com/merchants/answer/9646123)
    
    Parameters:
    
    mobileLink - mobileLink or null for none
  - getProductCountry
```
public String getProductCountry()
```
    [product_country attribute](https://support.google.com/merchants/answer/9674155)
    
    Returns:
    
    value or null for none
  - setProductCountry
```
public Collection setProductCountry(String productCountry)
```
    [product_country attribute](https://support.google.com/merchants/answer/9674155)
    
    Parameters:
    
    productCountry - productCountry or null for none
  - set
```
public Collection set(String fieldName,
                      Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public Collection clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class Collection

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

Collection

Method Detail

getCustomLabel0

setCustomLabel0

getCustomLabel1

setCustomLabel1

getCustomLabel2

setCustomLabel2

getCustomLabel3

setCustomLabel3

getCustomLabel4

setCustomLabel4

getFeaturedProduct

setFeaturedProduct

getHeadline

setHeadline

getId

setId

getImageLink

setImageLink

getLanguage

setLanguage

getLink

setLink

getMobileLink

setMobileLink

getProductCountry

setProductCountry

set

clone