Method: properties.getMetadata

Retorna metadados para dimensões e métricas disponíveis em métodos de relatórios. Usado para analisar as dimensões e métricas. Nesse método, um identificador de propriedade do Google Analytics é especificado na solicitação, e a resposta de metadados inclui dimensões e métricas personalizadas, além de metadados universais.

Por exemplo, se uma métrica personalizada com o nome de parâmetro levels_unlocked for registrada em uma propriedade, a resposta de metadados vai conter customEvent:levels_unlocked. Os metadados universais são dimensões e métricas aplicáveis a qualquer propriedade, como country e totalUsers.

Solicitação HTTP

GET https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/metadata}

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
name

string

Obrigatório. O nome do recurso dos metadados a serem recuperados. Esse campo de nome é especificado no caminho do URL, não nos parâmetros do URL. A propriedade é um identificador numérico de propriedade do Google Analytics. Para saber mais, consulte onde encontrar o ID da propriedade.

Exemplo: properties/1234/metadata

Defina o ID da propriedade como 0 para dimensões e métricas comuns a todas as propriedades. Nesse modo especial, o método não retorna dimensões e métricas personalizadas.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

As dimensões, métricas e comparações aceitas atualmente nos métodos de geração de relatórios.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "name": string,
  "dimensions": [
    {
      object (DimensionMetadata)
    }
  ],
  "metrics": [
    {
      object (MetricMetadata)
    }
  ],
  "comparisons": [
    {
      object (ComparisonMetadata)
    }
  ],
  "conversions": [
    {
      object (ConversionMetadata)
    }
  ]
}
Campos
name

string

Nome do recurso desses metadados.
dimensions[]

object (DimensionMetadata)

As descrições das dimensões.
metrics[]

object (MetricMetadata)

As descrições das métricas.
comparisons[]

object (ComparisonMetadata)

As descrições da comparação.
conversions[]

object (ConversionMetadata)

As descrições de conversão.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics

DimensionMetadata

Explica uma dimensão.

Representação JSON 
{
  "apiName": string,
  "uiName": string,
  "description": string,
  "deprecatedApiNames": [
    string
  ],
  "customDefinition": boolean,
  "category": string,
  "sections": [
    enum (Section)
  ]
}
Campos
apiName

string

O nome dessa dimensão. Pode ser usado no name da dimensão. Por exemplo, eventName.
uiName

string

O nome dessa dimensão na interface do usuário do Google Analytics. Por exemplo, Event name.
description

string

Descrição de como essa dimensão é usada e calculada.
deprecatedApiNames[]

string

Nomes ainda utilizáveis, mas descontinuados, para essa dimensão. Se preenchida, essa dimensão fica disponível por apiName ou um dos deprecatedApiNames por um período. Após o período de descontinuação, a dimensão só estará disponível por apiName.
customDefinition

boolean

Verdadeiro se a dimensão for personalizada para essa propriedade. Isso inclui dimensões personalizadas no escopo do usuário, do evento e do item. Para saber mais sobre dimensões personalizadas, acesse https://support.google.com/analytics/answer/14240153. Isso também inclui grupos de canais personalizados. Para saber mais sobre eles, acesse https://support.google.com/analytics/answer/13051316.
category

string

O nome de exibição da categoria a que essa dimensão pertence. Dimensões e métricas semelhantes são categorizadas juntas.
sections[]

enum (Section)

Especifica as seções do Google Analytics a que essa dimensão se aplica.

MetricMetadata

Explica uma métrica.

Representação JSON 
{
  "apiName": string,
  "uiName": string,
  "description": string,
  "deprecatedApiNames": [
    string
  ],
  "type": enum (MetricType),
  "expression": string,
  "customDefinition": boolean,
  "blockedReasons": [
    enum (BlockedReason)
  ],
  "category": string,
  "sections": [
    enum (Section)
  ]
}
Campos
apiName

string

Um nome de métrica. Pode ser usado no name da métrica. Por exemplo, eventCount.
uiName

string

Nome dessa métrica na interface do usuário do Google Analytics. Por exemplo, Event count.
description

string

Descrição de como essa métrica é usada e calculada.
deprecatedApiNames[]

string

Nomes ainda utilizáveis, mas descontinuados, para essa métrica. Se preenchida, essa métrica estará disponível por apiName ou um dos deprecatedApiNames por um período. Após o período de descontinuação, a métrica só estará disponível por apiName.
type

enum (MetricType)

O tipo dessa métrica.
expression

string

A expressão matemática para essa métrica derivada. Pode ser usado no campo expression da métrica para relatórios equivalentes. A maioria das métricas não são expressões. Para as que não são, esse campo fica vazio.
customDefinition

boolean

Verdadeiro se a métrica for personalizada para essa propriedade.
blockedReasons[]

enum (BlockedReason)

Se os motivos forem especificados, seu acesso a essa métrica será bloqueado para essa propriedade. As solicitações de API feitas por você para essa propriedade e métrica serão bem-sucedidas, mas o relatório vai conter apenas zeros para essa métrica. As solicitações de API com filtros de métricas bloqueadas vão falhar. Se o campo "reasons" estiver vazio, você terá acesso a essa métrica.

Para saber mais, consulte Gerenciamento de restrição de dados e acesso.
category

string

O nome de exibição da categoria a que essas métricas pertencem. Dimensões e métricas semelhantes são categorizadas juntas.
sections[]

enum (Section)

Especifica as seções do Google Analytics a que essa métrica se aplica.

BlockedReason

Justificativas para o bloqueio da métrica.

Tipos enumerados
BLOCKED_REASON_UNSPECIFIED Nunca será especificado na resposta da API.
NO_REVENUE_METRICS Se presente, seu acesso às métricas relacionadas à receita dessa propriedade será bloqueado, e essa métrica será relacionada à receita.
NO_COST_METRICS Se presente, seu acesso a métricas relacionadas a custos para essa propriedade será bloqueado, e essa métrica será relacionada a custos.

ComparisonMetadata

Os metadados de uma única comparação.

Representação JSON 
{
  "apiName": string,
  "uiName": string,
  "description": string
}
Campos
apiName

string

O nome do recurso desta comparação. Pode ser usado no campo comparison de Comparação. Por exemplo, "comparisons/1234".
uiName

string

O nome dessa comparação na interface do usuário do Google Analytics.
description

string

A descrição desta comparação.

ConversionMetadata

Os metadados de uma única conversão.

Representação JSON 
{
  "conversionAction": string,
  "displayName": string
}
Campos
conversionAction

string

O identificador exclusivo da ação de conversão. Ele é usado para especificar quais conversões incluir em um relatório preenchendo o campo conversionActions no ConversionsSpec de uma solicitação de relatório. Por exemplo, "conversionActions/1234".
displayName

string

O nome dessa conversão na interface do usuário do Google Analytics.