Method: properties.getMetadata

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

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

HTTP 요청

GET https://analyticsdata.googleapis.com/v1alpha/{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)
    }
  ],
  "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

DimensionMetadata

측정기준을 설명합니다.

JSON 표현 
{
  "apiName": string,
  "uiName": string,
  "description": string,
  "deprecatedApiNames": [
    string
  ],
  "customDefinition": boolean,
  "category": string,
  "sections": [
    enum (Section)
  ]
}
필드
apiName

string

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

string

Google 애널리틱스 사용자 인터페이스 내의 이 측정기준 이름입니다. 예를 들면 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 애널리틱스 섹션을 지정합니다.

MetricMetadata

측정항목을 설명합니다.

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 애널리틱스 사용자 인터페이스 내의 측정항목 이름입니다. 예를 들면 Event count입니다.
description

string

이 측정항목이 사용되고 계산되는 방식에 관한 설명입니다.
deprecatedApiNames[]

string

여전히 사용할 수 있지만 지원 중단된 이 측정항목의 이름입니다. 값이 입력된 경우 이 측정항목은 일정 기간 동안 apiName 또는 deprecatedApiNames 중 하나로 사용할 수 있습니다. 지원 중단 기간이 지나면 apiName을 통해서만 측정항목을 사용할 수 있습니다.
type

enum (MetricType)

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

string

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

boolean

측정항목이 이 속성의 맞춤 측정항목인 경우 True입니다.
blockedReasons[]

enum (BlockedReason)

이유가 지정되면 이 속성에 대한 이 측정항목에 대한 액세스가 차단됩니다. 이 측정항목에 대해 이 속성으로 전송하는 API 요청은 성공하지만 보고서에는 이 측정항목에 대해 0만 포함됩니다. 차단된 측정항목에 측정항목 필터가 있는 API 요청은 실패합니다. 이유가 비어 있으면 이 측정항목에 액세스할 수 있습니다.

자세한 내용은 액세스 및 데이터 제한 관리를 참고하세요.
category

string

이 측정항목이 속한 카테고리의 표시 이름입니다. 유사한 측정기준과 측정항목은 함께 분류됩니다.
sections[]

enum (Section)

이 측정항목이 적용되는 Google 애널리틱스 섹션을 지정합니다.

BlockedReason

이 측정항목이 차단된 이유입니다.

열거형
BLOCKED_REASON_UNSPECIFIED API 응답에 지정되지 않습니다.
NO_REVENUE_METRICS 이 속성의 수익 관련 측정항목에 대한 액세스가 차단되어 있으며 이 측정항목은 수익과 관련되어 있습니다.
NO_COST_METRICS 이 속성의 비용 관련 측정항목에 대한 액세스가 차단되었으며 이 측정항목이 비용과 관련되어 있습니다.

ComparisonMetadata

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

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

string

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

string

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

string

이 비교의 설명입니다.

ConversionMetadata

단일 전환의 메타데이터입니다.

JSON 표현 
{
  "conversionAction": string,
  "displayName": string
}
필드
conversionAction

string

전환 액션의 고유 식별자입니다. 이 ID는 보고서 요청의 ConversionsSpec에서 conversionActions 필드를 채워 보고서에 포함할 전환을 지정하는 데 사용됩니다. 예를 들어 'conversionActions/1234'입니다.
displayName

string

Google 애널리틱스 사용자 인터페이스 내의 이 전환 이름입니다.