Important: There is a newer version of this product and documentation. You are currently viewing documentation for the beta version Recommendations AI.

We recommend migrating your recommendations to the GA Retail API (service endpoint https://retail.googleapis.com). The Recommendations Engine beta API (service endpoint https://recommendationengine.googleapis.com) and this documentation set remain available, but they will no longer be updated. See the new documentation:

InputConfig

The input config source.

JSON representation
{

  // Union field source can be only one of the following:
  "catalogInlineSource": {
    object (CatalogInlineSource)
  },
  "gcsSource": {
    object (GcsSource)
  },
  "userEventInlineSource": {
    object (UserEventInlineSource)
  },
  "bigQuerySource": {
    object (BigQuerySource)
  }
  // End of list of possible types for union field source.
}
Fields
Union field source. Required. The source of the input. source can be only one of the following:
catalogInlineSource

object (CatalogInlineSource)

The Inline source for the input content for Catalog items.

gcsSource

object (GcsSource)

Google Cloud Storage location for the input content.

userEventInlineSource

object (UserEventInlineSource)

The Inline source for the input content for UserEvents.

bigQuerySource

object (BigQuerySource)

BigQuery input source.

CatalogInlineSource

The inline source for the input config for catalogItems.import method.

JSON representation
{
  "catalogItems": [
    {
      object (CatalogItem)
    }
  ]
}
Fields
catalogItems[]

object (CatalogItem)

Optional. A list of catalog items to update/create. Recommended max of 10k items.

GcsSource

Google Cloud Storage location for input content. format.

JSON representation
{
  "inputUris": [
    string
  ],
  "jsonSchema": string
}
Fields
inputUris[]

string

Required. Google Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, gs://bucket/directory/object.json) or a pattern matching one or more files, such as gs://bucket/directory/*.json. A request can contain at most 100 files, and each file can be up to 2 GB. See Importing catalog information for the expected file format and setup instructions.

jsonSchema

string

Optional. The schema to use when parsing the data from the source.

Supported values for catalog imports:

1: "catalog_recommendations_ai" using https://cloud.google.com/recommendations-ai/docs/upload-catalog#json (Default for catalogItems.import)

2: "catalog_merchant_center" using https://cloud.google.com/recommendations-ai/docs/upload-catalog#mc

Supported values for user events imports:

1: "user_events_recommendations_ai" using https://cloud.google.com/recommendations-ai/docs/manage-user-events#import (Default for userEvents.import)

  1. "user_events_ga360" using https://support.google.com/analytics/answer/3437719?hl=en

UserEventInlineSource

The inline source for the input config for userEvents.import method.

JSON representation
{
  "userEvents": [
    {
      object (UserEvent)
    }
  ]
}
Fields
userEvents[]

object (UserEvent)

Optional. A list of user events to import. Recommended max of 10k items.

BigQuerySource

BigQuery source import data from.

JSON representation
{
  "projectId": string,
  "datasetId": string,
  "tableId": string,
  "gcsStagingDir": string,
  "dataSchema": string
}
Fields
projectId

string

Optional. The project id (can be project # or id) that the BigQuery source is in. If not specified, inherits the project id from the parent request.

datasetId

string

Required. The BigQuery data set to copy the data from.

tableId

string

Required. The BigQuery table to copy the data from.

gcsStagingDir

string

Optional. Intermediate Cloud Storage directory used for the import. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory.

dataSchema

string

Optional. The schema to use when parsing the data from the source.

Supported values for catalog imports:

1: "catalog_recommendations_ai" using https://cloud.google.com/recommendations-ai/docs/upload-catalog#json (Default for catalogItems.import)

2: "catalog_merchant_center" using https://cloud.google.com/recommendations-ai/docs/upload-catalog#mc

Supported values for user event imports:

1: "user_events_recommendations_ai" using https://cloud.google.com/recommendations-ai/docs/manage-user-events#import (Default for userEvents.import)

  1. "user_events_ga360" using https://support.google.com/analytics/answer/3437719?hl=en