Method: properties.getMetadata

Muestra los metadatos de las dimensiones y métricas disponibles en los métodos de informes. Se usa para explorar las dimensiones y las métricas. En este método, se especifica un identificador de propiedad GA4 de Google Analytics en la solicitud, y la respuesta de metadatos incluye dimensiones y métricas personalizadas, así como metadatos universales.

Por ejemplo, si una métrica personalizada con el nombre del parámetro levels_unlocked se registra en una propiedad, la respuesta de metadatos contendrá customEvent:levels_unlocked. Los metadatos universales son dimensiones y métricas aplicables a cualquier propiedad, como country y totalUsers.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
name

string

Obligatorio. El nombre del recurso de los metadatos que se recuperarán. Este campo de nombre se especifica en la ruta de URL y no en los parámetros de URL. La propiedad es un identificador numérico de la propiedad GA4 de Google Analytics. Para obtener más información, consulta dónde encontrar tu ID de propiedad.

Ejemplo: properties/1234/metadata

Establece el ID de propiedad en 0 para las dimensiones y métricas comunes a todas las propiedades. En este modo especial, este método no mostrará dimensiones ni métricas personalizadas.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Son las dimensiones y métricas que se aceptan actualmente en los métodos de informes.

Representación JSON 
{
  "name": string,
  "dimensions": [
    {
      object (DimensionMetadata)
    }
  ],
  "metrics": [
    {
      object (MetricMetadata)
    }
  ]
}
Campos
name

string

Es el nombre del recurso de estos metadatos.
dimensions[]

object (DimensionMetadata)

Las descripciones de las dimensiones
metrics[]

object (MetricMetadata)

Las descripciones de las métricas

Alcances de la autorización

Se necesita uno de los siguientes alcances de OAuth:

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

DimensionMetadata

Explica una dimensión.

Representación JSON 
{
  "apiName": string,
  "uiName": string,
  "description": string,
  "deprecatedApiNames": [
    string
  ],
  "customDefinition": boolean
}
Campos
apiName

string

Es el nombre de esta dimensión. Se puede usar en el name de Dimension. Por ejemplo, eventName.
uiName

string

Es el nombre de esta dimensión en la interfaz de usuario de Google Analytics. Por ejemplo, Event name.
description

string

Es una descripción de cómo se usa y calcula esta dimensión.
deprecatedApiNames[]

string

Los nombres de esta dimensión aún se pueden usar, pero están obsoletos. Si se propaga, esta dimensión estará disponible en apiName o en deprecatedApiNames durante un período. Después del período de baja, la dimensión solo estará disponible a más tardar el apiName.
customDefinition

boolean

Es verdadero si la dimensión es una dimensión personalizada para esta propiedad.

MetricMetadata

Explica una métrica.

Representación JSON 
{
  "apiName": string,
  "uiName": string,
  "description": string,
  "deprecatedApiNames": [
    string
  ],
  "type": enum (MetricType),
  "expression": string,
  "customDefinition": boolean
}
Campos
apiName

string

Un nombre de métrica. Se puede usar en name de las métricas. Por ejemplo, eventCount.
uiName

string

Es el nombre de esta métrica en la interfaz de usuario de Google Analytics. Por ejemplo, Event count.
description

string

Es una descripción de cómo se usa y calcula esta métrica.
deprecatedApiNames[]

string

Los nombres de esta métrica aún se pueden usar, pero están obsoletos. Si se propaga, esta métrica está disponible en apiName o en deprecatedApiNames durante un período. Después del período de baja, la métrica solo estará disponible el apiName.
type

enum (MetricType)

Es el tipo de esta métrica.
expression

string

La expresión matemática para esta métrica derivada. Se puede usar en el campo expression de la Métrica para los informes equivalentes. La mayoría de las métricas no son expresiones y, para las que no son expresiones, este campo está vacío.
customDefinition

boolean

Es verdadero si la métrica es una métrica personalizada para esta propiedad.