GOgoogle
collections

GET /{merchantId}/collections/{collectionId}

Retrieves a collection from your Merchant Center account.

Request

  • Base URL
    https://shoppingcontent.googleapis.com/content/v2.1
  • Auth
    OAuth 2 and OAuth 2
    Implicithttps://accounts.google.com/o/oauth2/auth
    Scopeshttps://www.googleapis.com/auth/content
    Authorization codehttps://accounts.google.com/o/oauth2/auth
    Token URLhttps://accounts.google.com/o/oauth2/token
    Scopeshttps://www.googleapis.com/auth/content
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

merchantIdstring required

Required. The ID of the account that contains the collection. This account cannot be a multi-client account.

collectionIdstring required

Required. The REST ID of the collection.

Response

Successful response

headlinestring[]

Your collection's name. headline attribute

customLabel4string

Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.

customLabel2string

Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.

imageLinkstring[]

The URL of a collection’s image. image_link attribute

customLabel1string

Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.

customLabel0string

Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns. Custom label

mobileLinkstring

A collection’s mobile-optimized landing page when you have a different URL for mobile and desktop traffic. mobile_link attribute

linkstring

A collection’s landing page. URL directly linking to your collection's page on your website. link attribute

idstring

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

productCountrystring

product_country attribute

customLabel3string

Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.

languagestring

The language of a collection and the language of any featured products linked to the collection. language attribute

Changes

No recorded changes to this operation across all 1 revision of this API.