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)

Períodos dos registros de acesso a serem lidos. Se vários períodos forem solicitados, cada linha da resposta conterá um índice de período baseado em zero. Se dois períodos se sobrepuserem, os registros de acesso dos dias sobrepostos serão incluídos nas linhas de resposta dos dois períodos. É permitido usar até dois períodos.

object (AccessFilterExpression)

Com os filtros de dimensão, é possível 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 Princípios básicos dos filtros de dimensão para ver exemplos. Não é possível usar métricas neste filtro.

object (AccessFilterExpression)

Com os filtros de métrica, é possível 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 após a agregação das linhas do relatório, de maneira semelhante à cláusula do SQL. Não é possível usar dimensões neste filtro.

string (int64 format)

A contagem 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 a serem retornadas. Se não for especificado, 10.000 linhas serão retornadas. A API retorna no máximo 100.000 linhas por solicitação, independentemente de quantas linhas você pedir. 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 somente sobre country, não é possível gerar mais de 300 linhas, mesmo que você defina limit como um valor mais alto.

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

string

O fuso horário dessa 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 os horários de início e datas de 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, "América/Nova_York" ou "Ásia/Tóquio".

object (AccessOrderBy)

Especifica como as linhas são ordenadas na resposta.

boolean

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

boolean

Opcional. Determina se é necessário incluir na resposta usuários que nunca fizeram uma chamada de API. 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 falso, somente os usuários que fizeram uma chamada de API serão incluídos.

boolean

Opcional. Determina se os usuários serão retornados dentro dos grupos de usuários. Este campo funciona apenas quando includeAllUsers é definido como verdadeiro. Se verdadeiro, ela retornará todos os usuários com acesso à propriedade ou conta especificada. Se for falso, apenas os usuários com acesso direto serão retornados.