REST Resource: properties.reportingDataAnnotations

資源：ReportingDataAnnotation

報表資料註解是與報表資料特定日期相關的註解。

JSON 表示法 
{
  "name": string,
  "title": string,
  "description": string,
  "color": enum (Color),
  "systemGenerated": boolean,

  // Union field target can be only one of the following:
  "annotationDate": {
    object (Date)
  },
  "annotationDateRange": {
    object (DateRange)
  }
  // End of list of possible types for union field target.
}
欄位
name

string

必要欄位。ID。報表資料註解的資源名稱。格式：'properties/{property_id}/reportingDataAnnotations/{reportingDataAnnotation}' 格式：'properties/123/reportingDataAnnotations/456'
title

string

必要欄位。這個報表資料註解的可讀標題。
description

string

選用設定。這項報表資料註解的說明。
color

enum (Color)

必要欄位。用於顯示這項報表資料註解的顏色。
systemGenerated

boolean

僅供輸出。如果為 True，則表示此註解是由 Google Analytics 系統產生。系統產生的註解無法更新或刪除。
聯集欄位 target。這項報表資料註解 target 的目標只能是下列其中一種：
annotationDate

object (Date)

如果已設定，則報表資料註解會針對這個欄位所代表的特定日期提供。日期必須是有效的日期，且已設定年、月和日。日期可以是過去、現在或未來。
annotationDateRange

object (DateRange)

如果已設定，則報表資料註解適用於這個欄位所代表的日期範圍。

日期

表示完整或部分的日曆日期，例如生日。您可以視重要性決定是否要在別處指定時段和時區。日期以公曆為主，可代表下列任一項目：

  • 完整日期，具有非零的年、月和日值。
  • 月和日值，年值為零 (例如週年紀念日)。
  • 只有年，月和日值為零。
  • 年和月，日值為零 (例如信用卡到期日)。

相關類型：

JSON 表示法 
{
  "year": integer,
  "month": integer,
  "day": integer
}
欄位
year

integer

日期的年份。必須為 1 到 9999；如要指定不含年份的日期，請輸入 0。
month

integer

月份。必須為 1 到 12；如要指定不含日期的年份，請輸入 0。
day

integer

月內的日期。必須為 1 到 31，並屬於有效的年和月；如果只指定年份，或只指定年份和月份，而不指定當月第幾日的話，請輸入 0。

DateRange

代表報表資料註解的日期範圍，包括開始和結束日期。時區會根據父項屬性。

JSON 表示法 
{
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  }
}
欄位
startDate

object (Date)

必要欄位。這個範圍的開始日期。必須是有效的日期，且已設定年、月和日。日期可以是過去、現在或未來。
endDate

object (Date)

必要欄位。這個範圍的結束日期。必須是有效的日期，且已設定年、月和日。此日期必須大於或等於開始日期。

顏色

可用於此報表資料註解的顏色

列舉
COLOR_UNSPECIFIED 顏色不明或未指定。
PURPLE 紫色。
BROWN 棕色。
BLUE 藍色。
GREEN 綠色。
RED 紅色。
CYAN 青色。
ORANGE 橘色。(僅用於系統產生的註解)

方法

create

 建立報表資料註解。

delete

 刪除報表資料註解。

get

 查詢單一報表資料註解。

list

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

patch

 更新報表資料註解。