Method: properties.getMetadata

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

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

HTTP-запрос

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

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

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

Параметры
name

string

Необходимый. Имя ресурса метаданных, которые необходимо получить. Это поле имени указывается в URL-пути, а не в параметрах URL-адреса. Ресурс – это числовой идентификатор ресурса Google Analytics GA4. Чтобы узнать больше, посмотрите , где найти свой идентификатор объекта .

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

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

Тело запроса

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

Тело ответа

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

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

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

string

Имя ресурса этих метаданных.

dimensions[]

object ( DimensionMetadata )

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

metrics[]

object ( MetricMetadata )

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

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

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

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

Метаданные измерения

Объясняет размер.

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

string

Имя этого измерения. Можно использовать в name измерения . Например, eventName .

uiName

string

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

description

string

Описание того, как этот параметр используется и рассчитывается.

deprecatedApiNames[]

string

Все еще пригодные, но устаревшие имена для этого измерения. Если это измерение заполнено, оно доступно либо по apiName , либо по одному из deprecatedApiNames в течение определенного периода времени. По истечении периода прекращения поддержки измерение будет доступно только через apiName .

customDefinition

boolean

Значение true, если измерение является пользовательским для этого свойства.

МетрикаМетаданные

Объясняет метрику.

JSON-представление
{
  "apiName": string,
  "uiName": string,
  "description": string,
  "deprecatedApiNames": [
    string
  ],
  "type": enum (MetricType),
  "expression": string,
  "customDefinition": boolean
}
Поля
apiName

string

Имя метрики. Используется в name Метрики . Например, eventCount .

uiName

string

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

description

string

Описание того, как эта метрика используется и рассчитывается.

deprecatedApiNames[]

string

По-прежнему используемые, но устаревшие имена для этой метрики. Если эта метрика заполнена, она доступна либо по apiName , либо по одному из deprecatedApiNames в течение определенного периода времени. После периода прекращения поддержки метрика будет доступна только по apiName .

type

enum ( MetricType )

Тип этой метрики.

expression

string

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

customDefinition

boolean

Значение true, если метрика является специальной метрикой для этого свойства.