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" هو الذي أنشأ هذا التعليق التوضيحي. لا يمكن تعديل التعليقات التوضيحية التي ينشئها النظام أو حذفها.
حقل الربط 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

 تعديل تعليق توضيحي لبيانات إعداد التقارير