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)

ครั้งล่าสุดที่แก้ไขการระงับนี้

การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "Zulu" ที่มีความละเอียดระดับนาโนวินาทีและมีตัวเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"
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)

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

การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "Zulu" ที่มีความละเอียดระดับนาโนวินาทีและมีตัวเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่าง: "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)
  },
  "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)

ตัวเลือกเฉพาะบริการสำหรับการระงับด้วยเสียง หากตั้งค่าแล้ว 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 น. ในวันที่ที่ระบุ

การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "Zulu" ที่มีความละเอียดระดับนาโนวินาทีและมีตัวเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"
endTime

string (Timestamp format)

เวลาสิ้นสุดของการค้นหา ระบุใน GMT โดยจะปัดเศษค่าเป็น 00:00 น. ในวันที่ที่ระบุ

การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "Zulu" ที่มีความละเอียดระดับนาโนวินาทีและมีตัวเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่าง: "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 "Zulu" ที่มีความละเอียดระดับนาโนวินาทีและมีตัวเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"
endTime

string (Timestamp format)

เวลาสิ้นสุดของการค้นหา ระบุใน GMT โดยจะปัดเศษค่าเป็น 00:00 น. ในวันที่ที่ระบุ

การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "Zulu" ที่มีความละเอียดระดับนาโนวินาทีและมีตัวเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"

HeldHangoutsChatQuery

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

การแสดง JSON 
{
  "includeRooms": boolean
}
ช่อง
includeRooms

boolean

หากต้องการรวมข้อความจากพื้นที่ใน Chat ที่ผู้ใช้เป็นสมาชิกอยู่ ให้ตั้งค่าเป็น true

HeldVoiceQuery

ตัวเลือกสำหรับการระงับด้วยเสียง

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

enum (VoiceCoveredData)

รายการประเภทข้อมูลที่การคงไว้ชั่วคราวครอบคลุม ไม่ควรว่างเปล่า ไม่คำนึงถึงลำดับและระบบจะไม่พิจารณารายการซ้ำ

HeldCalendarQuery

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

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

วิธีการ

addHeldAccounts

 เพิ่มบัญชีไปยังการคงไว้ชั่วคราว

create

 สร้างการเก็บรักษาในกรณีที่ระบุ

delete

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

get

 รับการเก็บรักษาที่ระบุ

list

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

removeHeldAccounts

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

update

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