Method: properties.getMetadata

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

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

HTTP-запрос

GET https://analyticsdata.googleapis.com/v1alpha/{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)
    }
  ],
  "conversions": [
    {
      object (ConversionMetadata)
    }
  ]
}
Поля
name

string

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

dimensions[]

object ( DimensionMetadata )

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

metrics[]

object ( MetricMetadata )

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

comparisons[]

object ( ComparisonMetadata )

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

conversions[]

object ( ConversionMetadata )

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

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

Требуется один из следующих диапазонов аутентификации 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,
  "category": string,
  "sections": [
    enum (Section)
  ]
}
Поля
apiName

string

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

uiName

string

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

description

string

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

deprecatedApiNames[]

string

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

customDefinition

boolean

Значение true, если измерение является пользовательским для этого свойства. Это включает пользовательские измерения, относящиеся к пользователю, событию и элементу; чтобы узнать больше о пользовательских измерениях, см. https://support.google.com/analytics/answer/14240153 . Это также включает пользовательские группы каналов; чтобы узнать больше о пользовательских группах каналов, см. https://support.google.com/analytics/answer/13051316 .

category

string

Отображаемое название категории, к которой относится данное измерение. Похожие измерения и показатели объединяются в одну категорию.

sections[]

enum ( Section )

Указывает разделы Google Analytics, к которым применяется данный параметр.

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

Объясняет значение показателя.

JSON-представление 
{
  "apiName": string,
  "uiName": string,
  "description": string,
  "deprecatedApiNames": [
    string
  ],
  "type": enum (MetricType),
  "expression": string,
  "customDefinition": boolean,
  "blockedReasons": [
    enum (BlockedReason)
  ],
  "category": string,
  "sections": [
    enum (Section)
  ]
}
Поля
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, если метрика является пользовательской метрикой для этого свойства.

blockedReasons[]

enum ( BlockedReason )

Если указаны причины, ваш доступ к этому показателю для этого свойства заблокирован. Ваши API-запросы к этому свойству для этого показателя будут успешными; однако отчет будет содержать только нули для этого показателя. API-запросы с фильтрами по заблокированным показателям будут завершаться с ошибкой. Если причины не указаны, у вас есть доступ к этому показателю.

Для получения более подробной информации см. раздел «Управление доступом и ограничением доступа к данным» .

category

string

Отображаемое название категории, к которой относится данный показатель. Похожие измерения и показатели объединяются в одну категорию.

sections[]

enum ( Section )

Указывает разделы Google Analytics, к которым применяется этот показатель.

BlockedReason

Обоснование блокировки данного показателя.

Перечисления
BLOCKED_REASON_UNSPECIFIED Этот параметр никогда не будет указан в ответе API.
NO_REVENUE_METRICS Если этот показатель присутствует, ваш доступ к показателям, связанным с доходами данного объекта недвижимости, блокируется, а данный показатель связан с доходами.
NO_COST_METRICS Если такая информация присутствует, ваш доступ к показателям, связанным с затратами на данный объект недвижимости, блокируется, и этот показатель относится к категории показателей, связанных с затратами.

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

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

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

string

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

uiName

string

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

description

string

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

Метаданные конверсии

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

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

string

Уникальный идентификатор действия преобразования. Этот идентификатор используется для указания того, какие преобразования следует включить в отчет, путем заполнения поля conversionActions в ConversionsSpec запроса отчета. Например, 'conversionActions/1234'.

displayName

string

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