Method: properties.checkCompatibility

Этот метод совместимости перечисляет параметры и показатели, которые можно добавить в запрос отчета и обеспечить совместимость. Этот метод не работает, если параметры и показатели запроса несовместимы.

В Google Analytics отчеты не работают, если они запрашивают несовместимые параметры и/или показатели; в этом случае вам придется удалить параметры и/или показатели из несовместимого отчета, пока отчет не станет совместимым.

Отчеты Realtime и Core имеют разные правила совместимости. Этот метод проверяет совместимость основных отчетов.

HTTP-запрос

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

URL-адрес использует синтаксис транскодирования gRPC .

Параметры пути

Параметры
property

string

Идентификатор ресурса Google Analytics GA4, события которого отслеживаются. Чтобы узнать больше, посмотрите , где найти свой идентификатор объекта . property должно иметь то же значение, что и в вашем запросе runReport .

Пример: свойства/1234

Тело запроса

Тело запроса содержит данные следующей структуры:

JSON-представление 
{
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "compatibilityFilter": enum (Compatibility)
}
Поля
dimensions[]

object ( Dimension )

Размеры в этом отчете. dimensions должны иметь то же значение, что и в вашем запросе runReport .

metrics[]

object ( Metric )

Показатели в этом отчете. metrics должны иметь то же значение, что и в вашем запросе runReport .

dimensionFilter

object ( FilterExpression )

Предложение фильтра измерений. dimensionFilter должно иметь то же значение, что и в вашем запросе runReport .

metricFilter

object ( FilterExpression )

Предложение фильтра метрик. metricFilter должен иметь то же значение, что и в вашем запросе runReport .

compatibilityFilter

enum ( Compatibility )

Фильтрует параметры и показатели в ответ только на эту совместимость. Обычно используется как ”compatibilityFilter”: “COMPATIBLE” чтобы возвращать только совместимые параметры и показатели.

Тело ответа

Ответ совместимости с совместимостью каждого параметра и показателя.

В случае успеха тело ответа содержит данные следующей структуры:

JSON-представление 
{
  "dimensionCompatibilities": [
    {
      object (DimensionCompatibility)
    }
  ],
  "metricCompatibilities": [
    {
      object (MetricCompatibility)
    }
  ]
}
Поля
dimensionCompatibilities[]

object ( DimensionCompatibility )

Совместимость каждого измерения.

metricCompatibilities[]

object ( MetricCompatibility )

Совместимость каждой метрики.

Области авторизации

Требуется одна из следующих областей OAuth:

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

Совместимость

Типы совместимости для одного параметра или показателя.

Перечисления
COMPATIBILITY_UNSPECIFIED Неуказанная совместимость.
COMPATIBLE Параметр или показатель совместимы. Этот параметр или показатель можно успешно добавить в отчет.
INCOMPATIBLE Параметр или показатель несовместим. Этот параметр или показатель невозможно добавить в отчет.

РазмерСовместимость

Совместимость для одного измерения.

JSON-представление 
{
  "dimensionMetadata": {
    object (DimensionMetadata)
  },
  "compatibility": enum (Compatibility)
}
Поля
dimensionMetadata

object ( DimensionMetadata )

Метаданные измерения содержат имя API для этой информации о совместимости. Метаданные измерения также содержат другую полезную информацию, например имя и описание пользовательского интерфейса.

compatibility

enum ( Compatibility )

Совместимость этого измерения. Если совместимость СОВМЕСТИМА, этот параметр можно успешно добавить в отчет.

Метрическая совместимость

Совместимость для одной метрики.

JSON-представление 
{
  "metricMetadata": {
    object (MetricMetadata)
  },
  "compatibility": enum (Compatibility)
}
Поля
metricMetadata

object ( MetricMetadata )

Метаданные метрики содержат имя API для этой информации о совместимости. Метаданные метрики также содержат другую полезную информацию, такую ​​как имя и описание пользовательского интерфейса.

compatibility

enum ( Compatibility )

Совместимость этой метрики. Если совместимость СОВМЕСТИМА, эту метрику можно успешно добавить в отчет.