보고 방법에서 사용할 수 있는 측정기준 및 측정항목에 대한 메타데이터를 반환합니다. 측정기준 및 측정항목을 탐색하는 데 사용됩니다. 이 메서드에서 Google 애널리틱스 GA4 속성 식별자가 요청에 지정되며, 메타데이터 응답에는 맞춤 측정기준 및 측정항목과 유니버설 메타데이터가 포함됩니다.
예를 들어 매개변수 이름이 levels_unlocked
인 맞춤 측정항목이 속성에 등록되면 메타데이터 응답에 customEvent:levels_unlocked
가 포함됩니다. 범용 메타데이터는 country
및 totalUsers
와 같은 모든 속성에 적용할 수 있는 측정기준 및 측정항목입니다.
HTTP 요청
GET https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/metadata}
URL은 gRPC 트랜스코딩 구문을 사용합니다.
경로 매개변수
매개변수 | |
---|---|
name |
필수 항목입니다. 검색할 메타데이터의 리소스 이름입니다. 이 이름 필드는 URL 매개변수가 아니라 URL 경로에 지정됩니다. 속성은 숫자로 된 Google 애널리틱스 GA4 속성 식별자입니다. 자세한 내용은 속성 ID를 찾을 수 있는 위치를 참고하세요. 예: properties/1234/metadata 모든 속성에 공통적인 측정기준 및 측정항목의 경우 속성 ID를 0으로 설정합니다. 이 특수 모드에서는 이 메서드가 맞춤 측정기준 및 측정항목을 반환하지 않습니다. |
요청 본문
요청 본문은 비어 있어야 합니다.
응답 본문
성공할 경우 응답 본문에 다음 구조의 데이터가 포함됩니다.
보고 방법에 현재 허용되는 측정기준 및 측정항목입니다.
JSON 표현 | |
---|---|
{ "name": string, "dimensions": [ { object ( |
입력란 | |
---|---|
name |
이 메타데이터의 리소스 이름입니다. |
dimensions[] |
측정기준에 대한 설명입니다. |
metrics[] |
측정항목에 대한 설명입니다. |
승인 범위
다음 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 |
측정기준의 이름입니다. 측정기준의 |
uiName |
Google 애널리틱스 사용자 인터페이스 내의 측정기준 이름입니다. 예를 들면 다음과 같습니다. |
description |
이 측정기준이 사용되고 계산되는 방법에 대한 설명입니다. |
deprecatedApiNames[] |
이 측정기준에 여전히 사용 가능하지만 지원 중단된 이름입니다. 채워지면 이 측정기준은 |
customDefinition |
측정기준이 이 속성의 맞춤 측정기준인 경우 true입니다. |
MetricMetadata
측정항목을 설명합니다.
JSON 표현 | |
---|---|
{
"apiName": string,
"uiName": string,
"description": string,
"deprecatedApiNames": [
string
],
"type": enum ( |
입력란 | |
---|---|
apiName |
측정항목 이름 Metric의 |
uiName |
Google 애널리틱스 사용자 인터페이스 내의 이 측정항목의 이름입니다. 예를 들면 다음과 같습니다. |
description |
이 측정항목의 사용 및 계산 방법에 대한 설명입니다. |
deprecatedApiNames[] |
이 측정항목의 이름은 계속 사용 가능하지만 지원 중단되었습니다. 이 측정항목이 채워지면 |
type |
이 측정항목의 유형입니다. |
expression |
이 파생 측정항목의 수학 표현식입니다. 상응하는 보고서의 측정항목의 |
customDefinition |
측정항목이 이 속성의 맞춤 측정항목인 경우 true입니다. |