Method: properties.getMetadata

Devuelve 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 se registra una métrica personalizada con el nombre del parámetro levels_unlocked 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/v1beta/{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, 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

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

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

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

string

Nombre del recurso de estos metadatos.
dimensions[]

object (DimensionMetadata)

Las descripciones de las dimensiones.
metrics[]

object (MetricMetadata)

Las descripciones de las métricas.
comparisons[]

object (ComparisonMetadata)

Las descripciones de la comparación.

Alcances de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

ComparisonMetadata

Los metadatos para una sola comparación.

Representación JSON 
{
  "apiName": string,
  "uiName": string,
  "description": string
}
Campos
apiName

string

Es el nombre del recurso de esta comparación. Se puede usar en el campo comparison de Comparison. Por ejemplo, "comparaciones/1234".
uiName

string

Es el nombre de esta comparación en la interfaz de usuario de Google Analytics.
description

string

Es la descripción de esta comparación.