Method: domains.trafficStats.list

Listar estatísticas de tráfego para todos os dias disponíveis. Retorna PERMISSION_DENIED se o usuário não tiver permissão para acessar as estatísticas de tráfego do domínio.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
parent

string

O nome do recurso do domínio de estatísticas de tráfego que você quer listar. Ele precisa ter o formato domains/{domain_name}, em que domain_name é o nome de domínio totalmente qualificado.

Parâmetros de consulta

Parâmetros
startDate

object (Date)

O primeiro dia das métricas a serem extraídas, inclusive. startDate e endDate precisam ser especificados ou não especificados. Se apenas um deles for especificado ou se endDate for anterior a startDate, INVALID_ARGUMENT será retornado.
endDate

object (Date)

O dia mais recente das métricas a serem extraídas de forma exclusiva. As opções "startDate" e "endDate" precisam ser especificadas ou não especificadas. Se apenas um deles for especificado ou se endDate for anterior a startDate, INVALID_ARGUMENT será retornado.
pageSize

integer

Tamanho da página solicitada. O servidor pode retornar menos TrafficStats do que o solicitado. Se não for especificado, o servidor vai escolher um padrão adequado.
pageToken

string

O valor nextPageToken retornado de uma solicitação de lista anterior, se houver. Esse é o valor de ListTrafficStatsResponse.next_page_token retornado da chamada anterior para o método trafficStats.list.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Mensagem de resposta para trafficStats.list.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "trafficStats": [
    {
      object (TrafficStats)
    }
  ],
  "nextPageToken": string
}
Campos
trafficStats[]

object (TrafficStats)

A lista de TrafficStats.
nextPageToken

string

Token para recuperar a próxima página de resultados ou vazia se não houver mais resultados na lista.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte o guia de autorização.

Data

Representa uma data inteira ou parcial do calendário, como um aniversário. A hora do dia e o fuso horário são especificados em outro lugar ou são insignificantes. A data é referente ao calendário gregoriano. Isso pode representar uma das seguintes opções:

  • uma data completa, com valores de ano, mês e dia diferentes de zero;
  • um mês e dia, com um ano zero (por exemplo, uma data comemorativa);
  • um ano sozinho, com um mês zero e um dia zero;
  • um ano e mês, com um dia zero (por exemplo, uma data de validade de cartão de crédito).

Tipos relacionados:

Representação JSON 
{
  "year": integer,
  "month": integer,
  "day": integer
}
Campos
year

integer

Ano da data. Precisa ser de 1 a 9.999 ou 0 para especificar uma data sem ano.
month

integer

Mês do ano. Precisa ser de 1 a 12, ou 0 para especificar um ano sem um mês e dia.
day

integer

Dia do mês. Precisa ser de 1 a 31 e válido para o ano e o mês, ou 0 para especificar um ano sozinho ou um ano e mês em que o dia não é significativo.