REST Resource: matters.holds

משאב: הקפאה

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

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

ייצוג ב-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)

הפעם האחרונה שבה בוצע שינוי בהשעיה הזו.

הפונקציה משתמשת ב-RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
accounts[]

object (HeldAccount)

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

object (HeldOrgUnit)

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

enum (CorpusType)

השירות שצריך לחפש בו.
query

object (CorpusQuery)

אפשרויות ספציפיות לשירות. אם השדה CorpusQuery מוגדר, הוא צריך להיות זהה לערך של CorpusType.

HeldOrgUnit

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

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

string

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

string (Timestamp format)

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

הפונקציה משתמשת ב-RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".

CorpusQuery

אפשרויות השהיה שספציפיות לשירות.

ייצוג ב-JSON 
{

  "driveQuery": {
    object (HeldDriveQuery)
  },
  "mailQuery": {
    object (HeldMailQuery)
  },
  "groupsQuery": {
    object (HeldGroupsQuery)
  },
  "hangoutsChatQuery": {
    object (HeldHangoutsChatQuery)
  },
  "voiceQuery": {
    object (HeldVoiceQuery)
  },
  "calendarQuery": {
    object (HeldCalendarQuery)
  },
  "geminiQuery": {
    object (HeldGeminiQuery)
  }
}
שדות
שדה איחוד corpus_query. אם מגדירים את הערך הזה, הוא חייב להיות זהה לסוג השירות. הערך corpus_query יכול להיות רק אחד מהבאים:
driveQuery

object (HeldDriveQuery)

אפשרויות ספציפיות לשירות להקפאה ב-Drive. אם השדה CorpusType מוגדר, הערך שלו חייב להיות DRIVE.
mailQuery

object (HeldMailQuery)

אפשרויות ספציפיות לשירות להקפאות ב-Gmail. אם השדה CorpusType מוגדר, הערך שלו חייב להיות MAIL.
groupsQuery

object (HeldGroupsQuery)

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

object (HeldHangoutsChatQuery)

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

object (HeldVoiceQuery)

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

object (HeldCalendarQuery)

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

object (HeldGeminiQuery)

אפשרויות ספציפיות לשירות להקפאת נתונים ב-Gemini. אם השדה CorpusType מוגדר, הערך שלו חייב להיות GEMINI.

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). הערך מעוגל לחצות הלילה בתאריך שצוין.

הפונקציה משתמשת ב-RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

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

הפונקציה משתמשת ב-RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".

HeldGroupsQuery

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

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

string

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

string (Timestamp format)

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

הפונקציה משתמשת ב-RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

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

הפונקציה משתמשת ב-RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".

HeldHangoutsChatQuery

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

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

boolean

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

HeldVoiceQuery

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

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

enum (VoiceCoveredData)

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

HeldCalendarQuery

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

אפשרויות להקפאת היומן.

HeldGeminiQuery

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

אפשרויות להקפאת Gemini.

Methods

addHeldAccounts

 הוספת חשבונות להחזקה.

create

 יוצרת הקפאה בעניין שצוין.

delete

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

get

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

list

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

removeHeldAccounts

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

update

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