Method: properties.checkCompatibility

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

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

Для отчетов в режиме реального времени и основных отчетов действуют разные правила совместимости. Данный метод проверяет совместимость с основными отчетами.

HTTP-запрос

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

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

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

Параметры
property

string

Идентификатор ресурса Google Analytics, события которого отслеживаются. Для получения дополнительной информации см. раздел «Где найти идентификатор ресурса» . Значение property должно совпадать со значением в запросе runReport .

Пример: properties/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 )

Значение параметра filter в dimensionFilter dimensions.dimensionFilter должно совпадать со значением в вашем запросе runReport .

metricFilter

object ( FilterExpression )

Значение параметра filter в 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 )

Совместимость данного параметра. Если совместимость установлена ​​на COMPATIBLE, этот параметр может быть успешно добавлен в отчет.

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

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

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

object ( MetricMetadata )

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

compatibility

enum ( Compatibility )

Совместимость данного показателя. Если совместимость подтверждена (COMPATIBLE), этот показатель может быть успешно добавлен в отчет.