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)

הפעם האחרונה שבה ההחזקה הזו שונתה.

חותמת זמן בפורמט "זולו" 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)

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

חותמת זמן בפורמט "זולו" 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)
  }
  // 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 חייב להיות MAIL.
groupsQuery

object (HeldGroupsQuery)

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

object (HeldHangoutsChatQuery)

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

object (HeldVoiceQuery)

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

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 בתאריך שצוין.

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

string (Timestamp format)

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

חותמת זמן בפורמט "זולו" 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 בתאריך שצוין.

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

string (Timestamp format)

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

חותמת זמן בפורמט "זולו" 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)

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

שיטות

addHeldAccounts

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

create

 יוצרת החזקה בעניין שצוין.

delete

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

get

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

list

 בתיבת הדו-שיח הזו מפורטים ההחזקות בעניין.

removeHeldAccounts

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

update

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