Method: properties.getMetadata

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

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

HTTP-запрос

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

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

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

Параметры
name

string

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

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

Установите для идентификатора свойства значение 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
}
Поля
api Name

string

Имя ресурса этого сравнения. Используется в поле comparison Comparison . Например, «сравнения/1234».

ui Name

string

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

description

string

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

,

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

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

HTTP-запрос

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

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

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

Параметры
name

string

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

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

Установите для идентификатора свойства значение 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
}
Поля
api Name

string

Имя ресурса этого сравнения. Используется в поле comparison Comparison . Например, «сравнения/1234».

ui Name

string

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

description

string

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

,

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

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

HTTP-запрос

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

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

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

Параметры
name

string

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

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

Установите для идентификатора свойства значение 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
}
Поля
api Name

string

Имя ресурса этого сравнения. Используется в поле comparison Comparison . Например, «сравнения/1234».

ui Name

string

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

description

string

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

,

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

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

HTTP-запрос

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

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

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

Параметры
name

string

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

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

Установите для идентификатора свойства значение 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
}
Поля
api Name

string

Имя ресурса этого сравнения. Используется в поле comparison Comparison . Например, «сравнения/1234».

ui Name

string

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

description

string

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