- Solicitação HTTP
- Corpo da solicitação
- Corpo da resposta
- Escopos da autorização
- RunReportRequest
- Faça um teste
Retorna vários relatórios em um lote. Todos os relatórios precisam ser sobre a mesma entidade.
Solicitação HTTP
POST https://analyticsdata.googleapis.com/v1alpha:batchRunReports
O URL usa a sintaxe de transcodificação gRPC.
Corpo da solicitação
O corpo da solicitação contém dados com a seguinte estrutura:
Representação JSON | |
---|---|
{ "entity": { object ( |
Campos | |
---|---|
entity |
Uma propriedade com eventos que são rastreados. Essa entidade precisa ser especificada para o lote. A entidade em RunReportRequest pode não ser especificada ou ser consistente com essa entidade. |
requests[] |
Solicitações individuais. Cada solicitação tem uma resposta de relatório separada. Cada solicitação em lote pode ter até cinco solicitações. |
Corpo da resposta
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
A resposta em lote que contém vários relatórios.
Representação JSON | |
---|---|
{
"reports": [
{
object ( |
Campos | |
---|---|
reports[] |
Respostas individuais. Cada resposta tem uma solicitação de relatório separada. |
Escopos de autorização
Requer um dos seguintes escopos de OAuth:
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics
RunReportRequest
A solicitação para gerar um relatório.
Representação JSON | |
---|---|
{ "entity": { object ( |
Campos | |
---|---|
entity |
Uma propriedade com eventos que são rastreados. Em uma solicitação em lote, essa entidade precisa não ser especificada ou ser consistente com a entidade no nível do lote. |
dimensions[] |
As dimensões solicitadas e exibidas. |
metrics[] |
As métricas solicitadas e exibidas. |
dateRanges[] |
Períodos dos dados a serem lidos. Se vários períodos forem solicitados, cada linha de resposta conterá um índice de período baseado em zero. Se dois períodos se sobrepuserem, os dados dos eventos dos dias sobrepostos serão incluídos nas linhas de resposta dos dois períodos. Em uma solicitação de coorte, esse |
offset |
A contagem de linhas da primeira linha. A primeira linha é contada como linha 0. |
limit |
O número de linhas a serem retornadas. Se o parâmetro |
metricAggregations[] |
Agregação de métricas. Os valores das métricas agregados vão ser mostrados nas linhas em que "dimensionValues" está definido como "RESERVED_(MetricParams)". |
dimensionFilter |
A cláusula de filtro das dimensões. É preciso solicitar as dimensões para uso nesse filtro. Não é possível usar métricas nesse filtro. |
metricFilter |
A cláusula de filtro das métricas. Aplicada na fase pós-agregação, semelhante à cláusula SQL. As métricas precisam ser solicitadas para serem usadas nesse filtro. Não é possível usar dimensões neste filtro. |
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 entidade. |
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. |
returnPropertyQuota |
Define se o estado atual da cota dessa propriedade do Google Analytics será retornado. A cota é retornada em PropertyQuota. |