Method: productstatuses.custombatch

    • Use this batch service to retrieve the statuses of multiple products in a single request.

    • The request body utilizes ProductstatusesCustomBatchRequest containing individual product requests.

    • The response body includes an array of ProductstatusesCustomBatchResponseEntry , each detailing a product's status.

    • This service requires authorization with the https://www.googleapis.com/auth/content scope.

    Gets the statuses of multiple products in a single request.

    HTTP request

    POST https://shoppingcontent.googleapis.com/content/v2.1/productstatuses/batch

    Request body

    The request body contains an instance of ProductstatusesCustomBatchRequest .

    Response body

    If successful, the response body contains data with the following structure:

    JSON representation 
     { 
 "entries" 
 : 
 [ 
 { 
 object (  ProductstatusesCustomBatchResponseEntry 
 
) 
 } 
 ] 
 , 
 "kind" 
 : 
 string 
 }
    Fields
    entries[]

    object ( ProductstatusesCustomBatchResponseEntry )

    The result of the execution of the batch requests.
    kind

    string

    Identifies what kind of resource this is. Value: the fixed string " content#productstatusesCustomBatchResponse ".

    Authorization scopes

    Requires one of the following OAuth scopes:

    • https://www.googleapis.com/auth/content

    For more information, see the OAuth 2.0 Overview .

    ProductstatusesCustomBatchRequest

    JSON representation 
     { 
 "entries" 
 : 
 [ 
 { 
 object (  ProductstatusesCustomBatchRequestEntry 
 
) 
 } 
 ] 
 }
    Fields
    entries[]

    object ( ProductstatusesCustomBatchRequestEntry )

    The request entries to be processed in the batch.

    ProductstatusesCustomBatchRequestEntry

    A batch entry encoding a single non-batch productstatuses request.

    JSON representation 
     { 
 "batchId" 
 : 
 integer 
 , 
 "merchantId" 
 : 
 string 
 , 
 "method" 
 : 
 string 
 , 
 "productId" 
 : 
 string 
 , 
 "includeAttributes" 
 : 
 boolean 
 , 
 "destinations" 
 : 
 [ 
 string 
 ] 
 }
    Fields
    batchId

    integer ( uint32 format)

    An entry ID, unique within the batch request.

    merchantId

    string

    The ID of the managing account.

    method

    string

    The method of the batch entry.

    Acceptable values are:

    • " get "
    productId

    string

    The ID of the product whose status to get.

    includeAttributes
    (deprecated)

    boolean

    Deprecated: Setting this field has no effect and attributes are never included.

    destinations[]

    string

    If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.

    ProductstatusesCustomBatchResponseEntry

    A batch entry encoding a single non-batch productstatuses response.

    JSON representation 
     { 
 "batchId" 
 : 
 integer 
 , 
 "kind" 
 : 
 string 
 , 
 "productStatus" 
 : 
 { 
 object (  ProductStatus 
 
) 
 } 
 , 
 "errors" 
 : 
 { 
 object (  Errors 
 
) 
 } 
 }
    Fields
    batchId

    integer ( uint32 format)

    The ID of the request entry this entry responds to.
    kind

    string

    Identifies what kind of resource this is. Value: the fixed string " content#productstatusesCustomBatchResponseEntry "
    productStatus

    object ( ProductStatus )

    The requested product status. Only defined if the request was successful.
    errors

    object ( Errors )

    A list of errors for failed custombatch entries.

    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: