- 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ê 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 tabulares de linha e coluna 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 a linha 0. Na paginação, a primeira solicitação não especifica o deslocamento ou, de maneira equivalente, define o deslocamento como 0. A primeira solicitação retorna a primeira Consulte Paginação para saber mais sobre esse parâmetro. |
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ê solicitar. A API também pode retornar menos linhas do que o Consulte Paginação para saber mais sobre esse parâmetro. |
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 as colunas de dimensão. O número de DimensionHeaders e a ordem de DimensionHeaders correspondem às dimensões presentes nas linhas. |
metricHeaders[] |
Descreve as colunas de métricas. O número de MetricHeaders e ordem de MetricHeaders correspondem às métricas presentes nas linhas. |
rows[] |
Linhas de combinações de valores de dimensão e valores de métricas no relatório. |
totals[] |
Se solicitado, os valores totais 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 de 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 da denúncia.
Representação JSON |
---|
{
"dataLossFromOtherRow": boolean,
"schemaRestrictionResponse": {
object ( |
Campos | |
---|---|
dataLossFromOtherRow |
Se verdadeiro, indica que alguns intervalos de combinações de dimensão foram inseridos na linha "(outros)". Isso pode acontecer em 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 de forma precisa, independentemente dos filtros e limites do 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 houver perda de dados de outra linha 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 deste relatório. Para saber mais, consulte Gerenciamento de restrição de dados e acesso. |
currencyCode |
O código da moeda usado neste relatório. Destinado ao uso na formatação de métricas monetárias como Os códigos de moeda são codificações de strings de tipos de moeda do padrão ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217). Por exemplo, "USD", "EUR", "JPY". Para saber mais, consulte https://support.google.com/analytics/answer/9796179. |
timeZone |
O fuso horário atual da propriedade. Usado para interpretar dimensões com base no tempo, como |
emptyReason |
Se um motivo vazio for especificado, o relatório vai estar vazio. |
subjectToThresholding |
Se |
SchemaRestrictionResponse
As restrições de esquema foram 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 ( |
Campos | |
---|---|
activeMetricRestrictions[] |
Todas as restrições aplicadas ativamente 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 não podem ser visualizados 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 . |