Method: properties.reportTasks.query

Recupera o conteúdo de uma tarefa de relatório. Depois de solicitar o reportTasks.create, você poderá recuperar o conteúdo da denúncia quando ela estiver ATIVA. Esse método vai retornar um erro se o estado da tarefa de relatório não for ACTIVE. Uma resposta de consulta vai retornar os valores de linha e coluna da tabela 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 a primeira limit de 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 que serão 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ê solicitar. 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 consulta de tarefa de relatório é limitado pelo limite da tarefa de relatório associada. Uma consulta pode recuperar no máximo ReportTask.limit linhas. Por exemplo, se a tarefa de relatório tiver um limite de 1.000, uma solicitação reportTasks.query com offset=900 e limit=500 vai 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 denúncia.

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 as colunas de dimensão. O número de DimensionHeaders e a ordem dos DimensionHeaders correspondem às dimensões presentes nas linhas.
metricHeaders[]

object (MetricHeader)

Descreve as colunas de métricas. 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

ResponseMetaData

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

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

boolean

Se verdadeiro, indica que alguns buckets de combinações de dimensões são agrupados na linha "(Outros)". Isso pode acontecer com 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 do relatório.

Por exemplo, a linha "(Outros)" 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 esse relatório.

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

object (SamplingMetadata)

Se os resultados do relatório forem amostrais, isso vai descrever a porcentagem de eventos usados no relatório. Uma samplingMetadatas é preenchida para cada período. Cada samplingMetadatas corresponde a um período especificado na solicitação.

No entanto, se os resultados não forem amostrados, esse campo não será definido.
schemaRestrictionResponse

object (SchemaRestrictionResponse)

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

string

O código da moeda usada neste relatório. Destina-se a ser usado na formatação de métricas de moeda, como purchaseRevenue, para visualização. Se o currencyCode tiver sido especificado na solicitação, esse parâmetro de resposta vai repetir 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 string de tipos de moeda do padrão ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217), por exemplo, "USD", "EUR", "JPY". Para saber mais, acesse https://support.google.com/analytics/answer/9796179.
timeZone

string

O fuso horário atual da propriedade. É usado para interpretar dimensões baseadas em tempo, como hour e minute. Formatado como strings do banco de dados de fuso horário IANA (https://www.iana.org/time-zones). Por exemplo, "America/New_York" ou "Asia/Tokyo".
emptyReason

string

Se o motivo vazio for especificado, o relatório vai estar vazio por esse motivo.
subjectToThresholding

boolean

Se subjectToThresholding for verdadeiro, este relatório estará sujeito a um limite e só vai retornar dados que atendam aos limites mínimos de agregação. É possível que uma solicitação esteja sujeita a um limite e que não haja dados ausentes no relatório. Isso acontece quando todos os dados estão acima dos limites. Para saber mais, consulte Limites mínimos de dados e Sobre os dados demográficos e de interesses.

SchemaRestrictionResponse

As restrições de esquema aplicadas ativamente na criação deste 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 aplicadas ativamente 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ó é preenchida se a função personalizada 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 da métrica.
metricName

string

O nome da métrica restrita.

RestrictedMetricType

Categorias de dados que podem ser restritas em determinadas propriedades do Google Analytics.

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.