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 )

در صورت تنظیم، حاشیه نویسی داده های گزارش برای محدوده ای از تاریخ های نشان داده شده توسط این قسمت است.

تاریخ

نمایانگر یک تاریخ تقویم کامل یا جزئی، مانند روز تولد است. زمان روز و منطقه زمانی یا در جای دیگری مشخص شده است یا ناچیز است. تاریخ مربوط به تقویم میلادی است. این می تواند نشان دهنده یکی از موارد زیر باشد:

  • تاریخ کامل، با مقادیر سال، ماه و روز غیر صفر.
  • یک ماه و روز، با یک سال صفر (مثلاً یک سالگرد).
  • یک سال به تنهایی، با یک ماه صفر و یک روز صفر.
  • یک سال و یک ماه، با روز صفر (مثلاً تاریخ انقضای کارت اعتباری).

انواع مرتبط:

نمایندگی JSON 
{
  "year": integer,
  "month": integer,
  "day": integer
}
فیلدها
year

integer

سال تاریخ. برای تعیین تاریخ بدون سال باید از 1 تا 9999 یا 0 باشد.

month

integer

ماه از یک سال. باید از 1 تا 12 یا 0 باشد تا یک سال بدون ماه و روز مشخص شود.

day

integer

روز یک ماه. باید از 1 تا 31 باشد و برای سال و ماه معتبر باشد، یا 0 برای مشخص کردن یک سال به تنهایی یا یک سال و ماهی که در آن روز مهم نیست، معتبر باشد.

محدوده تاریخ

محدوده تاریخ یک حاشیه نویسی داده گزارش را نشان می دهد، هر دو تاریخ شروع و پایان شامل می شوند. مناطق زمانی بر اساس ویژگی والد است.

نمایندگی JSON 
{
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  }
}
فیلدها
startDate

object ( Date )

مورد نیاز. تاریخ شروع این محدوده باید یک تاریخ معتبر با مجموعه سال، ماه و روز باشد. تاریخ ممکن است در گذشته، حال یا آینده باشد.

endDate

object ( Date )

مورد نیاز. تاریخ پایان برای این محدوده. باید یک تاریخ معتبر با مجموعه سال، ماه و روز باشد. این تاریخ باید بزرگتر یا مساوی با تاریخ شروع باشد.

رنگ

رنگ هایی که ممکن است برای این حاشیه نویسی داده گزارش استفاده شود

Enums
COLOR_UNSPECIFIED رنگ ناشناخته یا مشخص نشده است.
PURPLE رنگ بنفش.
BROWN رنگ قهوه ای.
BLUE رنگ آبی.
GREEN رنگ سبز.
RED رنگ قرمز.
CYAN رنگ فیروزه ای.
ORANGE رنگ نارنجی. (فقط برای حاشیه نویسی های تولید شده توسط سیستم استفاده می شود)

روش ها

create

 یک حاشیه نویسی داده های گزارشی ایجاد می کند.

delete

 حاشیه نویسی داده های گزارش را حذف می کند.

get

 یک حاشیه نویسی داده گزارش دهی را جستجو کنید.

list

 فهرست تمام حاشیه نویسی های داده های گزارش شده در یک ملک.

patch

 یک حاشیه نویسی داده گزارش را به روز می کند.