Method: properties.getMetadata

보고 메서드에서 사용할 수 있는 측정기준 및 측정항목의 메타데이터를 반환합니다. 측정기준 및 측정항목을 탐색하는 데 사용됩니다. 이 메서드에서는 Google 애널리틱스 속성 식별자가 요청에 지정되고 메타데이터 응답에는 맞춤 측정기준 및 측정항목과 함께 유니버설 메타데이터가 포함됩니다.

예를 들어 매개변수 이름이 levels_unlocked인 맞춤 측정항목이 속성에 등록된 경우 메타데이터 응답에는 customEvent:levels_unlocked이 포함됩니다. 범용 메타데이터는 country 및 totalUsers와 같은 모든 속성에 적용할 수 있는 측정기준 및 측정항목입니다.

HTTP 요청

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

URL은 gRPC 트랜스코딩 문법을 사용합니다.

경로 매개변수

매개변수
name

string

필수 항목입니다. 검색할 메타데이터의 리소스 이름입니다. 이 이름 필드는 URL 매개변수가 아닌 URL 경로에 지정됩니다. 속성은 숫자로 된 Google 애널리틱스 속성 식별자입니다. 자세한 내용은 속성 ID를 찾을 수 있는 위치를 참고하세요.

예: properties/1234/metadata

모든 속성에 공통적인 측정기준 및 측정항목의 속성 ID를 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

ComparisonMetadata

단일 비교의 메타데이터입니다.

JSON 표현 
{
  "apiName": string,
  "uiName": string,
  "description": string
}
필드
apiName

string

이 비교의 리소스 이름입니다. 비교의 comparison 필드에서 사용할 수 있습니다. 예를 들어 'comparisons/1234'입니다.
uiName

string

Google 애널리틱스 사용자 인터페이스 내에서 이 비교의 이름입니다.
description

string

이 비교에 대한 설명입니다.