- 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 dos registros de acesso a dados. O relatório fornece 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.
É possível solicitar os relatórios de acesso a dados de uma propriedade. A propriedade precisa estar no Google Analytics 360. Esse método só está disponível para os administradores.
Esses registros incluem relatórios de IU do GA4, Explorações de IU do GA4, API Data do GA4 e outros produtos, como Firebase e AdMob, que podem recuperar dados do Google Analytics por meio de uma vinculação. Esses registros não incluem alterações de configuração de propriedades, como adicionar um fluxo ou alterar o fuso horário de uma propriedade. Para ver o histórico de alterações da configuração, consulte searchChangeHistoryEvents.
Solicitação HTTP
POST https://analyticsadmin.googleapis.com/v1alpha/{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 incluirão todo o acesso a todas as propriedades da conta. Para solicitar no nível da propriedade, por exemplo, a entidade precisa ser "properties/123" se "123" for seu ID da propriedade do GA4. Para solicitar no nível da conta, a entidade deve 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 de registros de acesso para ler. Se vários períodos forem solicitados, cada linha de resposta conterá um índice de períodos com base em zero. Se dois períodos se sobrepõem, os registros de acesso dos dias conflitantes sã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 específicos de dimensão que correspondam ao filtro. Por exemplo, filtrar os 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 |
Os filtros de métrica permitem restringir a resposta do relatório a valores de métrica específicos que correspondam ao filtro. Os filtros de métrica são aplicados depois de agregar as linhas do relatório, de forma semelhante à cláusula SQL. Não é possível usar dimensões neste filtro. |
offset |
A contagem 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 retornará a primeira página de resultados com entradas Para saber mais sobre esse parâmetro de paginação, consulte Paginação. |
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 Para saber mais sobre esse parâmetro de paginação, consulte Paginação. |
timeZone |
É o 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 do fuso horário IANA (https://www.iana.org/time-zones). Por exemplo, "América/Nova_York" ou "Ásia/Tóquio". |
orderBys[] |
Especifica como as linhas são ordenadas na resposta. |
returnEntityQuota |
Alterna entre 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. |
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