REST Resource: collectionstatuses

    • This documentation outlines the CollectionStatus , DestinationStatus , and ItemLevelIssue resources, which provide information about the status of collections in Google Merchant Center.

    • The CollectionStatus resource gives an overview of a collection's status, including its intended destinations, creation and update dates, and any associated issues.

    • DestinationStatus specifies the approval status of a collection in different countries for a specific destination.

    • ItemLevelIssue describes problems found within a collection, including their severity, resolution options, and affected attributes or destinations.

    • You can retrieve information about collection statuses using the get and list methods of the collectionstatuses resource.

    Resource: CollectionStatus

    The collectionstatus message.

    JSON representation 
     { 
 "id" 
 : 
 string 
 , 
 "destinationStatuses" 
 : 
 [ 
 { 
 object (  DestinationStatus 
 
) 
 } 
 ] 
 , 
 "creationDate" 
 : 
 string 
 , 
 "lastUpdateDate" 
 : 
 string 
 , 
 "collectionLevelIssuses" 
 : 
 [ 
 { 
 object (  ItemLevelIssue 
 
) 
 } 
 ] 
 }
    Fields
    id

    string

    Required. The ID of the collection for which status is reported.
    destinationStatuses[]

    object ( DestinationStatus )

    The intended destinations for the collection.
    creationDate

    string

    Date on which the collection has been created in ISO 8601 format: Date, time, and offset, for example "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z"
    lastUpdateDate

    string

    Date on which the collection has been last updated in ISO 8601 format: Date, time, and offset, for example "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z"
    collectionLevelIssuses[]

    object ( ItemLevelIssue )

    A list of all issues associated with the collection.

    DestinationStatus

    Destination status message.

    JSON representation 
     { 
 "destination" 
 : 
 string 
 , 
 "status" 
 : 
 string 
 , 
 "approvedCountries" 
 : 
 [ 
 string 
 ] 
 , 
 "pendingCountries" 
 : 
 [ 
 string 
 ] 
 , 
 "disapprovedCountries" 
 : 
 [ 
 string 
 ] 
 }
    Fields
    destination

    string

    The name of the destination
    status

    string

    The status for the specified destination in the collections target country.
    approvedCountries[]

    string

    Country codes (ISO 3166-1 alpha-2) where the collection is approved.
    pendingCountries[]

    string

    Country codes (ISO 3166-1 alpha-2) where the collection is pending approval.
    disapprovedCountries[]

    string

    Country codes (ISO 3166-1 alpha-2) where the collection is disapproved.

    ItemLevelIssue

    Issue associated with the collection.

    JSON representation 
     { 
 "code" 
 : 
 string 
 , 
 "servability" 
 : 
 string 
 , 
 "resolution" 
 : 
 string 
 , 
 "attributeName" 
 : 
 string 
 , 
 "destination" 
 : 
 string 
 , 
 "description" 
 : 
 string 
 , 
 "detail" 
 : 
 string 
 , 
 "documentation" 
 : 
 string 
 , 
 "applicableCountries" 
 : 
 [ 
 string 
 ] 
 }
    Fields
    code

    string

    The error code of the issue.
    servability

    string

    How this issue affects the serving of the collection.
    resolution

    string

    Whether the issue can be resolved by the merchant.
    attributeName

    string

    The attribute's name, if the issue is caused by a single attribute.
    destination

    string

    The destination the issue applies to.
    description

    string

    A short issue description in English.
    detail

    string

    A detailed issue description in English.
    documentation

    string

    The URL of a web page to help with resolving this issue.
    applicableCountries[]

    string

    Country codes (ISO 3166-1 alpha-2) where issue applies to the offer.

    Methods

    get

    		Gets the status of a collection from your Merchant Center account.

    list

    		Lists the statuses of the collections in your Merchant Center account.
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: