- 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 seus dados de eventos do Google Analytics. Os relatórios contêm estatísticas derivadas dos dados coletados pelo código de acompanhamento do Google Analytics. Os dados retornados da API são como uma tabela com colunas para as dimensões e métricas solicitadas. As métricas são medidas individuais das atividades dos usuários na sua propriedade, como usuários ativos ou contagem de eventos. As dimensões dividem as métricas de acordo com alguns critérios comuns, como país ou nome do evento.
Para ver um guia sobre como criar solicitações e entender as respostas, consulte Como criar um relatório.
Solicitação HTTP
POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:runReport
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
Parâmetros | |
---|---|
property |
Um identificador de propriedade do GA4 do Google Analytics com eventos rastreados. Especificado no caminho do URL, e não no corpo. Para saber mais, confira onde encontrar o ID da propriedade. Em uma solicitação em lote, essa propriedade deve ser não especificada ou consistente com a propriedade no nível do lote. Exemplo: properties/1234 |
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. |
metrics[] |
As métricas solicitadas e exibidas. |
dateRanges[] |
Períodos de dados 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 dados de eventos dos dias sobrepostos serão incluídos nas linhas de resposta dos dois períodos. Em uma solicitação de coorte, esse |
dimensionFilter |
Com os filtros de dimensão, é possível solicitar somente valores de dimensão específicos no relató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 |
A cláusula de filtro das métricas. Aplicado após agregar as linhas do relatório, 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. Na paginação, a primeira solicitação não especifica o deslocamento ou, de maneira equivalente, define o deslocamento como 0. A primeira solicitação retorna a primeira 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 250.000 linhas por solicitação, independentemente de quantas linhas você solicitar. A API também pode retornar menos linhas do que o Consulte Paginação para saber mais sobre esse parâmetro. |
metricAggregations[] |
Agregação de métricas. Os valores das métricas agregadas serão mostrados nas linhas em que "dimensionValues" estiver definido como "RESERVED_(Metric separadamente)". |
orderBys[] |
Especifica como as linhas são ordenadas na resposta. |
currencyCode |
Um código de moeda no formato ISO4217, como "AED", "USD", "JPY". Se o campo estiver vazio, o relatório usará a moeda padrão da propriedade. |
cohortSpec |
Grupo de coorte associado a esta solicitação. Se houver um grupo de coorte na solicitação, a dimensão "coorte" precisará estar presente. |
keepEmptyRows |
Se for falso ou não especificado, cada linha com todas as métricas iguais a 0 não será retornada. Se verdadeiro, essas linhas serão retornadas se não forem removidas separadamente por um filtro. Independentemente da configuração de Por exemplo, se uma propriedade nunca registrar um evento |
returnPropertyQuota |
Define se é necessário retornar o estado atual da cota dessa propriedade do Google Analytics. A cota é retornada em PropertyQuota. |
comparisons[] |
Opcional. A configuração de comparações solicitadas e exibidas. A solicitação exige apenas um campo de comparações para receber uma coluna de comparação na resposta. |
Corpo da resposta
Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de RunReportResponse
.
Escopos de autorização
Requer um dos seguintes escopos do OAuth:
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics