Important: There is a newer version of this product and documentation. You are currently viewing the v1beta1 Recommendations Engine API documentation, which remains available but will no longer be updated.

See Migrating to the Retail API from beta in the new documentation.

Method: projects.locations.catalogs.catalogItems.import

Stay organized with collections Save and categorize content based on your preferences.

Bulk import of multiple catalog items. Request processing may be synchronous. No partial updating supported. Non-existing items will be created.

Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully updated.

HTTP request

POST https://recommendationengine.googleapis.com/v1beta1/{parent=projects/*/locations/*/catalogs/*}/catalogItems:import

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. projects/1234/locations/global/catalogs/default_catalog

If no updateMask is specified, requires catalogItems.create permission. If updateMask is specified, requires catalogItems.update permission.

Authorization requires one or more of the following IAM permissions on the specified resource parent:

  • automlrecommendations.catalogItems.create
  • automlrecommendations.catalogItems.update

Request body

The request body contains data with the following structure:

JSON representation
{
  "requestId": string,
  "inputConfig": {
    object (InputConfig)
  },
  "errorsConfig": {
    object (ImportErrorsConfig)
  },
  "updateMask": string
}
Fields
requestId

string

Optional. Unique identifier provided by client, within the ancestor dataset scope. Ensures idempotency and used for request deduplication. Server-generated if unspecified. Up to 128 characters long. This is returned as google.longrunning.Operation.name in the response.

inputConfig

object (InputConfig)

Required. The desired input location of the data.

errorsConfig

object (ImportErrorsConfig)

Optional. The desired location of errors incurred during the Import.

updateMask

string (FieldMask format)

Optional. Indicates which fields in the provided imported 'items' to update. If not set, will by default update all fields.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Response body

If successful, the response body contains an instance of Operation.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.