ResponseMetaData

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

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

boolean

Se verdadeiro, indica que alguns agrupamentos de combinações de dimensões foram incluídos na linha "(outros)". Isso pode acontecer com relatórios de alta cardinalidade.

Os dados do parâmetro de metadados dataLossFromOtherRow são preenchidos com base na tabela de dados agregados usada no relatório. O parâmetro será preenchido com precisão, independente dos filtros e limites no 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 houver perda de dados de outra linha 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 amostrados, isso descreverá a porcentagem de eventos usados no relatório. Um samplingMetadatas é preenchido para cada período. Cada samplingMetadatas corresponde a um período na ordem em que foram especificados na solicitação.

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

dataTruncationReasons[]

object (DataTruncationReason)

Se definido, indica que há truncamento de dados no relatório.

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. Destinado a ser usado na formatação de métricas de moeda, como purchaseRevenue, para visualização. Se currencyCode foi 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. Destinado a ser usado para interpretar dimensões baseadas em tempo, como hour e minute. Formatado como strings do banco de dados de fusos horários da IANA (https://www.iana.org/time-zones). Por exemplo, "America/New_York" ou "Asia/Tokyo".

emptyReason

string

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

subjectToThresholding

boolean

Se subjectToThresholding for verdadeiro, esse relatório estará sujeito a limites 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 de agregação 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.

SchemaRestrictionResponse

As restrições de esquema ativamente aplicadas 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 restrita ativamente 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 você não pode acessar em determinadas propriedades do Google Analytics.

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

SamplingMetadata

Se os resultados do relatório forem amostrados, isso descreverá a porcentagem de eventos usados no relatório. A amostragem é a prática de analisar um subconjunto de todos os dados para descobrir informações significativas no conjunto de dados maior.

Representação JSON
{
  "samplesReadCount": string,
  "samplingSpaceSize": string
}
Campos
samplesReadCount

string (int64 format)

O número total de eventos lidos neste relatório com amostragem para um período. É o tamanho do subconjunto de dados da propriedade analisado neste relatório.

samplingSpaceSize

string (int64 format)

O número total de eventos nos dados da propriedade que poderiam ter sido analisados neste relatório para um período. A amostragem descobre as informações significativas sobre o conjunto de dados maior, e esse é o tamanho dele.

Para calcular a porcentagem de dados disponíveis que foi usada neste relatório, calcule samplesReadCount/samplingSpaceSize.

DataTruncationReason

Descreve um motivo para o truncamento de dados no relatório.

Representação JSON
{
  "dataTruncationDateRanges": [
    {
      object (DataTruncationDateRange)
    }
  ],
  "dataTruncationType": enum (DataTruncationType),
  "dataTruncationMessage": string,
  "dataTruncationDate": string
}
Campos
dataTruncationDateRanges[]

object (DataTruncationDateRange)

Os períodos truncados.

dataTruncationType

enum (DataTruncationType)

O tipo de truncamento de dados.

dataTruncationMessage

string

Uma mensagem descritiva explicando o truncamento de dados.

dataTruncationDate

string

A data de truncamento dos dados no formato AAAA-MM-DD. Indica que os dados anteriores a essa data foram truncados.

DataTruncationType

O tipo de truncamento de dados.

Tipos enumerados
DATA_TRUNCATION_TYPE_UNSPECIFIED Tipo não especificado.
DATA_TRUNCATION_TYPE_RULES_BASED_MODELS Os dados são truncados no relatório de atribuição para a data de ouro dos modelos baseados em regras.
DATA_TRUNCATION_TYPE_DATA_DRIVEN_ATTRIBUTION Os dados são truncados no relatório de atribuição para a data de ouro da atribuição baseada em dados.
DATA_TRUNCATION_TYPE_DV360 Os dados são truncados porque a política do DV360 não permite o retorno de dados com mais de dois anos.
DATA_TRUNCATION_TYPE_CM360 Os dados são truncados porque a política do CM360 não permite o retorno de dados com mais de dois anos.
DATA_TRUNCATION_TYPE_ITEM_SCOPED_ECOMMERCE_METRICS As novas métricas de e-commerce no escopo do item só têm dados após uma data específica.
DATA_TRUNCATION_TYPE_EVENT_SCOPED_ECOMMERCE_METRICS As novas métricas de e-commerce no escopo do evento só têm dados após uma data específica.
DATA_TRUNCATION_TYPE_DATE_RANGE O período da consulta pode não ser totalmente veiculado.
DATA_TRUNCATION_TYPE_PROPERTY Os dados foram truncados porque a consulta tenta ler dados de eventos antes da data de retenção.
DATA_TRUNCATION_TYPE_CONVERSIONS Os dados são truncados no relatório de conversões.
DATA_TRUNCATION_TYPE_GOOGLE_ADS Os dados são truncados devido à política de retenção de 36 meses do Google Ads.

DataTruncationDateRange

Define o período truncado de startDate a endDate.

Representação JSON
{
  "startDate": string,
  "endDate": string
}
Campos
startDate

string

A data de início no formato AAAA-MM-DD (inclusive).

endDate

string

A data de término no formato AAAA-MM-DD (inclusive).