Products: custombatch

Requires authorization

Retrieves, inserts, and deletes multiple products in a single request. Try it now.

Request

HTTP request

POST https://www.googleapis.com/content/v2/products/batch

Parameters

Parameter name Value Description
Optional query parameters
dryRun boolean Flag to run the request in dry-run mode.

Authorization

This request requires authorization with the following scope (read more about authentication and authorization).

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

Request body

In the request body, supply data with the following structure:

JSON

{
  "entries": [
    {
      "batchId": unsigned integer,
      "merchantId": unsigned long,
      "method": string,
      "productId": string,
      "product": products Resource
    }
  ]
}
Property name Value Description Notes
entries[] list The request entries to be processed in the batch.
entries[].batchId unsigned integer An entry ID, unique within the batch request.
entries[].merchantId unsigned long The ID of the managing account.
entries[].method string

Acceptable values are:
  • "delete"
  • "get"
  • "insert"
entries[].productId string The ID of the product to get or delete. Only defined if the method is get or delete.
entries[].product nested object The product to insert. Only required if the method is insert.

XML

<batch>
  (foreach)
    <entry batch_id="unsigned integer" method="string">
      <merchant_id>
        unsigned long
      </merchant_id>
      <product_id>
        string
      </product_id>
      products Resource
    </entry>
  (/foreach)
</batch>
Property name Value Description Notes
batch object
batch/entry object A batch entry encoding a single non-batch products request.
batch/entry/batch_id unsigned integer An entry ID, unique within the batch request.
batch/entry/method string The method of the batch entry.

Acceptable values are:
  • "delete"
  • "get"
  • "insert"
batch/entry/merchant_id unsigned long The ID of the managing account.
batch/entry/product_id string The ID of the product to get or delete. Only defined if the method is get or delete.
batch/entry/product nested object The product to insert. Only required if the method is insert. Product data.

Response

If successful, this method returns a response body with the following structure:

JSON

{
  "kind": "content#productsCustomBatchResponse",
  "entries": [
    {
      "kind": "content#productsCustomBatchResponseEntry",
      "batchId": unsigned integer,
      "product": products Resource,
      "errors": {
        "errors": [
          {
            "domain": string,
            "reason": string,
            "message": string
          }
        ],
        "code": unsigned integer,
        "message": string
      }
    }
  ]
}
Property name Value Description Notes
kind string Identifies what kind of resource this is. Value: the fixed string "content#productsCustomBatchResponse".
entries[] list The result of the execution of the batch requests.
entries[].kind string Identifies what kind of resource this is. Value: the fixed string "content#productsCustomBatchResponseEntry".
entries[].batchId unsigned integer The ID of the request entry this entry responds to.
entries[].product nested object The inserted product. Only defined if the method is insert and if the request was successful.
entries[].errors nested object A list of errors defined if and only if the request failed.
entries[].errors.errors[] list A list of errors.
entries[].errors.errors[].domain string The domain of the error.
entries[].errors.errors[].reason string The error code.
entries[].errors.errors[].message string A description of the error.
entries[].errors.code unsigned integer The HTTP status of the first error in errors.
entries[].errors.message string The message of the first error in errors.

XML

<batch>
  (foreach)
    <entry batch_id="unsigned integer">
      products Resource
      <errors xmlns="http://schemas.google.com/g/2005">
        (foreach)
          <error>
            <domain>
              GData
              string
            </domain>
            <code>
              string
            </code>
            <internalReason>
              string
            </internalReason>
          </error>
        (/foreach)
      </errors>
    </entry>
  (/foreach)
</batch>
Property name Value Description Notes
batch object
batch/entry object A batch entry encoding a single non-batch products response.
batch/entry/batch_id unsigned integer The ID of the request entry this entry responds to.
batch/entry/product nested object The inserted product. Only defined if the method is insert and if the request was successful. Product data.
batch/entry/errors nested object A list of errors defined if and only if the request failed. A list of errors returned by a failed batch entry.
batch/entry/errors/error object A list of errors. An error returned by the API.
batch/entry/errors/error/domain string The domain of the error.
batch/entry/errors/error/code string The error code.
batch/entry/errors/error/internalReason string A description of the error.

Try it!

Use the APIs Explorer below to call this method on live data and see the response.

Send feedback about...

Content API for Shopping