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.

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.

SamplingMetadata

Se os resultados do relatório forem amostrais, isso vai 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 de amostragem para um período. Esse é o tamanho do subconjunto de dados da propriedade que foi analisado neste relatório.

samplingSpaceSize

string (int64 format)

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

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