Method: properties.getMetadata

Retorna metadados de dimensões e métricas disponíveis nos métodos de geração de relatórios. Usado para explorar as dimensões e métricas. Nesse método, um identificador da propriedade do GA4 no 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, e não nos parâmetros de URL. A propriedade é um identificador numérico da propriedade do GA4 do Google Analytics. Para saber mais, confira 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

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

As dimensões e métricas atualmente aceitas nos métodos de relatório.

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

string

Nome do recurso dos metadados.
dimensions[]

object (DimensionMetadata)

As descrições de dimensão.
metrics[]

object (MetricMetadata)

As descrições de métricas.

Escopos de autorização

Requer um dos seguintes escopos de 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
}
Campos
apiName

string

Nome dessa dimensão. Pode ser usado no name de Dimension. 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

Ainda utilizáveis, mas nomes obsoletos para esta dimensão. Se preenchida, essa dimensão ficará disponível por apiName ou deprecatedApiNames por um período. Após o período de descontinuação, a dimensão só vai estar disponível por apiName.
customDefinition

boolean

Verdadeiro se a dimensão for personalizada para esta propriedade.

MetricMetadata

Explica uma métrica.

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

string

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

string

O 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

Ainda podem ser usados, mas os nomes dessa métrica foram descontinuados. Se preenchida, essa métrica ficará disponível por apiName ou deprecatedApiNames por um período. Após o período de descontinuação, a métrica vai estar disponível apenas por apiName.
type

enum (MetricType)

O tipo dessa métrica.
expression

string

A expressão matemática para esta 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 e, para não expressões, esse campo fica vazio.
customDefinition

boolean

Verdadeiro se a métrica for personalizada para esta propriedade.