Skip to main content

collections

Overview

Namecollections
TypeResource
Idgoogledevelopers.content.collections

Fields

NameDatatypeDescription
idstringRequired. 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
customLabel4stringLabel that you assign to a collection to help organize bidding and reporting in Shopping campaigns.
headlinearrayYour collection's name. headline attribute
languagestringThe language of a collection and the language of any featured products linked to the collection. language attribute
customLabel1stringLabel that you assign to a collection to help organize bidding and reporting in Shopping campaigns.
customLabel2stringLabel that you assign to a collection to help organize bidding and reporting in Shopping campaigns.
customLabel3stringLabel that you assign to a collection to help organize bidding and reporting in Shopping campaigns.
productCountrystringproduct_country attribute
customLabel0stringLabel that you assign to a collection to help organize bidding and reporting in Shopping campaigns. Custom label
imageLinkarrayThe URL of a collection’s image. image_link attribute
linkstringA collection’s landing page. URL directly linking to your collection's page on your website. link attribute
mobileLinkstringA collection’s mobile-optimized landing page when you have a different URL for mobile and desktop traffic. mobile_link attribute
featuredProductarrayThis 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

Methods

NameAccessible byRequired ParamsDescription
getSELECTcollectionId, merchantIdRetrieves a collection from your Merchant Center account.
listSELECTmerchantIdLists the collections in your Merchant Center account. The response might contain fewer items than specified by page_size. Rely on next_page_token to determine if there are more items to be requested.
createINSERTmerchantIdUploads a collection to your Merchant Center account. If a collection with the same collectionId already exists, this method updates that entry. In each update, the collection is completely replaced by the fields in the body of the update request.
deleteDELETEcollectionId, merchantIdDeletes a collection from your Merchant Center account.