This is the documentation for Recommendations AI only. To try Retail Search and the unified Retail console in the restricted GA phase, contact Cloud sales. If you are not planning to use Retail Search, remain on the Recommendations console until further notice.

If you are using the v1beta version of Recommendations AI, migrate to the Retail API version.

Method: projects.locations.catalogs.completionData.import

Bulk import of processed completion dataset.

Request processing may be synchronous. Partial updating is not supported.

This feature is only available for users who have Retail placements.search enabled. Please submit a form here to contact cloud sales if you are interested in using Retail placements.search.

HTTP request

POST https://retail.googleapis.com/v2/{parent=projects/*/locations/*/catalogs/*}/completionData:import

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The catalog which the suggestions dataset belongs to.

Format: projects/1234/locations/global/catalogs/default_catalog.

Request body

The request body contains data with the following structure:

JSON representation
{
  "inputConfig": {
    object (CompletionDataInputConfig)
  },
  "notificationPubsubTopic": string
}
Fields
inputConfig

object (CompletionDataInputConfig)

Required. The desired input location of the data.

notificationPubsubTopic

string

Pub/Sub topic for receiving notification. If this field is set, when the import is finished, a notification will be sent to specified Pub/Sub topic. The message data will be JSON string of a Operation. Format of the Pub/Sub topic is projects/{project}/topics/{topic}.

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.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • retail.catalogs.import

For more information, see the IAM documentation.

CompletionDataInputConfig

The input config source for completion data.

JSON representation
{
  "bigQuerySource": {
    object (BigQuerySource)
  }
}
Fields
bigQuerySource

object (BigQuerySource)

Required. BigQuery input source.

Add the IAM permission "BigQuery Data Viewer" for cloud-retail-customer-data-access@system.gserviceaccount.com before using this feature otherwise an error is thrown.