REST Resource: properties.reportingDataAnnotations

Tài nguyên: ReportingDataAnnotation

Chú thích dữ liệu báo cáo là một nhận xét được liên kết với một số ngày nhất định cho dữ liệu báo cáo.

Biểu diễn dưới dạng 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.
}
Trường
name

string

Bắt buộc. Giá trị nhận dạng. Tên tài nguyên của Chú thích dữ liệu báo cáo này. Định dạng: 'properties/{property_id}/reportingDataAnnotations/{reportingDataAnnotation}' Định dạng: 'properties/123/reportingDataAnnotations/456'
title

string

Bắt buộc. Tiêu đề mà con người đọc được cho Chú thích dữ liệu báo cáo này.
description

string

Không bắt buộc. Nội dung mô tả cho Chú thích dữ liệu báo cáo này.
color

enum (Color)

Bắt buộc. Màu dùng để hiển thị Chú thích dữ liệu báo cáo này.
systemGenerated

boolean

Chỉ có đầu ra. Nếu đúng, chú thích này do hệ thống Google Analytics tạo. Bạn không thể cập nhật hoặc xoá chú thích do hệ thống tạo.
Trường hợp hợp nhất target. Mục tiêu cho Chú thích dữ liệu báo cáo target này chỉ có thể là một trong những mục sau:
annotationDate

object (Date)

Nếu được đặt, Chú thích dữ liệu báo cáo sẽ dành cho một ngày cụ thể được biểu thị bằng trường này. Ngày phải là ngày hợp lệ, đã đặt năm, tháng và ngày. Ngày có thể là ngày trong quá khứ, hiện tại hoặc tương lai.
annotationDateRange

object (DateRange)

Nếu được đặt, Chú thích dữ liệu báo cáo sẽ dành cho một phạm vi ngày do trường này biểu thị.

Ngày

Đại diện cho toàn bộ hoặc một phần ngày theo lịch, chẳng hạn như ngày sinh nhật. Thời gian trong ngày và múi giờ được chỉ định ở nơi khác hoặc không quan trọng. Ngày này có liên quan đến Lịch Gregorian. Giá trị này có thể biểu thị một trong những giá trị sau:

  • Một ngày đầy đủ, với các giá trị năm, tháng và ngày khác 0.
  • Tháng và ngày, với năm bằng 0 (ví dụ: ngày kỷ niệm).
  • Chỉ riêng giá trị năm, với giá trị tháng và ngày bằng 0.
  • Năm và tháng, với ngày bằng 0 (ví dụ: ngày hết hạn thẻ tín dụng).

Các loại có liên quan:

Biểu diễn dưới dạng JSON 
{
  "year": integer,
  "month": integer,
  "day": integer
}
Trường
year

integer

Năm của ngày. Giá trị phải từ 1 đến 9999 hoặc bằng 0 để chỉ định ngày không có năm.
month

integer

Tháng trong năm. Giá trị phải từ 1 đến 12 hoặc bằng 0 để chỉ định một năm không có tháng và ngày.
day

integer

Ngày trong tháng. Giá trị phải từ 1 đến 31 và có giá trị trong năm và tháng, hoặc bằng 0 để chỉ định giá trị năm, hoặc một năm và tháng, trong đó ngày là không quan trọng.

DateRange

Biểu thị phạm vi ngày của Chú thích dữ liệu báo cáo, bao gồm cả ngày bắt đầu và ngày kết thúc. Múi giờ dựa trên thuộc tính mẹ.

Biểu diễn dưới dạng JSON 
{
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  }
}
Trường
startDate

object (Date)

Bắt buộc. Ngày bắt đầu của phạm vi này. Phải là ngày hợp lệ đã đặt năm, tháng và ngày. Ngày có thể là ngày trong quá khứ, hiện tại hoặc tương lai.
endDate

object (Date)

Bắt buộc. Ngày kết thúc của phạm vi này. Phải là ngày hợp lệ đã đặt năm, tháng và ngày. Ngày này phải lớn hơn hoặc bằng ngày bắt đầu.

Màu

Màu sắc có thể dùng cho Chú thích dữ liệu báo cáo này

Enum
COLOR_UNSPECIFIED Màu không xác định hoặc không được chỉ định.
PURPLE Màu tím.
BROWN Màu nâu.
BLUE Màu xanh dương.
GREEN Màu xanh lục.
RED Màu đỏ.
CYAN Màu xanh lục lam.
ORANGE Màu cam. (Chỉ dùng cho chú thích do hệ thống tạo)

Phương thức

create

 Tạo Chú thích dữ liệu báo cáo.

delete

 Xoá Chú thích dữ liệu báo cáo.

get

 Tìm một Chú thích dữ liệu báo cáo.

list

 Liệt kê tất cả Chú thích dữ liệu báo cáo trên một tài sản.

patch

 Cập nhật Chú thích dữ liệu báo cáo.