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 כדי לציין שנה בלבד או שנה וחודש שבהם היום לא רלוונטי.

DateRange

מייצג את טווח התאריכים של הערה לנתוני דיווח, כולל תאריכי ההתחלה והסיום. אזורי הזמן מבוססים על נכס ההורה.

ייצוג ב-JSON 
{
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  }
}
שדות
startDate

object (Date)

חובה. תאריך ההתחלה של הטווח הזה. התאריך חייב להיות חוקי עם שנה, חודש ויום מוגדרים. התאריך יכול להיות בעבר, בהווה או בעתיד.
endDate

object (Date)

חובה. תאריך הסיום של הטווח. התאריך חייב להיות חוקי עם שנה, חודש ויום מוגדרים. התאריך הזה חייב להיות גדול מתאריך ההתחלה או שווה לו.

צבע

צבעים שאפשר להשתמש בהם לצורך הוספת הערה לנתוני הדיווח

טיפוסים בני מנייה (enum)
COLOR_UNSPECIFIED הצבע לא ידוע או לא צוין.
PURPLE צבע סגול.
BROWN צבע חום.
BLUE צבע כחול.
GREEN צבע ירוק.
RED צבע אדום.
CYAN צבע ציאן.
ORANGE צבע כתום. (משמש רק להערות שנוצרו על ידי המערכת)

Methods

create

 יצירת הערה לנתוני דיווח.

delete

 הפונקציה מוחקת הערה לגבי נתוני דיווח.

get

 חיפוש של הערה אחת לגבי נתוני דיווח.

list

 הצגת רשימה של כל ההערות על נתוני הדיווח בנכס.

patch

 עדכון של תיאור נתוני הדיווח.