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)

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

הפורמט הזה משתמש ב-RFC 3339, שבו הפלט שנוצר תמיד יהיה מנורמלי לפי Z וישמש בספרות עשרוניות של 0, 3, 6 או 9. אפשר להשתמש גם בשינויים (offsets) אחרים מלבד '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)

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

enum (CorpusType)

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

object (CorpusQuery)

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

HeldOrgUnit

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

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

string

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

string (Timestamp format)

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

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

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 חייב להיות MAIL.
groupsQuery

object (HeldGroupsQuery)

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

object (HeldHangoutsChatQuery)

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

object (HeldVoiceQuery)

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

object (HeldCalendarQuery)

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

HeldDriveQuery

אפשרויות ל-Drive Holds.

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

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

string (Timestamp format)

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

הפורמט הזה משתמש ב-RFC 3339, שבו הפלט שנוצר תמיד יהיה מנורמלי לפי Z וישמש בספרות עשרוניות של 0, 3, 6 או 9. אפשר להשתמש גם בשינויים (offsets) אחרים מלבד '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). הערך יעוגל לשעה 00:00 בתאריך שצוין.

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

string (Timestamp format)

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

הפורמט הזה משתמש ב-RFC 3339, שבו הפלט שנוצר תמיד יהיה מנורמלי לפי Z וישמש בספרות עשרוניות של 0, 3, 6 או 9. אפשר להשתמש גם בשינויים (offsets) אחרים מלבד '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

אפשרויות להחזקות Voice.

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

enum (VoiceCoveredData)

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

HeldCalendarQuery

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

אפשרויות לאירועים שמתוזמנים ביומן.

Methods

addHeldAccounts

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

create

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

delete

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

get

 אחזור של האישור וההחזקה שצוינו.

list

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

removeHeldAccounts

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

update

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