這種相容性方法會列出可加進報表請求並維持相容性的維度和指標。如果要求的維度和指標不相容,這個方法就會失敗。
在 Google Analytics (分析) 中,如果報表要求不相容的維度和/或指標,就會失敗;在這種情況下,您必須從不相容的報表中移除維度和/或指標,直到報表相容為止。
「即時」報表和「核心」報表有不同的相容性規則。這個方法會檢查核心報表的相容性。
HTTP 要求
POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:checkCompatibility
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 | |
---|---|
property |
追蹤事件的 Google Analytics (分析) GA4 資源 ID。詳情請參閱「如何查看資源 ID」一文。 範例:Properties/1234 |
要求主體
要求主體的資料會採用以下結構:
JSON 表示法 |
---|
{ "dimensions": [ { object ( |
欄位 | |
---|---|
dimensions[] |
這份報表中的維度。 |
metrics[] |
這份報表中的指標。 |
dimensionFilter |
維度的篩選器子句。 |
metricFilter |
指標的篩選器子句。 |
compatibilityFilter |
僅根據這個相容性篩選回應中的維度和指標。通常做為 |
回應主體
與每個維度和指標的相容性回應的相容性回應。
如果成功,回應主體即會包含具有以下結構的資料:
JSON 表示法 |
---|
{ "dimensionCompatibilities": [ { object ( |
欄位 | |
---|---|
dimensionCompatibilities[] |
各種維度的相容性。 |
metricCompatibilities[] |
各項指標的相容性。 |
授權範圍
需要下列其中一種 OAuth 範圍:
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics
相容性
單一維度或指標的相容性類型。
列舉 | |
---|---|
COMPATIBILITY_UNSPECIFIED |
未指定相容性。 |
COMPATIBLE |
維度或指標相容。這個維度或指標可成功加入報表。 |
INCOMPATIBLE |
維度或指標不相容。這個維度或指標無法成功加進報表。 |
DimensionCompatibility
單一維度的相容性。
JSON 表示法 |
---|
{ "dimensionMetadata": { object ( |
欄位 | |
---|---|
dimensionMetadata |
維度中繼資料包含這項相容性資訊的 API 名稱。維度中繼資料也會包含使用者介面名稱和說明等其他實用資訊。 |
compatibility |
這個維度的相容性。如果相容性是「COMPATIBLE」,系統就能夠成功將這個維度加入報表。 |
MetricCompatibility
單一指標的相容性。
JSON 表示法 |
---|
{ "metricMetadata": { object ( |
欄位 | |
---|---|
metricMetadata |
指標中繼資料包含這項相容性資訊的 API 名稱。指標中繼資料也會包含 UI 名稱和說明等其他實用資訊。 |
compatibility |
這項指標的相容性。如果相容性為「COMPATIBLE」,系統就可成功將這項指標加入報表。 |