Method: accounts.custombatch

    • Allows for retrieving, inserting, updating, and deleting multiple Merchant Center (sub-)accounts through a single POST request to the specified endpoint.

    • The request body must contain an AccountsCustomBatchRequest object specifying the desired operations on the accounts.

    • Each operation within the batch is represented by an AccountsCustomBatchRequestEntry , detailing the action, target account, and related data.

    • The response includes an AccountsCustomBatchResponse with individual AccountsCustomBatchResponseEntry objects for each operation, indicating success or errors encountered.

    • Proper authorization with the content scope is required to use this functionality.

    Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request.

    HTTP request

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

    Request body

    The request body contains an instance of AccountsCustomBatchRequest .

    Response body

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

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

    object ( AccountsCustomBatchResponseEntry )

    The result of the execution of the batch requests.
    kind

    string

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

    Authorization scopes

    Requires one of the following OAuth scopes:

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

    For more information, see the OAuth 2.0 Overview .

    AccountsCustomBatchRequest

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

    object ( AccountsCustomBatchRequestEntry )

    The request entries to be processed in the batch.

    AccountsCustomBatchRequestEntry

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

    JSON representation 
     { 
 "batchId" 
 : 
 integer 
 , 
 "merchantId" 
 : 
 string 
 , 
 "method" 
 : 
 string 
 , 
 "accountId" 
 : 
 string 
 , 
 "account" 
 : 
 { 
 object (  Account 
 
) 
 } 
 , 
 "overwrite" 
 : 
 boolean 
 , 
 "force" 
 : 
 boolean 
 , 
 "linkRequest" 
 : 
 { 
 object (  AccountsCustomBatchRequestEntryLinkRequest 
 
) 
 } 
 , 
 "view" 
 : 
 string 
 , 
 "labelIds" 
 : 
 [ 
 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:

    • " claimWebsite "
    • " delete "
    • " get "
    • " insert "
    • " link "
    • " update "
    accountId

    string

    The ID of the targeted account. Only defined if the method is not insert .

    account

    object ( Account )

    The account to create or update. Only defined if the method is insert or update .

    overwrite

    boolean

    Only applicable if the method is claimwebsite . Indicates whether or not to take the claim from another account in case there is a conflict.

    force

    boolean

    Whether the account should be deleted if the account has offers. Only applicable if the method is delete .

    view

    string

    Controls which fields are visible. Only applicable if the method is 'get'.

    labelIds[]

    string

    Label IDs for the 'updatelabels' request.

    AccountsCustomBatchRequestEntryLinkRequest

    JSON representation 
     { 
 "action" 
 : 
 string 
 , 
 "linkedAccountId" 
 : 
 string 
 , 
 "linkType" 
 : 
 string 
 , 
 "services" 
 : 
 [ 
 string 
 ] 
 }
    Fields
    action

    string

    Action to perform for this link. The "request" action is only available to select merchants.

    Acceptable values are:

    • " approve "
    • " remove "
    • " request "
    services[]

    string

    Provided services.

    Acceptable values are:

    • " shoppingAdsProductManagement "
    • " shoppingActionsProductManagement "
    • " shoppingActionsOrderManagement "
    • " paymentProcessing "
    • " localProductManagement "

    AccountsCustomBatchResponseEntry

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

    JSON representation 
     { 
 "batchId" 
 : 
 integer 
 , 
 "kind" 
 : 
 string 
 , 
 "account" 
 : 
 { 
 object (  Account 
 
) 
 } 
 , 
 "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#accountsCustomBatchResponseEntry "
    account

    object ( Account )

    The retrieved, created, or updated account. Not defined if the method was delete , claimwebsite or link .
    errors

    object ( Errors )

    A list of errors for failed custombatch entries.

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