Retail is being renamed to Vertex AI Search for retail. We are in the process of updating content to reflect the new branding.

Method: projects.locations.catalogs.exportAnalyticsMetrics

Exports analytics metrics.

Operation.response is of type ExportAnalyticsMetricsResponse. Operation.metadata is of type ExportMetadata.

HTTP request

POST https://retail.googleapis.com/v2/{catalog=projects/*/locations/*/catalogs/*}:exportAnalyticsMetrics

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters

Parameters
`catalog`	`string` Required. Full resource name of the parent catalog. Expected format: `projects//locations//catalogs/*`

catalog

string

Required. Full resource name of the parent catalog. Expected format: projects/*/locations/*/catalogs/*

Request body

The request body contains data with the following structure:

JSON representation
{ "outputConfig": { object (`OutputConfig`) }, "filter": string }

Fields

Fields
`outputConfig`	`object (OutputConfig)` Required. The output location of the data.
`filter`	`string` A filtering expression to specify restrictions on returned metrics. The expression is a sequence of terms. Each term applies a restriction to the returned metrics. Use this expression to restrict results to a specific time range. Currently we expect only one types of fields: `timestamp`: This can be specified twice, once with a less than operator and once with a greater than operator. The `timestamp` restriction should result in one, contiguous, valid, `timestamp` range. Some examples of valid filters expressions: Example 1: `timestamp > "2012-04-23T18:25:43.511Z" timestamp < "2012-04-23T18:30:43.511Z"` Example 2: `timestamp > "2012-04-23T18:25:43.511Z"`

outputConfig

object (OutputConfig)

Required. The output location of the data.

filter

string

A filtering expression to specify restrictions on returned metrics. The expression is a sequence of terms. Each term applies a restriction to the returned metrics. Use this expression to restrict results to a specific time range.

Currently we expect only one types of fields:

timestamp: This can be specified twice, once with a less than operator and once with a greater than operator. The timestamp restriction should result in one, contiguous, valid, timestamp range.

Some examples of valid filters expressions:

Example 1: timestamp > "2012-04-23T18:25:43.511Z" timestamp < "2012-04-23T18:30:43.511Z"
Example 2: timestamp > "2012-04-23T18:25:43.511Z"

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 catalog resource:

retail.catalogs.exportAnalyticsMetrics

For more information, see the IAM documentation.

OutputConfig

The output configuration setting.

JSON representation

JSON representation
{ // Union field `destination` can be only one of the following: "gcsDestination": { object (`GcsDestination`) }, "bigqueryDestination": { object (`BigQueryDestination`) } // End of list of possible types for union field `destination`. }

{

  // Union field destination can be only one of the following:
  "gcsDestination": {
    object (GcsDestination)
  },
  "bigqueryDestination": {
    object (BigQueryDestination)
  }
  // End of list of possible types for union field destination.
}

Fields

Fields
Union field `destination`. The configuration of destination for holding output data. `destination` can be only one of the following:
`gcsDestination`	`object (GcsDestination)` The Google Cloud Storage location where the output is to be written to.
`bigqueryDestination`	`object (BigQueryDestination)` The BigQuery location where the output is to be written to.

Union field destination. The configuration of destination for holding output data. destination can be only one of the following:

gcsDestination

object (GcsDestination)

The Google Cloud Storage location where the output is to be written to.

bigqueryDestination

object (BigQueryDestination)

The BigQuery location where the output is to be written to.

GcsDestination

The Google Cloud Storage output destination configuration.

JSON representation
{ "outputUriPrefix": string }

Fields

Fields
`outputUriPrefix`	`string` Required. The output uri prefix for saving output data to json files. Some mapping examples are as follows: outputUriPrefix sample output(assuming the object is foo.json) ======================== ============================================= gs://bucket/ gs://bucket/foo.json gs://bucket/folder/ gs://bucket/folder/foo.json gs://bucket/folder/item_ gs://bucket/folder/item_foo.json

outputUriPrefix

string

Required. The output uri prefix for saving output data to json files. Some mapping examples are as follows: outputUriPrefix sample output(assuming the object is foo.json) ======================== ============================================= gs://bucket/ gs://bucket/foo.json gs://bucket/folder/ gs://bucket/folder/foo.json gs://bucket/folder/item_ gs://bucket/folder/item_foo.json

BigQueryDestination

The BigQuery output destination configuration.

JSON representation
{ "datasetId": string, "tableIdPrefix": string, "tableType": string }

Fields

Fields
`datasetId`	`string` Required. The ID of a BigQuery Dataset.
`tableIdPrefix`	`string` Required. The prefix of exported BigQuery tables.
`tableType`	`string` Required. Describes the table type. The following values are supported: `table`: A BigQuery native table. `view`: A virtual table defined by a SQL query.

datasetId

string

Required. The ID of a BigQuery Dataset.

tableIdPrefix

string

Required. The prefix of exported BigQuery tables.

tableType

string

Required. Describes the table type. The following values are supported:

table: A BigQuery native table.
view: A virtual table defined by a SQL query.