Method: properties.runAccessReport

{
  "dimensions": [
    {
      object (AccessDimension)
    }
  ],
  "metrics": [
    {
      object (AccessMetric)
    }
  ],
  "dateRanges": [
    {
      object (AccessDateRange)
    }
  ],
  "dimensionFilter": {
    object (AccessFilterExpression)
  },
  "metricFilter": {
    object (AccessFilterExpression)
  },
  "offset": string,
  "limit": string,
  "timeZone": string,
  "orderBys": [
    {
      object (AccessOrderBy)
    }
  ],
  "returnEntityQuota": boolean,
  "includeAllUsers": boolean,
  "expandGroups": boolean
}

object (AccessDimension)

As dimensões solicitadas e exibidas na resposta. As solicitações podem ter até nove dimensões.

object (AccessMetric)

As métricas solicitadas e exibidas na resposta. As solicitações podem ter até 10 métricas.

object (AccessDateRange)

Intervalos de datas dos registros de acesso a serem lidos. Se vários períodos forem solicitados, cada linha de resposta vai conter um índice de período com base em zero. Se dois períodos se sobrepõem, os registros de acesso dos dias em que há sobreposição são incluídos nas linhas de resposta de ambos os períodos. As solicitações são permitidas em até dois períodos.

object (AccessFilterExpression)

Com os filtros de dimensão, você pode restringir a resposta do relatório a valores de dimensão específicos que correspondem ao filtro. Por exemplo, filtrar registros de acesso de um único usuário. Para saber mais, consulte Noções básicas sobre filtros de dimensão e confira exemplos. Não é possível usar métricas neste filtro.

object (AccessFilterExpression)

Com os filtros de métricas, você pode restringir a resposta do relatório a valores de métricas específicos que correspondem ao filtro. Os filtros de métrica são aplicados depois da agregação das linhas do relatório, de forma semelhante à cláusula "having" do SQL. Não é possível usar dimensões neste filtro.

string (int64 format)

O número de linhas da linha inicial. A primeira linha é contada como 0. Se o deslocamento não for especificado, ele será tratado como 0. Se o deslocamento for zero, esse método retornará a primeira página de resultados com entradas limit.

Para saber mais sobre esse parâmetro de paginação, consulte Paginação.

string (int64 format)

O número de linhas que serão retornadas. Se não for especificado, 10.000 linhas serão retornadas. A API retorna um máximo de 100.000 linhas por solicitação, não importa quantas você solicitar. limit precisa ser positivo.

A API pode retornar menos linhas do que a limit solicitada se não houver tantas linhas restantes quanto a limit. Por exemplo, há menos de 300 valores possíveis para a dimensão country. Portanto, ao gerar relatórios apenas com country, não é possível receber mais de 300 linhas, mesmo que você defina limit como um valor maior.

Para saber mais sobre esse parâmetro de paginação, consulte Paginação.

string

Fuso horário da solicitação, se especificado. Se não for especificado, o fuso horário da propriedade será usado. O fuso horário da solicitação é usado para interpretar as datas de início e término do relatório.

Formatado como strings do banco de dados da IANA (https://www.iana.org/time-zones) (em inglês). Por exemplo, "America/New_York" ou "Asia/Tokyo".

object (AccessOrderBy)

Especifica como as linhas são ordenadas na resposta.

boolean

Define se o estado atual da cota da propriedade do Google Analytics vai ser retornado. A cota é retornada em AccessQuota. Para solicitações no nível da conta, esse campo precisa ser falso.

boolean

Opcional. Determina se os usuários que nunca fizeram uma chamada de API serão incluídos na resposta. Se for "true", todos os usuários com acesso à propriedade ou conta especificada serão incluídos na resposta, independentemente de terem feito uma chamada de API ou não. Se for "false", apenas os usuários que fizeram uma chamada de API serão incluídos.

boolean

Opcional. Decide se os usuários vão ser retornados nos grupos de usuários. Este campo funciona apenas quando includeAllUsers está definido como verdadeiro. Se verdadeiro, ela retornará todos os usuários com acesso à propriedade ou conta especificada. Se for "false", apenas os usuários com acesso direto serão retornados.