ResponseMetaData

Metadados da resposta que contêm mais informações 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 for verdadeiro, indica que alguns buckets de combinações de dimensões foram acumulados 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 com precisão, independentemente 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 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.

samplingMetadatas[]

object (SamplingMetadata)

Se os resultados do relatório forem amostrados, isso descreve a porcentagem de eventos usados nele. Um samplingMetadatas é preenchido para cada período. Cada samplingMetadatas corresponde a um período na ordem em que os períodos foram especificados 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 do relatório. Para saber mais, consulte Gerenciamento de restrição de dados e acesso.

currencyCode

string

O código de moeda usado no 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 é 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, consulte 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 o motivo vazio for especificado, o relatório estará vazio por esse motivo.

subjectToThresholding

boolean

Se subjectToThresholding for verdadeiro, esse relatório estará sujeito a limites e só retornará dados que atendam aos limites mínimos de agregação. É possível que uma solicitação esteja sujeita a limites e que nenhum dado esteja ausente do 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 aplicadas ativamente na criação do 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 podem ter restrição de visualização 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 descreve a porcentagem de eventos usados nele. A amostragem é a prática de analisar um subconjunto de todos os dados para descobrir as 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 nesse relatório amostrado para um período. Esse é o tamanho do subconjunto dos dados da propriedade que foi analisado no relatório.

samplingSpaceSize

string (int64 format)

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

Para calcular a porcentagem de dados disponíveis que foram usados no relatório, calcule samplesReadCount/samplingSpaceSize.