Esta página foi traduzida pela API Cloud Translation.

Method: properties.runAccessReport

Solicitação HTTP
Parâmetros de caminho
Corpo da solicitação
- Representação JSON
Corpo da resposta
Escopos de autorização
Faça um teste

Retorna um relatório personalizado de registros de acesso a dados. O relatório mostra registros de cada vez que um usuário lê dados de relatórios do Google Analytics. Os registros de acesso são mantidos por até dois anos.

Os relatórios de acesso aos dados podem ser solicitados para uma propriedade. É possível solicitar relatórios para qualquer propriedade, mas as dimensões que não estão relacionadas à cota só podem ser solicitadas em propriedades do Google Analytics 360. Esse método está disponível apenas para administradores.

Esses registros de acesso a dados incluem a Análise de dados da interface do GA, as análises da interface do GA, a API Data do GA e outros produtos, como o Firebase e a AdMob, que podem extrair dados do Google Analytics por meio de uma vinculação. Esses registros não incluem mudanças na configuração da propriedade, como adicionar um fluxo ou alterar o fuso horário. Para conferir o histórico de mudanças de configuração, consulte searchChangeHistoryEvents.

Para enviar seu feedback sobre essa API, preencha o formulário de Feedback sobre os relatórios de acesso do Google Analytics.

Solicitação HTTP

POST https://analyticsadmin.googleapis.com/v1beta/{entity=properties/*}:runAccessReport

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

Parâmetros de caminho

Parâmetros

Parâmetros
`entity`	`string` O relatório de acesso a dados aceita solicitações no nível da propriedade ou da conta. Se solicitado no nível da conta, os relatórios de acesso aos dados incluem todos os acessos de todas as propriedades dessa conta. Para fazer a solicitação no nível da propriedade, a entidade precisa ser, por exemplo, "properties/123", se "123" for o ID da propriedade do Google Analytics. Para fazer a solicitação no nível da conta, a entidade precisa ser, por exemplo, "accounts/1234", se "1234" for o ID da sua conta do Google Analytics.

entity

string

O relatório de acesso a dados aceita solicitações no nível da propriedade ou da conta. Se solicitado no nível da conta, os relatórios de acesso aos dados incluem todos os acessos de todas as propriedades dessa conta.

Para fazer a solicitação no nível da propriedade, a entidade precisa ser, por exemplo, "properties/123", se "123" for o ID da propriedade do Google Analytics. Para fazer a solicitação no nível da conta, a entidade precisa ser, por exemplo, "accounts/1234", se "1234" for o ID da sua conta do Google Analytics.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON

Representação JSON
{ "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 }

{
  "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
}

Campos
`dimensions[]`	`object (AccessDimension)` As dimensões solicitadas e exibidas na resposta. As solicitações podem ter até nove dimensões.
`metrics[]`	`object (AccessMetric)` As métricas solicitadas e exibidas na resposta. As solicitações podem ter até 10 métricas.
`dateRanges[]`	`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 para ambos os períodos. As solicitações são permitidas para até dois períodos.
`dimensionFilter`	`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.
`metricFilter`	`object (AccessFilterExpression)` Com os filtros de métrica, você pode restringir a resposta do relatório a valores de métrica 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.
`offset`	`string (int64 format)` O número de linhas da linha inicial. A primeira linha é contada como linha 0. Se o deslocamento não for especificado, ele será tratado como 0. Se o deslocamento for zero, esse método vai retornar a primeira página de resultados com entradas `limit`. Para saber mais sobre esse parâmetro de paginação, consulte Paginação.
`limit`	`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 o `limit` solicitado, se não houver tantas linhas restantes quanto o `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.
`timeZone`	`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 de fuso horário IANA (https://www.iana.org/time-zones). Por exemplo, "America/New_York" ou "Asia/Tokyo".
`orderBys[]`	`object (AccessOrderBy)` Especifica como as linhas são ordenadas na resposta.
`returnEntityQuota`	`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.
`includeAllUsers`	`boolean` Opcional. Determina se os usuários que nunca fizeram uma chamada de API serão incluídos na resposta. Se verdadeiro, todos os usuários com acesso à propriedade ou conta especificada são incluídos na resposta, independentemente de terem feito uma chamada de API ou não. Se for falso, apenas os usuários que fizeram uma chamada de API serão incluídos.
`expandGroups`	`boolean` Opcional. Decide se os usuários vão ser retornados nos grupos de usuários. Esse campo só funciona quando "includeAllUsers" é definido como "true". Se for verdadeiro, vai retornar todos os usuários com acesso à propriedade ou conta especificada. Se for "false", apenas os usuários com acesso direto serão retornados.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de RunAccessReportResponse.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics.edit