Method: properties.list

傳回指定父項帳戶底下的子資源。

只會傳回「GA4」屬性。如果來電者沒有存取權,系統就會排除屬性。根據預設,系統會刪除虛刪除 (例如:「trashed」) 屬性。如果找不到相關屬性,則傳回空白清單。

HTTP 要求

GET https://analyticsadmin.googleapis.com/v1beta/properties

此網址使用 gRPC 轉碼語法。

查詢參數

參數
filter

string

必要,用於篩選要求結果的運算式。適用篩選功能的欄位包括:parent:(上層帳戶/資源的資源名稱) 或 ancestor:(上層帳戶的資源名稱) 或 firebase_project:(已連結 Firebase 專案的 ID 或號碼)。以下列舉幾個篩選器:

| Filter                      | Description                               |
|-----------------------------|-------------------------------------------|
| parent:accounts/123         | The account with account id: 123.       |
| parent:properties/123       | The property with property id: 123.       |
| ancestor:accounts/123       | The account with account id: 123.         |
| firebase_project:project-id | The firebase project with id: project-id. |
| firebase_project:123        | The firebase project with number: 123.    |
pageSize

integer

要傳回的資源數量上限。即使仍有多頁,這項服務仍可能傳回比這個值更少的值。如果未指定,則最多傳回 50 項資源。最大值為 200,(較大的值將強制轉換成最大值)

pageToken

string

先前的 ListProperties 呼叫所接收的頁面權杖。提供這項資訊以擷取後續網頁。進行分頁時,提供給 ListProperties 的所有其他參數都必須與提供網頁憑證的呼叫相符。

showDeleted

boolean

是否要在結果中加入柔軟內容 (例如 "trashed") 屬性。可檢查屬性以判斷是否刪除。

要求主體

要求主體必須為空白。

回應主體

如果成功,回應主體即會包含具有以下結構的資料:

ListProperties RPC 的回應訊息。

JSON 表示法
{
  "properties": [
    {
      object (Property)
    }
  ],
  "nextPageToken": string
}
欄位
properties[]

object (Property)

符合篩選條件且可供呼叫者存取的搜尋結果。

nextPageToken

string

pageToken 形式傳送的權杖來擷取下一頁。如果省略這個欄位,就不會有後續頁面。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit