Esta página foi traduzida pela API Cloud Translation.

Method: accounts.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 a dados podem ser solicitados para uma propriedade. Os relatórios podem ser solicitados para qualquer propriedade, mas as dimensões não relacionadas à cota só podem ser solicitadas nas propriedades do Google Analytics 360. Esse método está disponível apenas para administradores.

Esses registros de acesso aos dados incluem relatórios da interface do GA, Análises detalhadas da interface do GA, API Data do GA e outros produtos, como Firebase e AdMob que pode recuperar dados do Google Analytics por meio de uma vinculação. Esses registros não incluem mudanças na configuração de propriedades, como adicionar um fluxo ou mudar o fuso horário de uma propriedade. Para acessar o histórico de alterações da 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/v1alpha/{entity=accounts/*}:runAccessReport

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

Parâmetros de caminho

Parâmetros

Parâmetros
`entity`	`string` Com o Relatório de acesso a dados, é possível fazer solicitações no nível da propriedade ou da conta. Se solicitados no nível da conta, os relatórios de acesso a dados incluirão todo o acesso a todas as propriedades dessa conta. Para solicitar no nível da propriedade, a entidade deve ser, por exemplo, "properties/123" se "123" é o ID da propriedade do GA4. Para solicitar no nível da conta, a entidade deve ser, por exemplo, "accounts/1234" se "1234" é o ID da conta do GA4.

entity

string

Com o Relatório de acesso a dados, é possível fazer solicitações no nível da propriedade ou da conta. Se solicitados no nível da conta, os relatórios de acesso a dados incluirão todo o acesso a todas as propriedades dessa conta.

Para solicitar no nível da propriedade, a entidade deve ser, por exemplo, "properties/123" se "123" é o ID da propriedade do GA4. Para solicitar no nível da conta, a entidade deve ser, por exemplo, "accounts/1234" se "1234" é o ID da conta do GA4.

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)` 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.
`dimensionFilter`	`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.
`metricFilter`	`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.
`offset`	`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.
`limit`	`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 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` 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 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, "América/Nova_York" ou "Ásia/Tóquio".
`orderBys[]`	`object (AccessOrderBy)` Especifica como as linhas são ordenadas na resposta.
`returnEntityQuota`	`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.
`includeAllUsers`	`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.
`expandGroups`	`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.

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