REST Resource: matters.holds

משאב: החזקה

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

כדי לעבוד עם המשאבים של Vault, לחשבון צריכות להיות ההרשאות הנדרשות ב-Vault וגישה לעניין. כדי לגשת לעניין, צריך שהחשבון יצר את העניין, לשתף איתו את העניין או לקבל הרשאה להצגת כל העניינים.

ייצוג JSON
{
  "holdId": string,
  "name": string,
  "updateTime": string,
  "accounts": [
    {
      object (HeldAccount)
    }
  ],
  "orgUnit": {
    object (HeldOrgUnit)
  },
  "corpus": enum (CorpusType),
  "query": {
    object (CorpusQuery)
  }
}
שדות
holdId

string

המזהה הייחודי של ההחזקה שלא ניתן לשינוי. הוקצתה במהלך היצירה.

name

string

שם ההחזקה.

updateTime

string (Timestamp format)

הפעם האחרונה שבה בוצע שינוי בהחזקה לצורך משפטי.

חותמת זמן בפורמט 'Zulu' בפורמט RFC3339 UTC, עם רזולוציה של ננו-שנייה ועד תשע ספרות אחרי הנקודה. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".

accounts[]

object (HeldAccount)

אם היא מוגדרת, ההחזקה חלה על החשבונות שצוינו, וה-orgUnit חייב להיות ריק.

orgUnit

object (HeldOrgUnit)

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

corpus

enum (CorpusType)

השירות הרצוי.

query

object (CorpusQuery)

אפשרויות ספציפיות לשירות. אם המדיניות מוגדרת, CorpusQuery חייב להתאים ל-CorpusType.

HeldOrgUnit

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

ייצוג JSON
{
  "orgUnitId": string,
  "holdTime": string
}
שדות
orgUnitId

string

המזהה שלא ניתן לשינוי של היחידה הארגונית, כפי שסופק על ידי Admin SDK.

holdTime

string (Timestamp format)

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

חותמת זמן בפורמט 'Zulu' בפורמט RFC3339 UTC, עם רזולוציה של ננו-שנייה ועד תשע ספרות אחרי הנקודה. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".

CorpusQuery

אפשרויות ספציפיות לשירות להחזקות לצורך משפטי.

ייצוג JSON
{

  // Union field corpus_query can be only one of the following:
  "driveQuery": {
    object (HeldDriveQuery)
  },
  "mailQuery": {
    object (HeldMailQuery)
  },
  "groupsQuery": {
    object (HeldGroupsQuery)
  },
  "hangoutsChatQuery": {
    object (HeldHangoutsChatQuery)
  },
  "voiceQuery": {
    object (HeldVoiceQuery)
  },
  "calendarQuery": {
    object (HeldCalendarQuery)
  }
  // End of list of possible types for union field corpus_query.
}
שדות
שדה איחוד corpus_query. אם השדה מוגדר, הערך הזה צריך להתאים לסוג השירות. corpus_query יכול להיות רק אחת מהאפשרויות הבאות:
driveQuery

object (HeldDriveQuery)

אפשרויות ספציפיות לשירות להחזקות ב-Drive. אם המדיניות מוגדרת, CorpusType חייב להיות drive.

mailQuery

object (HeldMailQuery)

אפשרויות ספציפיות לשירות להחזקות ב-Gmail. אם השדה מוגדר, CorpusType חייב להיות Email.

groupsQuery

object (HeldGroupsQuery)

אפשרויות ספציפיות לשירות להחזקות בקבוצות Google. אם השדה מוגדר, CorpusType חייב להיות חלוקות.

hangoutsChatQuery

object (HeldHangoutsChatQuery)

אפשרויות ספציפיות לשירות להחזקות לצורך משפטי ב-Chat. אם המדיניות מוגדרת, CorpusType חייב להיות HANGOUTS_CHAT.

voiceQuery

object (HeldVoiceQuery)

אפשרויות ספציפיות לשירות להחזקות לצורך משפטי של Voice. אם המדיניות מוגדרת, CorpusType חייב להיות VOICE.

calendarQuery

object (HeldCalendarQuery)

אפשרויות ספציפיות לשירות להחזקות ביומן Google. אם השדה מוגדר, CorpusType חייב להיות DATE.

HeldDriveQuery

אפשרויות להחזקות ב-Drive.

ייצוג JSON
{
  "includeTeamDriveFiles": boolean,
  "includeSharedDriveFiles": boolean
}
שדות
includeTeamDriveFiles
(deprecated)

boolean

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

includeSharedDriveFiles

boolean

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

HeldMailQuery

אפשרויות של שאילתות להחזקות ב-Gmail.

ייצוג JSON
{
  "terms": string,
  "startTime": string,
  "endTime": string
}
שדות
terms

string

האופרטורים של החיפוש שמשמשים לצמצום ההודעות שכלולות בהחזקה לצורך משפטי.

startTime

string (Timestamp format)

שעת ההתחלה של השאילתה. יש לציין לפי שעון גריניץ' (GMT). הערך יעוגל לשעה 00:00 בתאריך שצוין.

חותמת זמן בפורמט 'Zulu' בפורמט RFC3339 UTC, עם רזולוציה של ננו-שנייה ועד תשע ספרות אחרי הנקודה. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".

endTime

string (Timestamp format)

שעת הסיום של השאילתה. יש לציין לפי שעון גריניץ' (GMT). הערך יעוגל לשעה 00:00 בתאריך שצוין.

חותמת זמן בפורמט 'Zulu' בפורמט RFC3339 UTC, עם רזולוציה של ננו-שנייה ועד תשע ספרות אחרי הנקודה. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".

HeldGroupsQuery

אפשרויות של שאילתות להחזקות לצורך משפטי של הקבוצה.

ייצוג JSON
{
  "terms": string,
  "startTime": string,
  "endTime": string
}
שדות
terms

string

האופרטורים של החיפוש שמשמשים לצמצום ההודעות שכלולות בהחזקה לצורך משפטי.

startTime

string (Timestamp format)

שעת ההתחלה של השאילתה. יש לציין לפי שעון גריניץ' (GMT). הערך יעוגל לשעה 00:00 בתאריך שצוין.

חותמת זמן בפורמט 'Zulu' בפורמט RFC3339 UTC, עם רזולוציה של ננו-שנייה ועד תשע ספרות אחרי הנקודה. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".

endTime

string (Timestamp format)

שעת הסיום של השאילתה. יש לציין לפי שעון גריניץ' (GMT). הערך יעוגל לשעה 00:00 בתאריך שצוין.

חותמת זמן בפורמט 'Zulu' בפורמט RFC3339 UTC, עם רזולוציה של ננו-שנייה ועד תשע ספרות אחרי הנקודה. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".

HeldHangoutsChatQuery

אפשרויות להחזקות ב-Chat.

ייצוג JSON
{
  "includeRooms": boolean
}
שדות
includeRooms

boolean

כדי לכלול הודעות במרחבים ב-Chat שהמשתמש היה חבר בהם, צריך להגדיר את הערך true.

HeldVoiceQuery

אפשרויות להחזקות לצורך משפטי ב-Voice.

ייצוג JSON
{
  "coveredData": [
    enum (VoiceCoveredData)
  ]
}
שדות
coveredData[]

enum (VoiceCoveredData)

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

HeldCalendarQuery

אין שדות בסוג הזה.

אפשרויות להחזקות ביומן Google.

שיטות

addHeldAccounts

הוספת חשבונות להחזקה לצורך משפטי.

create

יצירת החזקה לצורך משפטי בעניין שצוין.

delete

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

get

הפונקציה מקבלת את ההחזקה שצוינה.

list

רשימה של ההחזקות לצורך משפטי של עניין מסוים.

removeHeldAccounts

מסיר את החשבונות שצוינו מהחזקה.

update

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