Method: properties.getMetadata

Devuelve metadatos para 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 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/v1alpha/{name=properties/*/metadata}

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

Parámetros de ruta

Parámetros
name

string

Obligatorio. Es 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 de Google Analytics. Para obtener más información, consulta dónde encontrar el ID de tu propiedad.

Ejemplo: properties/1234/metadata

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

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Las dimensiones, las métricas y las comparaciones que se aceptan actualmente en los métodos de generación 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)
    }
  ],
  "conversions": [
    {
      object (ConversionMetadata)
    }
  ]
}
Campos
name

string

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

object (DimensionMetadata)

Son las descripciones de las dimensiones.
metrics[]

object (MetricMetadata)

Son las descripciones de las métricas.
comparisons[]

object (ComparisonMetadata)

Son las descripciones de la comparación.
conversions[]

object (ConversionMetadata)

Son las descripciones de las conversiones.

Permisos 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

DimensionMetadata

Explica una dimensión.

Representación JSON 
{
  "apiName": string,
  "uiName": string,
  "description": string,
  "deprecatedApiNames": [
    string
  ],
  "customDefinition": boolean,
  "category": string,
  "sections": [
    enum (Section)
  ]
}
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 la descripción de cómo se usa y calcula esta dimensión.
deprecatedApiNames[]

string

Nombres obsoletos, pero aún utilizables, para esta dimensión. Si se completa, esta dimensión está disponible por apiName o por uno de los deprecatedApiNames durante un período. Después del período de baja, la dimensión solo estará disponible a través de apiName.
customDefinition

boolean

Es verdadero si la dimensión es personalizada para esta propiedad. Esto incluye las dimensiones personalizadas con alcance de usuario, evento y elemento. Para obtener más información sobre las dimensiones personalizadas, consulta https://support.google.com/analytics/answer/14240153. Esto también incluye los grupos de canales personalizados. Para obtener más información sobre ellos, consulta https://support.google.com/analytics/answer/13051316.
category

string

Es el nombre visible de la categoría a la que pertenece esta dimensión. Las dimensiones y métricas similares se categorizan juntas.
sections[]

enum (Section)

Especifica las secciones de Google Analytics a las que se aplica esta dimensión.

MetricMetadata

Explica una métrica.

Representación 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

Es el nombre de una métrica. Se puede usar en el name de Metric. 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 la descripción de cómo se usa y calcula esta métrica.
deprecatedApiNames[]

string

Nombres obsoletos, pero aún utilizables, para esta métrica. Si se propaga, esta métrica está disponible por apiName o por uno de los deprecatedApiNames durante un período. Después del período de baja, la métrica solo estará disponible a través de apiName.
type

enum (MetricType)

Es el tipo de esta métrica.
expression

string

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

boolean

Es verdadero si la métrica es personalizada para esta propiedad.
blockedReasons[]

enum (BlockedReason)

Si se especifican motivos, se bloqueará tu acceso a esta métrica para esta propiedad. Las solicitudes a la API que envíes a esta propiedad para esta métrica se realizarán correctamente. Sin embargo, el informe solo contendrá ceros para esta métrica. Las solicitudes a la API con filtros de métricas en métricas bloqueadas fallarán. Si los motivos están vacíos, tienes acceso a esta métrica.

Para obtener más información, consulta Administración del acceso y de la restricción de datos.
category

string

Es el nombre visible de la categoría a la que pertenece esta métrica. Las dimensiones y métricas similares se categorizan juntas.
sections[]

enum (Section)

Especifica las secciones de Google Analytics a las que se aplica esta métrica.

BlockedReason

Son las justificaciones por las que se bloquea esta métrica.

Enums
BLOCKED_REASON_UNSPECIFIED Nunca se especificará en la respuesta de la API.
NO_REVENUE_METRICS Si está presente, se bloqueará tu acceso a las métricas relacionadas con los ingresos de esta propiedad, y esta métrica está relacionada con los ingresos.
NO_COST_METRICS Si está presente, se bloquea tu acceso a las métricas relacionadas con los costos de esta propiedad, y esta métrica está relacionada con los costos.

ComparisonMetadata

Son los metadatos de una sola comparación.

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

string

Nombre del recurso de esta comparación. Se puede usar en el campo comparison de Comparación. Por ejemplo, “comparisons/1234”.
uiName

string

Nombre de la comparación en la interfaz de usuario de Google Analytics.
description

string

Es la descripción de esta comparación.

ConversionMetadata

Son los metadatos de una sola conversión.

Representación JSON 
{
  "conversionAction": string,
  "displayName": string
}
Campos
conversionAction

string

Es el identificador único de la acción de conversión. Este ID se usa para especificar qué conversiones se deben incluir en un informe completando el campo conversionActions en el objeto ConversionsSpec de una solicitud de informe. Por ejemplo, "conversionActions/1234".
displayName

string

Nombre de la conversión en la interfaz de usuario de Google Analytics.