Method: domains.trafficStats.list
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Muestra las estadísticas de tráfico de 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
Es el nombre del recurso del dominio cuyas estadísticas de tráfico queremos enumerar. Debe tener el formato domains/{domain_name} , en el que nombre_dominio es el nombre de dominio completamente calificado.
|
Parámetros de consulta
Parámetros |
startDate |
object (Date )
Es el día más antiguo de las métricas que se recuperarán de forma inclusiva. Se deben especificar startDate y endDate, o bien no especificarlos. Si solo se especifica uno, o si endDate es anterior a startDate, se muestra INVALID_ARGUMENT.
|
endDate |
object (Date )
Es el día más reciente de las métricas que se recuperarán de forma exclusiva. Se deben especificar startDate y endDate, o bien no se deben especificar. Si solo se especifica uno, o si endDate es anterior a startDate, se muestra INVALID_ARGUMENT.
|
pageSize |
integer
Indica el tamaño de la página solicitada. Es posible que el servidor devuelva menos objetos TrafficStats de los solicitados. Si no se especifica, el servidor elegirá una configuración predeterminada adecuada.
|
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 de 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 son insignificantes. La fecha está relacionada con el calendario gregoriano. Puede representar una de las siguientes opciones:
- Una fecha completa con valores para el año, mes y día que no sean cero.
- Un mes y un día, con cero año (por ejemplo, un aniversario).
- Un año por sí 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 ser entre 1 y 9,999, o bien 0 para especificar una fecha sin año.
|
month |
integer
Mes del año. Debe ser del 1 al 12 o 0 para especificar un año sin un mes ni un día.
|
day |
integer
Día del mes. Debe ser entre 1 y 31 y ser válido para el año y el mes o bien 0 para especificar un año solo o un año y un mes en los que el día no sea significativo.
|
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-07-25 (UTC)
[null,null,["Última actualización: 2025-07-25 (UTC)"],[],[],null,["# Method: domains.trafficStats.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListTrafficStatsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Date](#Date)\n - [JSON representation](#Date.SCHEMA_REPRESENTATION)\n- [Try it!](#try-it)\n\nList traffic statistics for all available days. Returns PERMISSION_DENIED if user does not have permission to access TrafficStats for the domain.\n\n### HTTP request\n\n`GET https://gmailpostmastertools.googleapis.com/v1/{parent=domains/*}/trafficStats`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `parent` | `string` The resource name of the domain whose traffic statistics we'd like to list. It should have the form `domains/{domain_name}`, where domain_name is the fully qualified domain name. |\n\n### Query parameters\n\n| Parameters ||\n|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `startDate` | `object (`[Date](/workspace/gmail/postmaster/reference/rest/v1/domains.trafficStats/list#Date)`)` The earliest day of the metrics to retrieve inclusive. startDate and endDate must both be specified or both left unspecified. If only one is specified, or endDate is earlier in time than startDate, then INVALID_ARGUMENT is returned. |\n| `endDate` | `object (`[Date](/workspace/gmail/postmaster/reference/rest/v1/domains.trafficStats/list#Date)`)` The most recent day of the metrics to retrieve exclusive. startDate and endDate must both be specified or both left unspecified. If only one is specified, or endDate is earlier in time than startDate, then INVALID_ARGUMENT is returned. |\n| `pageSize` | `integer` Requested page size. Server may return fewer TrafficStats than requested. If unspecified, server will pick an appropriate default. |\n| `pageToken` | `string` The nextPageToken value returned from a previous List request, if any. This is the value of [ListTrafficStatsResponse.next_page_token](/workspace/gmail/postmaster/reference/rest/v1/domains.trafficStats/list#body.ListTrafficStatsResponse.FIELDS.next_page_token) returned from the previous call to `trafficStats.list` method. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse message for trafficStats.list.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"trafficStats\": [ { object (/workspace/gmail/postmaster/reference/rest/v1/domains.trafficStats#TrafficStats) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|------------------|----------------------------------------------------------------------------------------------------------------------------------------|\n| `trafficStats[]` | `object (`[TrafficStats](/workspace/gmail/postmaster/reference/rest/v1/domains.trafficStats#TrafficStats)`)` The list of TrafficStats. |\n| `nextPageToken` | `string` Token to retrieve the next page of results, or empty if there are no more results in the list. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/postmaster.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent).\n\nDate\n----\n\nRepresents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:\n\n- A full date, with non-zero year, month, and day values.\n- A month and day, with a zero year (for example, an anniversary).\n- A year on its own, with a zero month and a zero day.\n- A year and month, with a zero day (for example, a credit card expiration date).\n\nRelated types:\n\n- `google.type.TimeOfDay`\n- `google.type.DateTime`\n- [google.protobuf.Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)\n\n| JSON representation |\n|---------------------------------------------------------------|\n| ``` { \"year\": integer, \"month\": integer, \"day\": integer } ``` |\n\n| Fields ||\n|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `year` | `integer` Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. |\n| `month` | `integer` Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. |\n| `day` | `integer` Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. |"]]