Method: domains.trafficStats.list

Muestra estadísticas de tráfico para todos los días disponibles. Muestra PERMISSION_DENIED si el usuario no tiene permiso para acceder a TrafficStats del dominio.

Solicitud HTTP

GET https://gmailpostmastertools.googleapis.com/v1/{parent=domains/*}/trafficStats

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

Parámetros de ruta de acceso

Parámetros
parent

string

El nombre del recurso del dominio de cuyas estadísticas de tráfico queremos enumerar. Debería tener el formato domains/{domain_name}, en el que el dominio_name es el nombre de dominio completamente calificado.

Parámetros de consulta

Parámetros
startDate

object (Date)

El primer día de las métricas que se recuperarán (inclusive). Se deben especificar startDate y endDate, o bien ambas no se deben especificar. Si solo se especifica una, o endDate es anterior a la hora de inicio, se muestra INVALID_ATTRIBUTE.
endDate

object (Date)

El día más reciente de las métricas para recuperar de forma exclusiva. Se deben especificar startDate y endDate, o bien ambas no se deben especificar. Si solo se especifica una, o endDate es anterior a la hora de inicio, se muestra INVALID_ATTRIBUTE.
pageSize

integer

Indica el tamaño de la página solicitada. Es posible que el servidor muestre menos TrafficStats de lo solicitado. Si no se especifica, el servidor elegirá un valor predeterminado apropiado.
pageToken

string

El valor nextPageToken que se muestra de una solicitud de lista previa, si existe. Este es el valor de ListTrafficStatsResponse.next_page_token que se muestra en la llamada anterior al método trafficStats.list.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Mensaje de respuesta para trafficStats.list.

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

Representación JSON 
{
  "trafficStats": [
    {
      object (TrafficStats)
    }
  ],
  "nextPageToken": string
}
Campos
trafficStats[]

object (TrafficStats)

La lista de TrafficStats.
nextPageToken

string

Token para recuperar la página siguiente de resultados o vaciar si no hay más resultados en la lista.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/postmaster.readonly

Para obtener más información, consulta la guía de autorización.

Fecha

Representa una fecha de calendario completa o parcial, como un cumpleaños. La hora del día y la zona horaria se especifican en otro lugar o no son significativas. La fecha está relacionada con el calendario gregoriano. Esto puede representar una de las siguientes opciones:

  • Una fecha completa con valores de año, mes y día que no sean cero
  • Es un mes y un día con un año cero (por ejemplo, un aniversario).
  • Un año solo, con un mes cero y un día cero.
  • Es un año y un mes, con un día cero (por ejemplo, la fecha de vencimiento de una tarjeta de crédito).

Tipos relacionados:

Representación JSON 
{
  "year": integer,
  "month": integer,
  "day": integer
}
Campos
year

integer

Año de la fecha. Debe encontrarse entre 1 y 9999, o bien entre 0 para especificar una fecha sin año.
month

integer

Mes del año Debe encontrarse entre 1 y 12, o bien 0 para especificar un año sin mes ni día.
day

integer

Día del mes. Debe encontrarse entre 1 y 31 y ser válido para el año y el mes, o bien 0 para especificar solo un año o un año y mes en los que el día no sea importante.