- HTTP-запрос
- Параметры пути
- Тело запроса
- Тело ответа
- Области авторизации
- Метаданные измерения
- МетрикаМетаданные
- Попробуй это!
Возвращает метаданные для параметров и показателей, доступных в методах отчетности. Используется для изучения параметров и показателей. В этом методе в запросе указывается идентификатор свойства Google Analytics GA4, а ответ метаданных включает специальные параметры и показатели, а также универсальные метаданные.
Например, если в свойстве зарегистрирована специальная метрика с именем параметра levels_unlocked
, ответ метаданных будет содержать customEvent:levels_unlocked
. Универсальные метаданные — это параметры и показатели, применимые к любому свойству, например country
и totalUsers
.
HTTP-запрос
GET https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/metadata}
URL-адрес использует синтаксис транскодирования gRPC .
Параметры пути
Параметры | |
---|---|
name | Необходимый. Имя ресурса метаданных, которые необходимо получить. Это поле имени указывается в URL-пути, а не в параметрах URL-адреса. Ресурс – это числовой идентификатор ресурса Google Analytics GA4. Чтобы узнать больше, посмотрите , где найти свой идентификатор объекта . Пример: свойства/1234/метаданные Установите для идентификатора свойства значение 0 для параметров и показателей, общих для всех свойств. В этом специальном режиме этот метод не возвращает специальные параметры и показатели. |
Тело запроса
Тело запроса должно быть пустым.
Тело ответа
В случае успеха тело ответа содержит данные следующей структуры:
Параметры и показатели, которые в настоящее время принимаются в методах отчетности.
JSON-представление | |
---|---|
{ "name": string, "dimensions": [ { object ( |
Поля | |
---|---|
name | Имя ресурса этих метаданных. |
dimensions[] | Описания размеров. |
metrics[] | Описание метрик. |
Области авторизации
Требуется одна из следующих областей 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 | Имя этого измерения. Можно использовать в |
uiName | Название этого параметра в пользовательском интерфейсе Google Analytics. Например, |
description | Описание того, как этот параметр используется и рассчитывается. |
deprecatedApiNames[] | Все еще пригодные, но устаревшие имена для этого измерения. Если это измерение заполнено, оно доступно либо по |
customDefinition | Значение true, если измерение является пользовательским для этого свойства. |
МетрикаМетаданные
Объясняет метрику.
JSON-представление | |
---|---|
{
"apiName": string,
"uiName": string,
"description": string,
"deprecatedApiNames": [
string
],
"type": enum ( |
Поля | |
---|---|
apiName | Имя метрики. Используется в |
uiName | Название этого показателя в пользовательском интерфейсе Google Analytics. Например, |
description | Описание того, как эта метрика используется и рассчитывается. |
deprecatedApiNames[] | По-прежнему используемые, но устаревшие имена для этой метрики. Если эта метрика заполнена, она доступна либо по |
type | Тип этой метрики. |
expression | Математическое выражение для этой производной метрики. Может использоваться в поле |
customDefinition | Значение true, если метрика является специальной метрикой для этого свойства. |