REST Resource: collections

• Resource: Collection
  • JSON representation
• FeaturedProduct
  • JSON representation
• Methods

Resource: Collection

The collection message.

JSON representation
{ "id": string, "language": string, "productCountry": string, "imageLink": [ string ], "featuredProduct": [ { object (FeaturedProduct) } ], "link": string, "mobileLink": string, "headline": [ string ], "customLabel0": string, "customLabel1": string, "customLabel2": string, "customLabel3": string, "customLabel4": string }

Fields
id	string 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
language	string The language of a collection and the language of any featured products linked to the collection. language attribute
productCountry	string productCountry attribute
imageLink[]	string The URL of a collection’s image. imageLink attribute
featuredProduct[]	object (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. featuredProduct attribute
link	string A collection’s landing page. URL directly linking to your collection's page on your website. link attribute
mobileLink	string A collection’s mobile-optimized landing page when you have a different URL for mobile and desktop traffic. mobileLink attribute
headline[]	string Your collection's name. headline attribute
customLabel0	string Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns. Custom label
customLabel1	string Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.
customLabel2	string Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.
customLabel3	string Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.
customLabel4	string Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.

FeaturedProduct

The message for FeaturedProduct. FeaturedProduct

JSON representation
{ "offerId": string, "x": number, "y": number }

Fields
offerId	string The unique identifier for the product item.
x	number Required. X-coordinate of the product callout on the Shoppable Image.
y	number Required. Y-coordinate of the product callout on the Shoppable Image.

Methods
create	Uploads a collection to your Merchant Center account.
delete	Deletes a collection from your Merchant Center account.
get	Retrieves a collection from your Merchant Center account.
list	Lists the collections in your Merchant Center account.