Method: properties.getMetadata

Возвращает метаданные для измерений и показателей, доступных в методах отчетности. Используется для изучения измерений и показателей. В этом методе в запросе указывается идентификатор свойства Google Analytics, а ответ с метаданными включает пользовательские измерения и показатели, а также универсальные метаданные.

Например, если к свойству зарегистрирована пользовательская метрика с параметром levels_unlocked , ответ Metadata будет содержать customEvent:levels_unlocked . Универсальные метаданные — это измерения и метрики, применимые к любому свойству, например, к country и totalUsers .

HTTP-запрос

GET https://analyticsdata.googleapis.com/v1beta/{name=properties/*/metadata}

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

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

Параметры
name

string

Обязательное поле. Имя ресурса метаданных для получения. Это поле указывается в пути URL-адреса, а не в параметрах URL. Property — это числовой идентификатор ресурса Google Analytics. Чтобы узнать больше, см. раздел «Где найти идентификатор вашего ресурса» .

Пример: properties/1234/metadata

Установите идентификатор свойства равным 0 для параметров и показателей, общих для всех свойств. В этом специальном режиме данный метод не будет возвращать пользовательские параметры и показатели.

Текст запроса

Тело запроса должно быть пустым.

Ответный текст

Размеры, показатели и сравнения, в настоящее время принятые в методах отчетности.

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

JSON-представление 
{
  "name": string,
  "dimensions": [
    {
      object (DimensionMetadata)
    }
  ],
  "metrics": [
    {
      object (MetricMetadata)
    }
  ],
  "comparisons": [
    {
      object (ComparisonMetadata)
    }
  ]
}
Поля
name

string

Название ресурса этих метаданных.

dimensions[]

object ( DimensionMetadata )

Описание размеров.

metrics[]

object ( MetricMetadata )

Описание метрик.

comparisons[]

object ( ComparisonMetadata )

Сравнительные описания.

Области полномочий

Требуется один из следующих диапазонов аутентификации OAuth:

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

Сравнительные метаданные

Метаданные для отдельного сравнения.

JSON-представление 
{
  "apiName": string,
  "uiName": string,
  "description": string
}
Поля
apiName

string

Имя ресурса для этого сравнения. Может использоваться в поле comparison в параметре « Сравнение ». Например, 'comparisons/1234'.

uiName

string

Название этого сравнения в пользовательском интерфейсе Google Analytics.

description

string

Описание данного сравнения.