- Solicitação HTTP
- Parâmetros de caminho
- Corpo da solicitação
- 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 fornece registros de cada vez que um usuário lê os dados de relatório do Google Analytics. Os registros de acesso são mantidos por até dois anos.
É possível solicitar relatórios de acesso aos dados 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 só está disponível para administradores.
Esses registros de acesso a dados incluem relatórios da interface do GA4, Análises detalhadas da interface do GA4, API GA4 Data e outros produtos, como o Firebase e a AdMob, que podem recuperar dados do Google Analytics usando uma vinculação. Esses registros não incluem mudanças de configuração da propriedade, como adicionar um fluxo ou mudar o fuso horário de uma propriedade. Para acessar o histórico de alterações de configuração, consulte searchChangeHistoryEvents.
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 | |
---|---|
entity |
O Relatório de acesso a dados é compatível com solicitações no nível da propriedade ou da conta. Se solicitados no nível da conta, os relatórios de acesso a dados incluem todo o acesso a todas as propriedades nessa conta. Para solicitar no nível da propriedade, a entidade vai precisar ser, por exemplo, "properties/123" se "123" for o ID da propriedade do GA4. Para solicitar no nível da conta, a entidade vai precisar ser, por exemplo, "accounts/1234" se "1234" for 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 |
---|
{ "dimensions": [ { object ( |
Campos | |
---|---|
dimensions[] |
As dimensões solicitadas e exibidas na resposta. As solicitações podem ter até nove dimensões. |
metrics[] |
As métricas solicitadas e exibidas na resposta. As solicitações podem ter até 10 métricas. |
dateRanges[] |
Períodos dos registros de acesso a serem lidos. Se vários períodos forem solicitados, cada linha de resposta terá 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. As solicitações podem ter até dois períodos. |
dimensionFilter |
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 |
Com os filtros de métricas, é possível restringir a resposta do relatório a valores de métricas específicos que correspondem ao filtro. Os filtros de métricas são aplicados após a agregação das linhas do relatório, de maneira semelhante à cláusula SQL. Não é possível usar dimensões neste filtro. |
offset |
A contagem de linhas da primeira linha. A primeira linha é contada como a linha 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 Consulte Paginação para saber mais sobre esse parâmetro. |
limit |
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ê solicitar. A API pode retornar menos linhas do que o Consulte Paginação para saber mais sobre esse parâmetro. |
timeZone |
O fuso horário desta 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)). Por exemplo, "America/New_York" ou "Asia/Tokyo". |
orderBys[] |
Especifica como as linhas são ordenadas na resposta. |
returnEntityQuota |
Define se é necessário retornar o estado atual da cota dessa propriedade do Google Analytics. A cota é retornada em AccessQuota. Para solicitações no nível da conta, este campo precisa ser falso. |
includeAllUsers |
Opcional. Determina se os usuários que nunca fizeram uma chamada de API na resposta serão incluídos. 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 "false", somente os usuários que fizeram uma chamada de API serão incluídos. |
expandGroups |
Opcional. Decidir se quer retornar os usuários nos grupos de usuários. Esse campo só funciona quando includeAllUsers está definido como verdadeiro. Se verdadeiro, todos os usuários com acesso à propriedade ou conta especificada serão retornados. Se for definido como "false", somente 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 de OAuth:
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics.edit