Method: properties.customMetrics.list
HTTP 要求
GET https://analyticsadmin.googleapis.com/v1alpha/{parent=properties/*}/customMetrics
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 |
parent |
string
必要欄位。格式範例:properties/1234
|
查詢參數
參數 |
pageSize |
integer
要傳回的資源數量上限。如未指定,系統會傳回最多 50 項資源。最大值為 200 (較高的值會強制設為最大值)。
|
pageToken |
string
屬於接收自前一個 customMetrics.list 呼叫的網頁權杖。提供此項目即可擷取後續網頁。 進行分頁時,提供至 customMetrics.list 的所有其他參數須與提供網頁權杖的呼叫相符。
|
回應主體
customMetrics.list RPC 的回應訊息。
如果成功,回應主體會含有以下結構的資料:
JSON 表示法 |
{
"customMetrics": [
{
object (CustomMetric )
}
],
"nextPageToken": string
} |
欄位 |
customMetrics[] |
object (CustomMetric )
自訂指標清單。
|
nextPageToken |
string
可做為 pageToken 傳送的權杖,用於擷取後續網頁。如果省略這個欄位,就不會有後續頁面。
|
授權範圍
需要下列其中一種 OAuth 範圍:
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics.edit
除非另有註明,否則本頁面中的內容是採用創用 CC 姓名標示 4.0 授權,程式碼範例則為阿帕契 2.0 授權。詳情請參閱《Google Developers 網站政策》。Java 是 Oracle 和/或其關聯企業的註冊商標。
上次更新時間:2025-01-14 (世界標準時間)。
[null,null,["上次更新時間:2025-01-14 (世界標準時間)。"],[[["Lists all the CustomMetrics defined for a Google Analytics 4 property."],["The API request requires specifying the parent property ID and supports pagination for retrieving large result sets."],["The response includes a list of CustomMetrics objects and a token for accessing the next page of results, if available."],["Requires authorization with either read-only or edit access to Google Analytics."]]],["This document details how to list custom metrics for a property using the Google Analytics Admin API. A `GET` HTTP request is sent to a specific URL, including a required `parent` path parameter (e.g., \"properties/1234\"). Optional query parameters `pageSize` (max 200) and `pageToken` are used for pagination. The request body must be empty. A successful response returns a JSON object containing an array of `customMetrics` and an optional `nextPageToken` for retrieving subsequent pages. Authorization requires specific OAuth scopes.\n"]]