Method: properties.checkCompatibility

Este método enumera las dimensiones y las métricas que se pueden agregar a una solicitud de informe y mantener su compatibilidad. Este método falla si las dimensiones y las métricas de la solicitud son incompatibles.

En Google Analytics, los informes fallan si solicitan dimensiones o métricas incompatibles. En ese caso, deberá quitar dimensiones o métricas del informe hasta que sea compatible.

Los informes En tiempo real y Principal tienen reglas de compatibilidad diferentes. Este método verifica la compatibilidad de los informes principales.

Solicitud HTTP

POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:checkCompatibility

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

Parámetros de ruta de acceso

Parámetros
property

string

Es un identificador de propiedad GA4 de Google Analytics cuyos eventos se rastrean. Para obtener más información, consulta dónde encontrar tu ID de propiedad. property debe ser el mismo valor que en la solicitud runReport.

Ejemplo: properties/1234

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON
{
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "compatibilityFilter": enum (Compatibility)
}
Campos
dimensions[]

object (Dimension)

Son las dimensiones de este informe. dimensions debe ser el mismo valor que en la solicitud runReport.

metrics[]

object (Metric)

Las métricas de este informe. metrics debe ser el mismo valor que en la solicitud runReport.

dimensionFilter

object (FilterExpression)

La cláusula de filtro de las dimensiones. dimensionFilter debe ser el mismo valor que en la solicitud runReport.

metricFilter

object (FilterExpression)

La cláusula de filtro de las métricas. metricFilter debe ser el mismo valor que en la solicitud runReport

compatibilityFilter

enum (Compatibility)

Filtra las dimensiones y las métricas solo en respuesta a esta compatibilidad. Por lo general, se usa como ”compatibilityFilter”: “COMPATIBLE” para mostrar solo dimensiones y métricas compatibles.

Cuerpo de la respuesta

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

La respuesta de compatibilidad con la compatibilidad de cada dimensión y métrica.

Representación JSON
{
  "dimensionCompatibilities": [
    {
      object (DimensionCompatibility)
    }
  ],
  "metricCompatibilities": [
    {
      object (MetricCompatibility)
    }
  ]
}
Campos
dimensionCompatibilities[]

object (DimensionCompatibility)

La compatibilidad de cada dimensión.

metricCompatibilities[]

object (MetricCompatibility)

La compatibilidad de cada métrica

Permisos de autorización

Se necesita uno de los siguientes alcances de OAuth:

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

Compatibilidad

Los tipos de compatibilidad para una sola dimensión o métrica.

Enumeradores
COMPATIBILITY_UNSPECIFIED Compatibilidad sin especificar.
COMPATIBLE La dimensión o la métrica son compatibles. Esta dimensión o métrica se puede agregar correctamente a un informe.
INCOMPATIBLE La dimensión o la métrica no son compatibles. Esta dimensión o métrica no se puede agregar correctamente a un informe.

Compatibilidad de la dimensión

La compatibilidad para una sola dimensión.

Representación JSON
{
  "dimensionMetadata": {
    object (DimensionMetadata)
  },
  "compatibility": enum (Compatibility)
}
Campos
dimensionMetadata

object (DimensionMetadata)

Los metadatos de dimensión contienen el nombre de la API para esta información de compatibilidad. Los metadatos de dimensión también contienen otra información útil, como el nombre y la descripción de la IU.

compatibility

enum (Compatibility)

La compatibilidad de esta dimensión. Si la compatibilidad es COMPATIBLE, se puede agregar correctamente esta dimensión al informe.

Compatibilidad con métricas

La compatibilidad de una sola métrica.

Representación JSON
{
  "metricMetadata": {
    object (MetricMetadata)
  },
  "compatibility": enum (Compatibility)
}
Campos
metricMetadata

object (MetricMetadata)

Los metadatos de la métrica contienen el nombre de la API para esta información de compatibilidad. Los metadatos de la métrica también contienen otra información útil, como el nombre y la descripción de la IU.

compatibility

enum (Compatibility)

La compatibilidad de esta métrica. Si la compatibilidad es COMPATIBLE, esta métrica se puede agregar correctamente al informe.