Method: properties.checkCompatibility

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

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

Los informes En tiempo real y principales tienen diferentes reglas de compatibilidad. 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 la propiedad GA4 de Google Analytics de cuyos eventos se hace un seguimiento. Para obtener más información, consulta dónde encontrar tu ID de propiedad. property debe tener el mismo valor que el de tu 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 tener el mismo valor que el de tu solicitud runReport.

metrics[]

object (Metric)

Las métricas de este informe. metrics debe tener el mismo valor que el de tu solicitud runReport.

dimensionFilter

object (FilterExpression)

La cláusula de filtro de las dimensiones. dimensionFilter debe tener el mismo valor que el de tu solicitud runReport.

metricFilter

object (FilterExpression)

La cláusula de filtro de las métricas. metricFilter debe tener el mismo valor que el de tu solicitud runReport.

compatibilityFilter

enum (Compatibility)

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

Cuerpo de la respuesta

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

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

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

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

Enumeradores
COMPATIBILITY_UNSPECIFIED Compatibilidad no especificada.
COMPATIBLE La dimensión o métrica es compatible. Esta dimensión o métrica se puede agregar correctamente a un informe.
INCOMPATIBLE La dimensión o métrica no es compatible. Esta dimensión o métrica no se puede agregar correctamente a un informe.

DimensionCompatibility

La compatibilidad para una sola dimensión.

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

object (DimensionMetadata)

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

compatibility

enum (Compatibility)

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

MetricCompatibility

La compatibilidad con 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 sobre la 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)

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