- Solicitação HTTP
- Parâmetros de caminho
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
- RunReportRequest
- Faça um teste
Retorna vários relatórios 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/*}:batchRunReports
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 que são acompanhados. Especificado no caminho do URL e não no corpo. Para saber mais, veja onde encontrar seu ID da propriedade. Esta propriedade deve ser especificada para o lote. A propriedade em RunReportRequest pode não ser especificada ou consistente com essa propriedade. Exemplo: propriedades/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 separada. Cada solicitação em lote pode ter até cinco solicitações. |
Corpo da resposta
A resposta em lote que contém vários relatórios.
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
Representação JSON |
---|
{
"reports": [
{
object ( |
Campos | |
---|---|
reports[] |
Respostas individuais. Cada resposta tem uma solicitação de relatório separada. |
kind |
Identifica o tipo de recurso da mensagem. Esse |
Escopos de autorização
Requer um dos seguintes escopos do 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 |
---|
{ "property": string, "dimensions": [ { object ( |
Campos | |
---|---|
property |
Um identificador de propriedade do GA4 do Google Analytics com eventos que são acompanhados. Especificado no caminho do URL e não no corpo. Para saber mais, veja onde encontrar seu 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: propriedades/1234 |
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 da resposta conterá 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, você pode 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 do SQL. Não é possível usar dimensões neste filtro. |
offset |
A contagem de linhas da linha inicial. A primeira linha é contada como 0. Durante a paginação, a primeira solicitação não especifica o deslocamento. ou equivalente, define o deslocamento para 0; a primeira solicitação retorna o primeiro 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 250.000 linhas por solicitação, independentemente de quantas linhas você pedir. A API também poderá retornar menos linhas do que o Para saber mais sobre esse parâmetro de paginação, consulte Paginação. |
metricAggregations[] |
Agregação de métricas. Os valores de métricas agregados serão mostrados nas linhas em que dimensionValues estiverem definidos como "RESERVED_(MetricAggregate)". |
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 vai 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, o campo "coort" a dimensão deve 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 dessa configuração de Por exemplo, se uma propriedade nunca registrar um evento |
returnPropertyQuota |
Alterna se o estado atual da cota dessa propriedade do Google Analytics será retornado. A cota é retornada em PropertyQuota. |
comparisons[] |
Opcional. A configuração de comparações solicitadas e exibidas. A solicitação requer apenas um campo de comparações para receber uma coluna de comparação na resposta. |