- Solicitação HTTP
- Parâmetros de caminho
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
- ResponseMetaData
- SchemaRestrictionResponse
- ActiveMetricRestriction
- RestrictedMetricType
- Faça um teste
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 |
Obrigatório. O nome da origem do relatório. Formato: |
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 |
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 Para saber mais sobre esse parâmetro de paginação, consulte Paginação. |
limit |
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. A API também poderá retornar menos linhas do que o 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 ( |
Campos | |
---|---|
dimensionHeaders[] |
Descreve colunas de dimensão. O número de DimensionHeaders e a ordem de DimensionHeaders correspondem às dimensões presentes nas linhas. |
metricHeaders[] |
Descreve colunas de métricas. O número de MetricHeaders e a ordem de MetricHeaders correspondem às métricas presentes nas linhas. |
rows[] |
Linhas de combinações de valores de dimensão e valores de métrica no relatório. |
totals[] |
Se solicitado, os valores totalizados das métricas. |
maximums[] |
Se solicitado, os valores máximos das métricas. |
minimums[] |
Se solicitado, os valores mínimos das métricas. |
rowCount |
O número total de linhas no resultado da consulta. |
metadata |
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 ( |
Campos | |
---|---|
dataLossFromOtherRow |
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 |
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 |
O código da moeda usado neste relatório. Destina-se a ser usado na formatação de métricas de moeda, como 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 |
O fuso horário atual da propriedade. Destina-se a ser usado para interpretar dimensões baseadas em tempo, como |
emptyReason |
Se o motivo vazio for especificado, o relatório estará vazio. |
subjectToThresholding |
Se |
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 ( |
Campos | |
---|---|
activeMetricRestrictions[] |
Todas as restrições são ativamente aplicadas na criação do relatório. Por exemplo, |
ActiveMetricRestriction
Uma métrica ativamente restrita na criação do relatório.
Representação JSON |
---|
{
"restrictedMetricTypes": [
enum ( |
Campos | |
---|---|
restrictedMetricTypes[] |
O motivo da restrição dessa métrica. |
metricName |
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 . |