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 애널리틱스 시스템에서 생성된 것입니다. 시스템에서 생성된 주석은 업데이트하거나 삭제할 수 없습니다.
통합 필드 target. 이 보고 데이터 주석 target의 타겟은 다음 중 하나여야 합니다.
annotationDate

object (Date)

이 필드가 설정되면 보고 데이터 주석은 이 필드로 표시된 특정 날짜에 관한 것입니다. 날짜는 연도, 월, 일이 설정된 유효한 날짜여야 합니다. 날짜는 과거, 현재 또는 미래 시점일 수 있습니다.
annotationDateRange

object (DateRange)

이 필드가 설정된 경우 보고 데이터 주석은 이 필드로 표시되는 기간에 적용됩니다.

날짜

생일과 같은 전체 또는 부분 달력 날짜를 나타냅니다. 시간과 시간대는 아무 곳으로 지정되거나 중요하지 않습니다. 날짜는 그레고리력을 기준으로 합니다. 다음 중 하나를 나타낼 수 있습니다.

  • 연도, 월, 일 값이 0이 아닌 전체 날짜
  • 월과 일, 연도는 0(예: 기념일)
  • 연도만, 월과 일은 0
  • 연도와 월, 일은 0(예: 신용카드 만료일)

관련 유형:

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

 보고 데이터 주석을 업데이트합니다.