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-normalized เสมอ และใช้ตัวเลขทศนิยม 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)

หากตั้งค่าไว้ การคงไว้ชั่วคราวจะมีผลกับสมาชิกทุกคนในหน่วยขององค์กร และบัญชีต้องว่างเปล่า พร็อพเพอร์ตี้นี้เปลี่ยนแปลงได้ สำหรับการเก็บรักษาของ Groups ให้ตั้งค่าบัญชี
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-normalized เสมอ และใช้ตัวเลขทศนิยม 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 
{

  // 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)

ตัวเลือกเฉพาะบริการสำหรับการระงับบัญชีในไดรฟ์ หากตั้งค่าไว้ 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

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-normalized เสมอ และใช้ตัวเลขทศนิยม 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-normalized เสมอ และใช้ตัวเลขทศนิยม 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-normalized เสมอ และใช้ตัวเลขทศนิยม 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-normalized เสมอ และใช้ตัวเลขทศนิยม 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

ตัวเลือกสำหรับโหมดพักสายของ Voice

การแสดง JSON 
{
  "coveredData": [
    enum (VoiceCoveredData)
  ]
}
ช่อง
coveredData[]

enum (VoiceCoveredData)

รายการประเภทข้อมูลที่โฮลด์มีผล ไม่ควรว่างเปล่า ลำดับไม่สำคัญและระบบจะไม่สนใจรายการที่ซ้ำกัน

HeldCalendarQuery

ประเภทนี้ไม่มีช่อง

ตัวเลือกสำหรับโหมดการระงับปฏิทิน

เมธอด

addHeldAccounts

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

create

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

delete

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

get

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

list

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

removeHeldAccounts

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

update

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