Method: properties.getMetadata

보고 메서드에서 사용할 수 있는 측정기준 및 측정항목의 메타데이터를 반환합니다. 측정기준과 측정항목을 탐색하는 데 사용됩니다. 이 메서드에서는 Google 애널리틱스 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 애널리틱스 GA4 속성 식별자입니다. 자세한 내용은 속성 ID를 찾을 수 있는 위치를 참고하세요.

예: property/1234/metadata

모든 속성에 공통된 측정기준 및 측정항목에 대해서는 속성 ID를 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

DimensionMetadata

측정기준을 설명합니다.

JSON 표현 
{
  "apiName": string,
  "uiName": string,
  "description": string,
  "deprecatedApiNames": [
    string
  ],
  "customDefinition": boolean
}
필드
apiName

string

이 측정기준의 이름입니다. 측정기준의 name에서 사용할 수 있습니다. eventName를 예로 들 수 있습니다.
uiName

string

Google 애널리틱스 사용자 인터페이스 내에서 표시되는 측정기준의 이름입니다. 예를 들면 Event name입니다.
description

string

이 측정기준을 사용하고 계산하는 방법에 대한 설명입니다.
deprecatedApiNames[]

string

이 측정기준에 여전히 사용 가능하지만 지원 중단된 이름입니다. 채워진 경우 이 측정기준은 apiName 또는 일정 기간 동안 deprecatedApiNames 중 하나에서 사용할 수 있습니다. 지원 중단 기간이 지나면 apiName에서만 이 측정기준을 사용할 수 있습니다.
customDefinition

boolean

측정기준이 이 속성의 맞춤 측정기준인 경우 true입니다.

MetricMetadata

측정항목을 설명합니다.

JSON 표현 
{
  "apiName": string,
  "uiName": string,
  "description": string,
  "deprecatedApiNames": [
    string
  ],
  "type": enum (MetricType),
  "expression": string,
  "customDefinition": boolean
}
필드
apiName

string

측정항목 이름 측정항목의 name에서 사용할 수 있습니다. eventCount를 예로 들 수 있습니다.
uiName

string

Google 애널리틱스 사용자 인터페이스 내에 표시되는 이 측정항목의 이름입니다. 예를 들면 Event count입니다.
description

string

이 측정항목의 사용 및 계산 방식에 대한 설명입니다.
deprecatedApiNames[]

string

이 측정항목에 여전히 사용 가능하지만 지원 중단된 이름입니다. 채워지면 이 측정항목은 apiName 또는 일정 기간 동안 deprecatedApiNames 중 하나에서 사용할 수 있습니다. 지원 중단 기간이 지나면 apiName까지만 측정항목을 사용할 수 있습니다.
type

enum (MetricType)

이 측정항목의 유형입니다.
expression

string

파생된 측정항목의 수학 표현식입니다. 동등한 보고서의 측정항목 expression 필드에서 사용할 수 있습니다. 대부분의 측정항목은 표현식이 아니며, 표현식이 아닌 경우 이 필드가 비어 있습니다.
customDefinition

boolean

측정항목이 이 속성의 맞춤 측정항목인 경우 true입니다.