Method: projects.locations.queryConfigurablePricingUsageStats

Consulta las estadísticas de uso de los precios configurables de las consultas para un proyecto.

Solicitud HTTP

GET https://discoveryengine.googleapis.com/v1alpha/{project=projects/*}/locations/{location}:queryConfigurablePricingUsageStats

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta

Parámetros
project

string

Obligatorio. Es el proyecto para el que se consultan las estadísticas de uso. Formato: projects/{project}
location

string

Obligatorio. Es la ubicación para la que se consultan las estadísticas de uso.

Parámetros de consulta

Parámetros
timeRange

object (TimeRange)

Es opcional. Es el período de la agregación de uso. Si no se establece endDate, se usará la fecha actual de forma predeterminada. Si no se establece startDate, el valor predeterminado es 30 días antes de endDate.
metricTypes[]

enum (BillingMetricType)

Es opcional. Son los tipos de métricas para los que se devolverá el uso.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Es la respuesta para el método [ProjectService.QueryConfigurablePricingUsageStats].

Si se ejecuta correctamente, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON 
{
  "metricUsages": [
    {
      object (MetricUsage)
    }
  ]
}
Campos
metricUsages[]

object (MetricUsage)

Es una lista de usos de métricas, uno para cada tipo de recurso solicitado que tiene datos en el período solicitado.

Permisos 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

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

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso project:

  • discoveryengine.projects.get

Para obtener más información, consulta la documentación de IAM.

TimeRange

Es el período de la agregación de uso.

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

object (Date)

Es opcional. Es la fecha de inicio inclusiva de la agregación del uso.
endDate

object (Date)

Es opcional. Es la fecha de finalización inclusiva de la agregación del uso.

BillingMetricType

Es el tipo de métrica de facturación para las estadísticas de uso.

Enums
BILLING_METRIC_TYPE_UNSPECIFIED Valor predeterminado.
DAILY_MDN_QPM Es la mediana diaria de las QPM de las solicitudes de búsqueda.
DAILY_MIN_QPM Es el QPM mínimo diario de solicitudes de búsqueda.
DAILY_MAX_QPM Es el valor de QPM máximo diario de las solicitudes de búsqueda.
DAILY_SEARCH_REQUEST Es el total de solicitudes de búsqueda diarias.
TOTAL_STORAGE Es la cantidad total de bytes de almacenamiento para el núcleo de indexación.

MetricUsage

Es el uso de una métrica durante una lista de días.

Representación JSON 
{
  "metricType": enum (BillingMetricType),
  "datedUsages": [
    {
      object (DatedUsage)
    }
  ],
  "totalUsage": number
}
Campos
metricType

enum (BillingMetricType)

Es el tipo de métrica.
datedUsages[]

object (DatedUsage)

Es la lista de usos de este tipo de recurso, ordenada cronológicamente por fecha. Este campo se completa para las métricas con agregación diaria, como DAILY_MDN_QPM.
totalUsage

number

Es el uso total de este tipo de recurso. Este campo se completa para métricas como TOTAL_STORAGE.

DatedUsage

Es una lista de usos para un día específico.

Representación JSON 
{
  "date": {
    object (Date)
  },
  "usage": number
}
Campos
date

object (Date)

Fecha de uso.
usage

number

Es el valor de uso en la fecha.