- Solicitação HTTP
- Parâmetros de caminho
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
- RunPivotReportRequest
- Faça um teste
Retorna vários relatórios dinâmicos em um lote. Todos os relatórios precisam ser da mesma propriedade do GA4.
Solicitação HTTP
POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:batchRunPivotReports
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. Essa propriedade deve ser especificada para o lote. A propriedade em RunPivotReportRequest pode não ser especificada ou ser consistente com essa propriedade. Exemplo: properties/1234 |
Corpo da solicitação
O corpo da solicitação contém dados com a seguinte estrutura:
Representação JSON |
---|
{
"requests": [
{
object ( |
Campos | |
---|---|
requests[] |
Solicitações individuais. Cada solicitação tem uma resposta de relatório dinâmico diferente. Cada solicitação em lote pode ter até cinco solicitações. |
Corpo da resposta
A resposta em lote contendo vários relatórios dinâmicos.
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
Representação JSON |
---|
{
"pivotReports": [
{
object ( |
Campos | |
---|---|
pivotReports[] |
Respostas individuais. Cada resposta tem uma solicitação de relatório dinâmico diferente. |
kind |
Identifica o tipo de recurso da mensagem. Este |
Escopos de autorização
Requer um dos seguintes escopos do OAuth:
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics
RunPivotReportRequest
A solicitação para gerar um relatório dinâmico.
Representação JSON |
---|
{ "property": string, "dimensions": [ { object ( |
Campos | |
---|---|
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 |
dimensions[] |
As dimensões solicitadas. Todas as dimensões definidas precisam ser usadas por um dos seguintes valores: dimensionExpression, dimensionFilter, pivots, orderBys. |
metrics[] |
As métricas solicitadas. Pelo menos uma métrica precisa ser especificada. Todas as métricas definidas precisam ser usadas por um dos seguintes critérios: metric_expression, metricFilter, orderBys. |
dateRanges[] |
O período para recuperar os dados de eventos do relatório. Se vários períodos forem especificados, os dados de eventos de cada período serão usados no relatório. Uma dimensão especial com o nome de campo "dateRange" pode ser incluída nos nomes de campo de uma tabela dinâmica. Se ela for incluída, o relatório fará a comparação entre os períodos. Em uma solicitação de coorte, esse |
pivots[] |
Descreve o formato visual das dimensões do relatório em colunas ou linhas. A união dos fieldNames (nomes de dimensão) em todas as tabelas dinâmicas precisa ser um subconjunto de nomes de dimensão definidos em Dimensões. Duas tabelas dinâmicas não podem compartilhar uma dimensão. Uma dimensão só será visível se aparecer em uma tabela dinâmica. |
dimensionFilter |
A cláusula de filtro das dimensões. É preciso solicitar as dimensões para usar nesse filtro. Não é possível usar métricas neste filtro. |
metricFilter |
A cláusula de filtro das métricas. Aplicado na fase pós-agregação, semelhante à cláusula SQL. É preciso solicitar as métricas para usá-las nesse filtro. Não é possível usar dimensões neste filtro. |
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 um campo de comparações e uma dimensão de comparações para receber uma coluna de comparação na resposta. |