Method: properties.reportingDataAnnotations.list

列出資源的所有報表資料註解。

HTTP 要求

GET https://analyticsadmin.googleapis.com/v1alpha/{parent=properties/*}/reportingDataAnnotations

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
parent

string

必要欄位。房源的資源名稱。格式：properties/property_id 範例：properties/123

查詢參數

參數
filter

string

選用設定。篩選器，可限制列出父項資源下哪些報表資料註解。

支援的欄位如下：

  • 'name'
  • title
  • description
  • annotationDate
  • annotationDateRange
  • color

此外，這個 API 還提供下列輔助函式：

  • annotation_duration()：這個註解標記的時間長度，時間長度。預期秒數的數值表示法，後面接 s 後置字串。
  • is_annotation_in_range(startDate, endDate)：如果註解位於 startDate 和 endDate 指定的範圍內。日期採用 ISO-8601 格式，例如 2031-06-28。

支援的作業：

  • =：等於
  • !=：不相等
  • <：小於
  • >：大於
  • <=：小於或等於
  • >=：大於或等於
  • :：has 運算子
  • =~：規則運算式比對
  • !~：規則運算式不相符
  • NOT：邏輯否定
  • AND：邏輯 AND
  • OR：邏輯或

範例：

  1. title="Holiday Sale"
  2. description=~"[Bb]ig [Gg]ame.*[Ss]ale"
  3. is_annotation_in_range("2025-12-25", "2026-01-16") = true
  4. annotation_duration() >= 172800s AND title:BOGO
pageSize

integer

選用設定。要傳回的資源數量上限。即使有其他頁面，服務傳回的產品數量可能會少於這個值。如未指定，最多將傳回 50 個資源。許可的最大值為 200；超出的數值將一律指定為 200
pageToken

string

選用設定。從先前 reportingDataAnnotations.list 呼叫收到的網頁權杖。提供此項目即可擷取後續網頁。進行分頁時，提供至 reportingDataAnnotations.list 的所有其他參數須與提供網頁權杖的呼叫相符。

要求主體

要求主體必須為空白。

回應主體

ListReportingDataAnnotation RPC 的回應訊息。

如果成功，回應主體會含有以下結構的資料：

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

object (ReportingDataAnnotation)

報表資料註解清單。
nextPageToken

string

可做為 pageToken 傳送的權杖，用於擷取後續網頁。如果省略這個欄位，就不會有後續頁面。

授權範圍

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

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