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

必需。标识符。此报告数据注释的资源名称。格式：“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

 更新报告数据注解。