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

เอาต์พุตเท่านั้น หากเป็น "จริง" แสดงว่าระบบ Google Analytics เป็นผู้สร้างคำอธิบายประกอบนี้ คุณจะอัปเดตหรือลบคำอธิบายประกอบที่ระบบสร้างขึ้นไม่ได้
ฟิลด์สหภาพ 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)

ต้องระบุ วันที่สิ้นสุดของช่วงนี้ ต้องเป็นวันที่ที่ถูกต้องซึ่งตั้งค่าปี เดือน และวันแล้ว วันที่นี้ต้องมากกว่าหรือเท่ากับวันที่เริ่มต้น

สี

สีที่อาจใช้สำหรับการกำกับเนื้อหาข้อมูลการรายงานนี้

Enum
COLOR_UNSPECIFIED สีที่ไม่รู้จักหรือไม่ระบุ
PURPLE สีม่วง
BROWN สีน้ำตาล
BLUE สีฟ้า
GREEN สีเขียว
RED สีแดง
CYAN สีฟ้าอมเขียว
ORANGE สีส้ม (ใช้สำหรับคำอธิบายประกอบที่ระบบสร้างขึ้นเท่านั้น)

เมธอด

create

 สร้างคำอธิบายประกอบข้อมูลการรายงาน

delete

 ลบคำอธิบายประกอบข้อมูลการรายงาน

get

 ค้นหาคำอธิบายประกอบข้อมูลการรายงานรายการเดียว

list

 แสดงรายการคําอธิบายประกอบข้อมูลการรายงานทั้งหมดในพร็อพเพอร์ตี้

patch

 อัปเดตคําอธิบายประกอบข้อมูลการรายงาน