Method: properties.reportTasks.query

Recupera o conteúdo de uma tarefa de relatório. Depois de solicitar reportTasks.create, você poderá 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á os valores de linha e coluna tabulares 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 de linhas da linha inicial no relatório. A primeira linha é contada como linha 0.

Ao paginar, a primeira solicitação não especifica o deslocamento ou, de forma equivalente, define o deslocamento como 0. A primeira solicitação retorna o primeiro limit de linhas. A segunda solicitação define o deslocamento como o limit da primeira solicitação. A segunda solicitação retorna o segundo limit de 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 um máximo de 250.000 linhas por solicitação, não importa quantas você peça. limit precisa ser positivo.

A API também pode 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 uma QueryReportTaskRequest é ainda mais limitado pelo limite da ReportTask associada. Uma consulta pode recuperar no máximo linhas ReportTask.limit. Por exemplo, se a ReportTask tiver um limite de 1.000, uma solicitação reportTasks.query com offset=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 deles correspondem às dimensões presentes nas linhas.
metricHeaders[]

object (MetricHeader)

Descreve colunas de métrica. O número de MetricHeaders e a ordem deles 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 totais 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