Method: properties.reportTasks.query

Recupera o conteúdo de uma tarefa de relatório. Depois de solicitar o reportTasks.create, você pode recuperar o conteúdo do relatório quando ele estiver ATIVO. Esse método retornará um erro se o estado da tarefa de relatório não for ACTIVE. Uma resposta de consulta retornará a linha tabular e valores das colunas do relatório.

Solicitação HTTP

POST https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/reportTasks/*}:query

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
name

string

Obrigatório. O nome da origem do relatório. Formato: properties/{property}/reportTasks/{report}

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "offset": string,
  "limit": string
}
Campos
offset

string (int64 format)

Opcional. É a contagem da linha inicial do relatório. 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 limit das linhas. A segunda solicitação define o deslocamento para o limit da primeira solicitação. a segunda solicitação retorna o segundo limit das linhas.

Para saber mais sobre esse parâmetro de paginação, consulte Paginação.
limit

string (int64 format)

Opcional. O número de linhas a serem retornadas do relatório. 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. limit precisa ser positivo.

A API também poderá retornar menos linhas do que o limit solicitado, se não houver tantos valores de dimensão quanto o limit. O número de linhas disponíveis para um QueryReportTaskRequest é ainda mais limitado pelo limite da ReportTask associada. Uma consulta pode recuperar no máximo linhas ReportTask.limit. Por exemplo, se ReportTask tiver um limite de 1.000, uma solicitação reportTasks.query com deslocamento=900 e limit=500 retornará no máximo 100 linhas.

Para saber mais sobre esse parâmetro de paginação, consulte Paginação.

Corpo da resposta

O conteúdo do relatório correspondente a uma tarefa de relatório.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "totals": [
    {
      object (Row)
    }
  ],
  "maximums": [
    {
      object (Row)
    }
  ],
  "minimums": [
    {
      object (Row)
    }
  ],
  "rowCount": integer,
  "metadata": {
    object (ResponseMetaData)
  }
}
Campos
dimensionHeaders[]

object (DimensionHeader)

Descreve colunas de dimensão. O número de DimensionHeaders e a ordem de DimensionHeaders correspondem às dimensões presentes nas linhas.
metricHeaders[]

object (MetricHeader)

Descreve colunas de métricas. O número de MetricHeaders e a ordem de MetricHeaders correspondem às métricas presentes nas linhas.
rows[]

object (Row)

Linhas de combinações de valores de dimensão e valores de métrica no relatório.
totals[]

object (Row)

Se solicitado, os valores totalizados das métricas.
maximums[]

object (Row)

Se solicitado, os valores máximos das métricas.
minimums[]

object (Row)

Se solicitado, os valores mínimos das métricas.
rowCount

integer

O número total de linhas no resultado da consulta.
metadata

object (ResponseMetaData)

Metadados do relatório.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics

ResponseMetaData

Os metadados da resposta com informações adicionais sobre o conteúdo do relatório.

Representação JSON 
{
  "dataLossFromOtherRow": boolean,
  "schemaRestrictionResponse": {
    object (SchemaRestrictionResponse)
  },
  "currencyCode": string,
  "timeZone": string,
  "emptyReason": string,
  "subjectToThresholding": boolean
}
Campos
dataLossFromOtherRow

boolean

Se verdadeiro, indica que alguns grupos de combinações de dimensão estão agrupados em "(outros)". linha de comando. Isso acontece nos relatórios de alta cardinalidade.

O parâmetro de metadados dataLossFromOtherRow é preenchido com base na tabela de dados agregados usada no relatório. O parâmetro será preenchido com precisão, independentemente dos filtros e limites presentes no relatório.

Por exemplo, a linha "(other)" pode ser removida do relatório porque a solicitação contém um filtro em sessionSource = google. Esse parâmetro ainda será preenchido se a perda de dados de outra linha estiver presente nos dados agregados de entrada usados para gerar o relatório.

Para saber mais, consulte Sobre a linha "(Outros)" e a amostragem de dados.
schemaRestrictionResponse

object (SchemaRestrictionResponse)

Descreve as restrições de esquema aplicadas ativamente na criação desse relatório. Para saber mais, consulte Gerenciamento de restrição de dados e acesso.
currencyCode

string

O código da moeda usado neste relatório. Destina-se a ser usado na formatação de métricas de moeda, como purchaseRevenue, para visualização. Se currencyCode tiver sido especificado na solicitação, esse parâmetro de resposta ecoará o parâmetro de solicitação; Caso contrário, esse parâmetro de resposta será o currencyCode atual da propriedade.

Os códigos de moeda são codificações de strings de tipos de moedas do padrão ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217)) por exemplo, "USD", "EUR" e "JPY". Para saber mais, consulte https://support.google.com/analytics/answer/9796179.
timeZone

string

O fuso horário atual da propriedade. Destina-se a ser usado para interpretar dimensões baseadas em tempo, como hour e minute. Formatado como strings do banco de dados da IANA (https://www.iana.org/time-zones) (em inglês). por exemplo, "América/Nova_York" ou "Ásia/Tóquio".
emptyReason

string

Se o motivo vazio for especificado, o relatório estará vazio.
subjectToThresholding

boolean

Se subjectToThresholding for verdadeiro, esse relatório vai estar sujeito a um limite e vai retornar apenas dados que atendam aos limites mínimos de agregação. É possível que uma solicitação esteja sujeita a um limite e nenhum dado esteja ausente do relatório. Isso acontece quando todos os dados estão acima dos limites. Para saber mais, consulte Limites de dados e Sobre informações demográficas e de interesses.

SchemaRestrictionResponse

As restrições de esquema aplicadas ativamente na criação desse relatório. Para saber mais, consulte Gerenciamento de restrição de dados e acesso.

Representação JSON 
{
  "activeMetricRestrictions": [
    {
      object (ActiveMetricRestriction)
    }
  ]
}
Campos
activeMetricRestrictions[]

object (ActiveMetricRestriction)

Todas as restrições são ativamente aplicadas na criação do relatório. Por exemplo, purchaseRevenue sempre tem o tipo de restrição REVENUE_DATA. No entanto, essa restrição de resposta ativa só será preenchida se o papel personalizado do usuário não permitir o acesso a REVENUE_DATA.

ActiveMetricRestriction

Uma métrica ativamente restrita na criação do relatório.

Representação JSON 
{
  "restrictedMetricTypes": [
    enum (RestrictedMetricType)
  ],
  "metricName": string
}
Campos
restrictedMetricTypes[]

enum (RestrictedMetricType)

O motivo da restrição dessa métrica.
metricName

string

O nome da métrica restrita.

RestrictedMetricType

Categorias de dados que podem ter restrição de visualização em determinadas propriedades do GA4.

Enums
RESTRICTED_METRIC_TYPE_UNSPECIFIED Tipo não especificado.
COST_DATA Métricas de custo, como adCost
REVENUE_DATA Métricas de receita, como purchaseRevenue.