傳回報表方法中可用的維度和指標中繼資料。用於探索維度和指標。使用這個方法時,系統會在請求中指定 Google Analytics GA4 資源 ID,而中繼資料回應包含自訂維度和指標以及通用中繼資料。
舉例來說,如果將參數名稱為 levels_unlocked
的自訂指標註冊至某個資源,中繼資料回應就會包含 customEvent:levels_unlocked
。通用中繼資料是指適用於 country
和 totalUsers
等任何資源的維度和指標。
HTTP 要求
GET https://analyticsdata.googleapis.com/v1beta/{name=properties/*/metadata}
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 | |
---|---|
name |
必要欄位。要擷取中繼資料的資源名稱。這個名稱欄位是在網址路徑中指定,而不是網址參數。資源是數值型的 Google Analytics GA4 資源 ID。詳情請參閱「如何查看資源 ID」一文。 範例:properties/1234/metadata 對於所有資源通用的維度和指標,請將資源 ID 設為 0。在這個特殊模式中,這個方法不會傳回自訂維度和指標。 |
要求主體
要求主體必須為空白。
回應主體
目前在報表方法中接受的維度、指標和比較項目。
如果成功,回應主體會含有以下結構的資料:
JSON 表示法 |
---|
{ "name": string, "dimensions": [ { object ( |
欄位 | |
---|---|
name |
這項中繼資料的資源名稱。 |
dimensions[] |
維度說明。 |
metrics[] |
指標說明。 |
comparisons[] |
比較說明。 |
授權範圍
需要下列其中一種 OAuth 範圍:
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics
ComparisonMetadata
單一比較項目的中繼資料。
JSON 表示法 |
---|
{ "apiName": string, "uiName": string, "description": string } |
欄位 | |
---|---|
apiName |
|
uiName |
這是 Google Analytics 使用者介面中的比較名稱。 |
description |
這項比較的說明。 |