Method: accountstatuses.custombatch

    • Retrieves the status of multiple Merchant Center accounts through a single batch request.

    • The request body should contain an AccountstatusesCustomBatchRequest object with details of the accounts.

    • The response includes an array of AccountstatusesCustomBatchResponseEntry objects, each containing the status of an individual account or errors encountered.

    • Utilizes the POST method and requires authorization with the https://www.googleapis.com/auth/content scope.

    Retrieves multiple Merchant Center account statuses in a single request.

    HTTP request

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

    Request body

    The request body contains an instance of AccountstatusesCustomBatchRequest .

    Response body

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

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

    object ( AccountstatusesCustomBatchResponseEntry )

    The result of the execution of the batch requests.
    kind

    string

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

    Authorization scopes

    Requires one of the following OAuth scopes:

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

    For more information, see the OAuth 2.0 Overview .

    AccountstatusesCustomBatchRequest

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

    object ( AccountstatusesCustomBatchRequestEntry )

    The request entries to be processed in the batch.

    AccountstatusesCustomBatchRequestEntry

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

    JSON representation 
     { 
 "batchId" 
 : 
 integer 
 , 
 "merchantId" 
 : 
 string 
 , 
 "method" 
 : 
 string 
 , 
 "accountId" 
 : 
 string 
 , 
 "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 "
    accountId

    string

    The ID of the (sub-)account whose status to get.

    destinations[]

    string

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

    AccountstatusesCustomBatchResponseEntry

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

    JSON representation 
     { 
 "batchId" 
 : 
 integer 
 , 
 "accountStatus" 
 : 
 { 
 object (  AccountStatus 
 
) 
 } 
 , 
 "errors" 
 : 
 { 
 object (  Errors 
 
) 
 } 
 }
    Fields
    batchId

    integer ( uint32 format)

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

    object ( AccountStatus )

    The requested account status. Defined if and only if the request was successful.
    errors

    object ( Errors )

    A list of errors for failed custombatch entries.

    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: