Method: projects.locations.collections.engines.analytics.exportMetrics

Exporta métricas.

Solicitud HTTP


POST https://discoveryengine.googleapis.com/v1alpha/{analytics=projects/*/locations/*/collections/*/engines/*/analytics}:exportMetrics

Las URL usan la sintaxis de transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
analytics

string

Obligatorio. Es el nombre del recurso de Analytics en el motor en el que se crean las métricas. El formato es projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/analytics.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON 
{
  "outputConfig": {
    object (OutputConfig)
  },
  "startDate": {
    object (Date)
  }
}
Campos
outputConfig

object (OutputConfig)

Obligatorio. Ubicación de salida de los datos.
startDate

object (Date)

Es opcional. Es la fecha más antigua (inclusive), interpretada en la zona horaria UTC, cuyas métricas se incluyen en la exportación.

Si no se configura, el valor predeterminado es 30 días antes de la fecha actual en UTC. El valor debe ser una fecha de calendario válida que no sea futura y que no tenga más de 180 días (el período de retención de datos de origen); de lo contrario, la solicitud fallará con INVALID_ARGUMENT.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de Operation.

Alcances de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.

OutputConfig

Es el parámetro de configuración de salida.

Representación JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "bigqueryDestination": {
    object (BigQueryDestination)
  }
  // End of mutually exclusive fields.
}
Campos
Es la configuración del destino para almacenar los datos de salida. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
bigqueryDestination

object (BigQueryDestination)

Ubicación de BigQuery en la que se escribirá el resultado.
Fin de los campos mutuamente excluyentes.

BigQueryDestination

Es la configuración del destino de salida de BigQuery.

Representación JSON 
{
  "datasetId": string,
  "tableId": string
}
Campos
datasetId

string

Obligatorio. Es el ID de un conjunto de datos de BigQuery.
tableId

string

Obligatorio. Es el tableId de la tabla de BigQuery exportada.