Method: activities.list

אחזור רשימה של פעילויות בחשבון ובאפליקציה של לקוח ספציפי, כמו האפליקציה של מסוף Admin או אפליקציית Google Drive. מידע נוסף זמין במדריכים בנושא דוחות פעילות של אדמינים ושל Google Drive. מידע נוסף על הפרמטרים של דוח הפעילות זמין במדריכי העזרה בנושא פרמטרים של פעילות.

בקשת HTTP

GET https://admin.googleapis.com/admin/reports/v1/activity/users/{userKey or all}/applications/{applicationName}

כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.

פרמטרים של נתיב

פרמטרים
userKey or all

string

מייצג את מזהה הפרופיל או את כתובת האימייל של המשתמש שעבורו צריך לסנן את הנתונים. יכול להיות all לכל המידע, או userKey למזהה הפרופיל הייחודי של המשתמש ב-Google Workspace או לכתובת האימייל הראשית שלו. המשתמש לא יכול להיות משתמש שנמחק. למשתמש שנמחק, קוראים ל-users.list ב-Directory API עם showDeleted=true, ואז משתמשים ב-ID שהוחזר כ-userKey.
applicationName

enum (ApplicationName)

שם האפליקציה שאליה רוצים לאחזר את האירועים.

פרמטרים של שאילתה

פרמטרים
actorIpAddress

string

כתובת ה-IP של המארח שבו בוצע האירוע. זוהי דרך נוספת לסנן את הסיכום של הדוח באמצעות כתובת ה-IP של המשתמש שעליו מדווחים. כתובת ה-IP הזו עשויה או לא לשקף את המיקום הפיזי של המשתמש. לדוגמה, כתובת ה-IP יכולה להיות כתובת שרת ה-proxy של המשתמש או כתובת של רשת וירטואלית פרטית (VPN). הפרמטר הזה תומך גם בגרסאות כתובות IPv4 וגם בגרסאות כתובות IPv6.
customerId

string

המזהה הייחודי של הלקוח שעבורו רוצים לאחזר נתונים.
endTime

string

מגדיר את סוף טווח הזמן שמוצג בדוח. התאריך בפורמט RFC 3339, לדוגמה 2010-10-28T10:26:35.000Z. ערך ברירת המחדל הוא השעה המשוערת של בקשת ה-API. בדוח API יש שלושה מושגי זמן בסיסיים:

  • תאריך הבקשה של ה-API לדוח: המועד שבו ה-API יצר את הדוח ואחזר אותו.
  • שעת ההתחלה של הדוח: תחילת התקופה שמוצגת בדוח. הערך של startTime חייב להיות לפני הערך של endTime (אם צוין) והשעה הנוכחית שבה הבקשה נשלחת, אחרת ה-API יחזיר שגיאה.
  • שעת הסיום של הדוח: סוף התקופה שמוצגת בדוח. לדוגמה, התקופה של האירועים שמסכמים בדוח יכולה להתחיל באפריל ולהסתיים במאי. אפשר לבקש את הדוח עצמו באוגוסט.
אם לא מציינים את הערך של endTime, הדוח מחזיר את כל הפעילויות מ-startTime ועד לזמן הנוכחי, או את הפעילויות מ-180 הימים האחרונים אם startTime הוא לפני יותר מ-180 יום.
eventName

string

שם האירוע שאליו ה-API שולח שאילתה. כל eventName קשור לשירות או לתכונה ספציפיים של Google Workspace, שממשק ה-API מארגן לפי סוגי אירועים. דוגמה לכך היא האירועים מיומן Google בדוחות של האפליקציה במסוף Admin. המבנה type של הגדרות היומן מכיל את כל הפעילויות eventName ביומן שעליהן ה-API מדווח. כשאדמין משנה הגדרה ביומן, ה-API מדווח על הפעילות הזו בפרמטרים type ו-eventName של הגדרות היומן. מידע נוסף על מחרוזות שאילתות ופרמטרים של eventName זמין ברשימת שמות האירועים של אפליקציות שונות למעלה בקטע applicationName.
filters

string

מחרוזת השאילתה filters היא רשימה מופרדת בפסיקים שמכילה פרמטרים של אירועים שמנוהלים על ידי אופרטורים יחסיים. הפרמטרים של האירועים הם בפורמט {parameter1 name}{relational operator}{parameter1 value},{parameter2 name}{relational operator}{parameter2 value},...

פרמטרים האירוע האלה משויכים ל-eventName ספציפי. אם הפרמטר של הבקשה לא שייך ל-eventName, המערכת מחזירה דוח ריק. מידע נוסף על השדות הזמינים של eventName לכל אפליקציה ועל הפרמטרים המשויכים אליהם זמין בטבלה ApplicationName. לאחר מכן, לוחצים על הדף Activity Events (אירועי פעילות) שבנספח של האפליקציה הרצויה.

בדוגמאות הבאות לפעילות ב-Drive, הרשימה שמוחזרת מורכבת מכל אירועי edit שבהם ערך הפרמטר doc_id תואם לתנאים שהוגדרו על ידי האופרטור היחסי. בדוגמה הראשונה, הבקשה מחזירה את כל המסמכים שערכתם עם ערך doc_id שווה ל-12345. בדוגמה השנייה, הדוח מחזיר את כל המסמכים שערכתם, שבהם הערך של doc_id לא שווה ל-98765. אופרטור <> מקודד ככתובת URL במחרוזת השאילתה של הבקשה (%3C%3E):

GET...&eventName=edit&filters=doc_id==12345
GET...&eventName=edit&filters=doc_id%3C%3E98765

שאילתת filters תומכת באופררטורים היחסיים הבאים:

  • == – 'שווה ל'.
  • <> – 'לא שווה'. צריך לקודד את הטקסט ככתובת URL (‎%3C%3E).
  • < – 'פחות מ-'. צריך לקודד את הטקסט ככתובת URL (%3C).
  • <= – 'קטן מ- או שווה ל-'. צריך להיות מקודד ככתובת URL (‎%3C=).
  • > – 'גדול מ'. צריך להזין את הערך בקידוד URL (‎%3E).
  • >= – 'גדול מ- או שווה ל-'. צריך להזין את הערך בקידוד כתובת URL (%3E=).

הערה: ה-API לא מקבל כמה ערכים של אותו פרמטר. אם פרמטר מסוים מופיע יותר מפעם אחת בבקשת ה-API, ה-API מקבל רק את הערך האחרון של הפרמטר הזה. בנוסף, אם צוין פרמטר לא תקין בבקשת ה-API, ה-API מתעלם מהפרמטר הזה ומחזיר את התגובה שתואמת לשאר הפרמטרים התקינים. אם לא מבקשים פרמטרים, כל הפרמטרים מוחזרים.
maxResults

integer

קובע כמה רשומות פעילות יוצגו בכל דף תגובה. לדוגמה, אם הבקשה מגדירה את maxResults=1 ויש בדוח שתי פעילויות, הדוח יכלול שני דפים. הטוקן לדף השני נמצא במאפיין nextPageToken של התגובה. מחרוזת השאילתה maxResults היא אופציונלית בבקשה. ערך ברירת המחדל הוא 1000.
orgUnitID

string

המזהה של היחידה הארגונית שרוצים לדווח עליה. רשומות הפעילות יוצגו רק למשתמשים ששייכים ליחידה הארגונית שצוינה.

pageToken

string

האסימון לציון הדף הבא. בדוח עם כמה דפים מופיע המאפיין nextPageToken בתגובה. בבקשה הבאה לקבלת הדף הבא של הדוח, מזינים את הערך nextPageToken במחרוזת השאילתה pageToken.
startTime

string

מגדיר את תחילת טווח הזמן שמוצג בדוח. התאריך בפורמט RFC 3339, לדוגמה 2010-10-28T10:26:35.000Z. הדוח מחזיר את כל הפעילויות מ-startTime עד endTime. הערך של startTime חייב להיות לפני הערך של endTime (אם צוין) והשעה הנוכחית שבה הבקשה נשלחת, אחרת ה-API יחזיר שגיאה.
groupIdFilter

string

מזהי קבוצות מופרדים בפסיקים (מעומעמים) שבהם מסוננות פעילויות המשתמשים. כלומר, התגובה תכיל פעילויות רק של משתמשים שהם חלק מאחד לפחות ממזהי הקבוצות שצוינו כאן. פורמט: "id:abc123,id:xyz456"

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התשובה

תבנית JSON לאוסף של פעילויות.

אם הפעולה מצליחה, גוף התגובה מכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "kind": string,
  "etag": string,
  "items": [
    {
      object (Activity)
    }
  ],
  "nextPageToken": string
}
שדות
kind

string

סוג משאב ה-API. בדוח פעילות, הערך הוא reports#activities.
etag

string

ה-ETag של המשאב.
items[]

object (Activity)

כל רשומת הפעילות בתגובה.
nextPageToken

string

אסימון לאחזור הדף הבא בדוח. הערך nextPageToken משמש במחרוזת השאילתה pageToken של הבקשה.

היקפי הרשאה

נדרש היקף הרשאות OAuth הבא:

  • https://www.googleapis.com/auth/admin.reports.audit.readonly

מידע נוסף זמין במדריך ההרשאות.

ApplicationName

טיפוסים בני מנייה (enum)
access_transparency

דוחות הפעילות של Access Transparency ב-Google Workspace מספקים מידע על סוגים שונים של אירועי פעילות של Access Transparency.
admin

דוחות הפעילות של אפליקציית מסוף Admin מחזירים פרטי חשבון לגבי סוגים שונים של אירועי פעילות של אדמינים.
calendar

דוחות הפעילות של אפליקציית יומן Google מספקים מידע על אירועי פעילות שונים ביומן.
chat בדוחות הפעילות ב-Chat מוצג מידע על אירועים שונים של פעילות ב-Chat.
drive

דוחות הפעילות של אפליקציית Google Drive מספקים מידע על אירועי פעילות שונים ב-Google Drive. דוח הפעילות ב-Drive זמין רק ללקוחות Google Workspace Business ו-Enterprise.
gcp דוחות הפעילות של אפליקציית Google Cloud Platform מספקים מידע על אירועי פעילות שונים ב-GCP.
gplus דוחות הפעילות של אפליקציית Google+‎ מספקים מידע על אירועי פעילות שונים ב-Google+‎.
groups

דוחות הפעילות של אפליקציית Google Groups מספקים מידע על אירועי פעילות שונים בקבוצות.
groups_enterprise

בדוחות הפעילות של קבוצות Enterprise מוצג מידע על אירועי פעילות שונים בקבוצות Enterprise.
jamboard דוחות הפעילות ב-Jamboard מספקים מידע על אירועי פעילות שונים ב-Jamboard.
login

דוחות הפעילות של אפליקציית ההתחברות מחזירים פרטי חשבון לגבי סוגים שונים של אירועי פעילות בחשבון להתחברות.
meet בדוח הפעילות של ביקורת Meet מוצג מידע על סוגים שונים של אירועי פעילות של ביקורת Meet.
mobile דוח הפעילות של ביקורת המכשיר מחזיר מידע על סוגים שונים של אירועי פעילות של ביקורת המכשיר.
rules

בדוח 'פעילות של כללים' מוצג מידע על סוגים שונים של אירועי פעילות של כללים.
saml

דוח הפעילות של SAML מחזיר מידע על סוגים שונים של אירועי פעילות של SAML.
token

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

דוחות הפעילות של אפליקציית User Accounts מחזירים פרטי חשבון לגבי סוגים שונים של אירועי פעילות בחשבונות משתמשים.
context_aware_access

דוחות הפעילות של בקרת גישה מבוססת-הקשר מחזירים מידע על אירועים של דחיית גישה של משתמשים בגלל כללים של בקרת גישה מבוססת-הקשר.
chrome

דוחות הפעילות ב-Chrome מספקים מידע על אירועים בדפדפן Chrome וב-Chrome OS.
data_studio דוחות הפעילות ב-Data Studio מספקים מידע על סוגים שונים של אירועי פעילות ב-Data Studio.
keep מדוחות הפעילות של אפליקציית Keep מופיע מידע על אירועי פעילות שונים ב-Google Keep. דוח הפעילות ב-Keep זמין רק ללקוחות Google Workspace Business ו-Enterprise.
vault דוחות הפעילות ב-Vault מספקים מידע על סוגים שונים של אירועי פעילות ב-Vault.
gemini_in_workspace_apps בדוחות הפעילות של Gemini ל-Workspace מוצג מידע על סוגים שונים של אירועי פעילות ב-Gemini שבוצעו על ידי משתמשים באפליקציית Workspace.

פעילות

תבנית JSON של משאב הפעילות.

ייצוג ב-JSON 
{
  "kind": string,
  "etag": string,
  "ownerDomain": string,
  "ipAddress": string,
  "events": [
    {
      "type": string,
      "name": string,
      "parameters": [
        {
          "messageValue": {
            "parameter": [
              {
                object (NestedParameter)
              }
            ]
          },
          "name": string,
          "value": string,
          "multiValue": [
            string
          ],
          "intValue": string,
          "multiIntValue": [
            string
          ],
          "boolValue": boolean,
          "multiMessageValue": [
            {
              "parameter": [
                {
                  object (NestedParameter)
                }
              ]
            }
          ]
        }
      ],
      "resourceIds": [
        string
      ]
    }
  ],
  "id": {
    "time": string,
    "uniqueQualifier": string,
    "applicationName": string,
    "customerId": string
  },
  "actor": {
    "profileId": string,
    "email": string,
    "callerType": string,
    "key": string,
    "applicationInfo": {
      "oauthClientId": string,
      "applicationName": string,
      "impersonation": boolean
    }
  },
  "resourceDetails": [
    {
      object (ResourceDetails)
    }
  ]
}
שדות
kind

string

סוג משאב ה-API. בדוח פעילות, הערך הוא audit#activity.
etag

string

ה-ETag של הרשומה.
ownerDomain

string

זהו הדומיין שהושפע מהאירוע בדוח. לדוגמה, הדומיין של מסוף Admin או הבעלים של המסמך באפליקציית Drive.
ipAddress

string

כתובת ה-IP של המשתמש שמבצע את הפעולה. זוהי כתובת ה-IP של המשתמש בזמן ההתחברות ל-Google Workspace. יכול להיות שהיא משקפת את המיקום הפיזי של המשתמש, ויכול להיות שלא. לדוגמה, כתובת ה-IP יכולה להיות כתובת שרת ה-proxy של המשתמש או כתובת של רשת וירטואלית פרטית (VPN). ה-API תומך ב-IPv4 וב-IPv6.
events[]

object

אירועי פעילות בדוח.
events[].type

string

סוג האירוע. השירות או התכונה של Google Workspace שהאדמין משנה מזוהים במאפיין type, שמזהה אירוע באמצעות המאפיין eventName. רשימה מלאה של הקטגוריות type ב-API מופיעה ברשימת שמות האירועים של אפליקציות שונות שצוינה למעלה בקטע applicationName.
events[].name

string

שם האירוע. זהו השם הספציפי של הפעילות שדווחה על ידי ה-API. כל eventName קשור לשירות או לתכונה ספציפיים של Google Workspace, שממשק ה-API מארגן לפי סוגי אירועים.
בפרמטרים של הבקשה eventName באופן כללי:

  • אם לא מציינים eventName, הדוח מחזיר את כל המופעים האפשריים של eventName.
  • כשמבקשים eventName, התגובה של ה-API מחזירה את כל הפעילויות שמכילות את ה-eventName הזה.

מידע נוסף על מאפייני eventName זמין ברשימת שמות האירועים של אפליקציות שונות שצוינה למעלה בקטע applicationName.
events[].parameters[]

object

זוגות של ערכי פרמטרים לאפליקציות שונות. מידע נוסף על הפרמטרים של eventName זמין ברשימת שמות האירועים של אפליקציות שונות למעלה בקטע applicationName.
events[].parameters[].messageValue

object

זוגות ערכי פרמטרים בתצוגת עץ שמשויכים לפרמטר הזה. סוג הערך המורכב של פרמטר מוחזר כרשימה של ערכי הפרמטר. לדוגמה, הפרמטר address יכול להיות בעל ערך כמו [{parameter: [{name: city, value: abc}]}]
events[].parameters[].messageValue.parameter[]

object (NestedParameter)

ערכי פרמטרים
events[].parameters[].name

string

שם הפרמטר.
events[].parameters[].value

string

ערך המחרוזת של הפרמטר.
events[].parameters[].multiValue[]

string

ערכי המחרוזות של הפרמטר.
events[].parameters[].intValue

string (int64 format)

ערך המספר השלם של הפרמטר.
events[].parameters[].multiIntValue[]

string (int64 format)

ערכי המספרים השלמים של הפרמטר.
events[].parameters[].boolValue

boolean

הערך הבוליאני של הפרמטר.
events[].parameters[].multiMessageValue[]

object

activities.list של אובייקטים מסוג messageValue.
events[].parameters[].multiMessageValue[].parameter[]

object (NestedParameter)

ערכי פרמטרים
events[].resourceIds[]

string

מזהי המשאבים שמשויכים לאירוע.
id

object

מזהה ייחודי לכל רשומת פעילות.
id.time

string

מועד הפעילות. הזמן מופיע בשניות לפי ראשית זמן יוניקס (Unix epoch).
id.uniqueQualifier

string (int64 format)

מגדיר ייחודי אם ליותר מאירוע אחד יש את אותה שעה.
id.applicationName

string

שם האפליקציה שאליה שייך האירוע. הערכים האפשריים מפורטים ברשימת האפליקציות שלמעלה בקטע applicationName.
id.customerId

string

המזהה הייחודי של חשבון Google Workspace.
actor

object

המשתמש שמבצע את הפעולה.
actor.profileId

string

מזהה הפרופיל הייחודי של הגורם ב-Google Workspace. יכול להיות שהערך הזה לא יופיע אם הגורם המבצע אינו משתמש ב-Google Workspace, או שהוא יהיה המספר 105250506097979753968, שמשמיע כמזהה placeholder.
actor.email

string

כתובת האימייל הראשית של המשתמש. יכול להיות שהשדה הזה לא יופיע אם אין כתובת אימייל שמשויכת לגורם.
actor.callerType

string

סוג המשתמש.
actor.key

string

מוצג רק כשהערך של callerType הוא KEY. יכול להיות consumer_key של מבצע הבקשה לבקשות API של OAuth 2LO או מזהה לחשבונות של רובוטים.
actor.applicationInfo

object

פרטי האפליקציה שהיתה הגורם לפעילות.
actor.applicationInfo.oauthClientId

string

מזהה הלקוח ב-OAuth של אפליקציית הצד השלישי ששימשה לביצוע הפעולה.
actor.applicationInfo.applicationName

string

שם האפליקציה שבה בוצעה הפעולה.
actor.applicationInfo.impersonation

boolean

האם האפליקציה התחזתה למשתמש.
resourceDetails[]

object (ResourceDetails)

פרטים על המשאב שבו בוצעה הפעולה.

ResourceDetails

פרטים על המשאב שבו בוצעה הפעולה.

ייצוג ב-JSON 
{
  "id": string,
  "title": string,
  "type": string,
  "appliedLabels": [
    {
      object (AppliedLabel)
    }
  ],
  "relation": string
}
שדות
id

string

המזהה של המשאב.
title

string

כותרת המשאב. לדוגמה, אם מדובר במסמך ב-Drive, זה יהיה שם המסמך. במקרה של אימייל, זה יהיה הנושא.
type

string

סוג המשאב – מסמך, אימייל, הודעת צ'אט
appliedLabels[]

object (AppliedLabel)

activities.list of labels applied on the resource
relation

string

הגדרת הקשר של המשאב לאירועים

AppliedLabel

פרטי התווית שהוחלו על המשאב.

ייצוג ב-JSON 
{
  "id": string,
  "title": string,
  "fieldValues": [
    {
      object (FieldValue)
    }
  ],
  "reason": {
    object (Reason)
  }
}
שדות
id

string

המזהה של התווית – רק מזהה התווית, ולא שם המשאב המלא ב-OnePlatform.
title

string

שם התווית
fieldValues[]

object (FieldValue)

activities.list של שדות שהם חלק מהתווית והוגדרו על ידי המשתמש. אם לתווית יש שדה שלא הוגדר על ידי המשתמש, הוא לא יופיע ברשימה הזו.
reason

object (Reason)

הסיבה להוספת התווית למשאב.

FieldValue

פרטים על ערך השדה שהמשתמש הגדיר לתווית הספציפית.

ייצוג ב-JSON 
{
  "id": string,
  "displayName": string,
  "type": string,
  "reason": {
    object (Reason)
  },

  // Union field value can be only one of the following:
  "unsetValue": boolean,
  "longTextValue": string,
  "textValue": string,
  "textListValue": {
    object (TextListValue)
  },
  "selectionValue": {
    object (SelectionValue)
  },
  "selectionListValue": {
    object (SelectionListValue)
  },
  "integerValue": string,
  "userValue": {
    object (UserValue)
  },
  "userListValue": {
    object (UserListValue)
  },
  "dateValue": {
    object (Date)
  }
  // End of list of possible types for union field value.
}
שדות
id

string

המזהה של השדה
displayName

string

השם המוצג של השדה
type

string

סוג השדה
reason

object (Reason)

הסיבה שהשדה הוחלה על התווית.
שדה האיחוד value. מאחסן את הערכים ששמורים בשדה value. הערך יכול להיות רק אחד מהערכים הבאים:
unsetValue

boolean

אם השדה לא מוגדר, הערך יהיה true.
longTextValue

string

הגדרת ערך טקסט ארוך.
textValue

string

הגדרת ערך טקסט.
textListValue

object (TextListValue)

הגדרת ערך של רשימת טקסט.
selectionValue

object (SelectionValue)

הגדרת ערך בחירה על ידי בחירה בערך יחיד מתפריט נפתח.
selectionListValue

object (SelectionListValue)

הגדרת ערך של רשימת בחירה על ידי בחירה של כמה ערכים מתפריט נפתח.
integerValue

string (int64 format)

הגדרת ערך של מספר שלם.
userValue

object (UserValue)

הגדרת ערך משתמש על ידי בחירה של משתמש יחיד.
userListValue

object (UserListValue)

הגדרת ערך של רשימת משתמשים על ידי בחירה של כמה משתמשים.
dateValue

object (Date)

הגדרת ערך תאריך.

TextListValue

הגדרת ערך של רשימת טקסט.

ייצוג ב-JSON 
{
  "values": [
    string
  ]
}
שדות
values[]

string

activities.list של ערכי טקסט.

SelectionValue

הגדרת ערך בחירה על ידי בחירה בערך יחיד מתפריט נפתח.

ייצוג ב-JSON 
{
  "id": string,
  "displayName": string,
  "badged": boolean
}
שדות
id

string

המזהה של הבחירה.
displayName

string

השם המוצג של הבחירה.
badged

boolean

אם הבחירה מסומנת בתג.

SelectionListValue

הגדרת ערך של רשימת בחירה על ידי בחירה של כמה ערכים מתפריט נפתח.

ייצוג ב-JSON 
{
  "values": [
    {
      object (SelectionValue)
    }
  ]
}
שדות
values[]

object (SelectionValue)

activities.list of selections.

UserValue

הגדרת ערך משתמש על ידי בחירה של משתמש יחיד.

ייצוג ב-JSON 
{
  "email": string
}
שדות
email

string

כתובת האימייל של המשתמש.

UserListValue

הגדרת ערך של רשימת משתמשים על ידי בחירה של כמה משתמשים.

ייצוג ב-JSON 
{
  "values": [
    {
      object (UserValue)
    }
  ]
}
שדות
values[]

object (UserValue)

activities.list of users.

תאריך

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

  • תאריך מלא, עם ערכים שאינם אפס לשנה, לחודש וליום.
  • חודש ויום, עם אפס בשנה (לדוגמה, יום נישואין).
  • שנה לבד, עם אפס חודש ואפס יום.
  • שנה וחודש, עם יום אפס (לדוגמה, תאריך תפוגת תוקף של כרטיס אשראי).

סוגים קשורים:

ייצוג ב-JSON 
{
  "year": integer,
  "month": integer,
  "day": integer
}
שדות
year

integer

השנה של התאריך. חייב להיות בין 1 ל-9999, או 0 כדי לציין תאריך ללא שנה.
month

integer

החודש בשנה. הערך צריך להיות בין 1 ל-12, או 0 כדי לציין שנה ללא חודש ויום.
day

integer

היום בחודש. הערך חייב להיות בין 1 ל-31 ותקף לשנה ולחודש, או 0 כדי לציין שנה בלבד או שנה וחודש שבהם היום לא רלוונטי.

סיבה

הסיבה שהתווית או השדה הוחלו.

ייצוג ב-JSON 
{
  "reasonType": string
}
שדות
reasonType

string

סוג הסיבה.