REST Resource: matters.holds

แหล่งข้อมูล: การระงับ

การคงไว้ชั่วคราว การคงไว้ชั่วคราวจะป้องกันไม่ให้บริการ Google Workspace ที่ระบุล้างข้อมูลสำหรับบัญชีที่เฉพาะเจาะจงหรือสมาชิกทั้งหมดของหน่วยขององค์กร

หากต้องการทำงานกับทรัพยากรของห้องนิรภัย บัญชีต้องมีสิทธิ์ของห้องนิรภัยที่จำเป็นและสิทธิ์เข้าถึงกรณี หากต้องการเข้าถึงกรณี บัญชีต้องเป็นผู้สร้างกรณี มีการแชร์กรณีกับบัญชี หรือมีสิทธิ์ดูกรณีทั้งหมด

การแสดง 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

รหัสที่ไม่เปลี่ยนแปลงของหน่วยขององค์กรตามที่ Admin 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)
  }
}
ช่อง
ฟิลด์ Union corpus_query หากตั้งค่าไว้ ค่านี้ต้องตรงกับประเภทบริการ corpus_query ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
driveQuery

object (HeldDriveQuery)

ตัวเลือกเฉพาะบริการสำหรับการระงับในไดรฟ์ หากตั้งค่าไว้ CorpusType ต้องเป็น DRIVE
mailQuery

object (HeldMailQuery)

ตัวเลือกเฉพาะบริการสำหรับการเก็บรักษาของ Gmail หากตั้งค่าไว้ CorpusType ต้องเป็น MAIL
groupsQuery

object (HeldGroupsQuery)

ตัวเลือกเฉพาะบริการสำหรับการระงับของ Groups หากตั้งค่าไว้ 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

ตัวเลือกสำหรับการคงไว้ชั่วคราวของไดรฟ์

การแสดง 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 หลัก นอกจากนี้ ระบบยังยอมรับออฟเซ็ตอื่นๆ นอกเหนือจาก "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 หลัก นอกจากนี้ ระบบยังยอมรับออฟเซ็ตอื่นๆ นอกเหนือจาก "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 หลัก นอกจากนี้ ระบบยังยอมรับออฟเซ็ตอื่นๆ นอกเหนือจาก "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 หลัก นอกจากนี้ ระบบยังยอมรับออฟเซ็ตอื่นๆ นอกเหนือจาก "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

เมธอด

addHeldAccounts

 เพิ่มบัญชีที่จะเก็บรักษาข้อมูล

create

 สร้างการคงไว้ชั่วคราวในกรณีที่ระบุ

delete

 นำการคงไว้ชั่วคราวที่ระบุออกและปล่อยบัญชีหรือหน่วยขององค์กรที่อยู่ภายใต้การคงไว้ชั่วคราว

get

 รับการคงไว้ชั่วคราวที่ระบุ

list

 แสดงรายการการคงไว้ชั่วคราวในกรณี

removeHeldAccounts

 นำบัญชีที่ระบุออกจากการเก็บรักษา

update

 อัปเดตขอบเขต (หน่วยขององค์กรหรือบัญชี) และพารามิเตอร์การค้นหาของการเก็บรักษา