REST Resource: matters.holds

Tài nguyên: Giữ

Yêu cầu lưu giữ. Lệnh giữ ngăn dịch vụ Google Workspace được chỉ định xoá dữ liệu đối với một số tài khoản cụ thể hoặc tất cả thành viên của một đơn vị tổ chức.

Để sử dụng các tài nguyên trên Vault, tài khoản phải có các đặc quyền bắt buộc đối với Vault và quyền truy cập vào vụ việc. Để truy cập vào một vấn đề, tài khoản phải là tài khoản đã tạo vấn đề đó, được chia sẻ vấn đề đó hoặc có đặc quyền Xem tất cả vấn đề.

Biểu diễn dưới dạng JSON 
{
  "holdId": string,
  "name": string,
  "updateTime": string,
  "accounts": [
    {
      object (HeldAccount)
    }
  ],
  "orgUnit": {
    object (HeldOrgUnit)
  },
  "corpus": enum (CorpusType),
  "query": {
    object (CorpusQuery)
  }
}
Trường
holdId

string

Mã nhận dạng duy nhất, không thay đổi của lệnh giữ. Được chỉ định trong quá trình tạo.
name

string

Tên của lệnh giữ lại.
updateTime

string (Timestamp format)

Lần gần nhất lệnh giữ này được sửa đổi.

Hãy dùng RFC 3339, trong đó dữ liệu đầu ra được tạo sẽ luôn được chuẩn hoá theo múi giờ và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các khoảng lệch khác ngoài "Z" cũng được chấp nhận. Ví dụ: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" hoặc "2014-10-02T15:01:23+05:30".
accounts[]

object (HeldAccount)

Nếu được đặt, lệnh tạm ngưng sẽ áp dụng cho các tài khoản được chỉ định và orgUnit phải trống.
orgUnit

object (HeldOrgUnit)

Nếu được đặt, lệnh giữ lại sẽ áp dụng cho tất cả thành viên của đơn vị tổ chức và tài khoản phải trống. Thuộc tính này có thể biến đổi. Đối với lệnh giữ Nhóm, hãy đặt accounts.
corpus

enum (CorpusType)

Dịch vụ cần tìm kiếm.
query

object (CorpusQuery)

Các lựa chọn dành riêng cho dịch vụ. Nếu được đặt, CorpusQuery phải khớp với CorpusType.

HeldOrgUnit

Đơn vị tổ chức thuộc phạm vi của yêu cầu lưu giữ. Cấu trúc này là bất biến.

Biểu diễn dưới dạng JSON 
{
  "orgUnitId": string,
  "holdTime": string
}
Trường
orgUnitId

string

Mã nhận dạng bất biến của đơn vị tổ chức do SDK dành cho quản trị viên cung cấp.
holdTime

string (Timestamp format)

Thời điểm đơn vị tổ chức được đặt yêu cầu lưu giữ. Thuộc tính này là bất biến.

Hãy dùng RFC 3339, trong đó dữ liệu đầu ra được tạo sẽ luôn được chuẩn hoá theo múi giờ và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các khoảng lệch khác ngoài "Z" cũng được chấp nhận. Ví dụ: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" hoặc "2014-10-02T15:01:23+05:30".

CorpusQuery

Các lựa chọn tạm ngưng theo từng dịch vụ.

Biểu diễn dưới dạng JSON 
{

  "driveQuery": {
    object (HeldDriveQuery)
  },
  "mailQuery": {
    object (HeldMailQuery)
  },
  "groupsQuery": {
    object (HeldGroupsQuery)
  },
  "hangoutsChatQuery": {
    object (HeldHangoutsChatQuery)
  },
  "voiceQuery": {
    object (HeldVoiceQuery)
  },
  "calendarQuery": {
    object (HeldCalendarQuery)
  },
  "geminiQuery": {
    object (HeldGeminiQuery)
  }
}
Trường
Trường nhóm corpus_query. Nếu được đặt, giá trị này phải khớp với loại dịch vụ. corpus_query chỉ có thể là một trong những trạng thái sau:
driveQuery

object (HeldDriveQuery)

Các lựa chọn dành riêng cho dịch vụ đối với lệnh giữ lại trong Drive. Nếu được đặt, CorpusType phải là DRIVE.
mailQuery

object (HeldMailQuery)

Các lựa chọn dành riêng cho dịch vụ đối với lệnh giữ trong Gmail. Nếu được đặt, CorpusType phải là MAIL.
groupsQuery

object (HeldGroupsQuery)

Các lựa chọn theo dịch vụ đối với lệnh giữ lại của Nhóm. Nếu được đặt, CorpusType phải là GROUPS.
hangoutsChatQuery

object (HeldHangoutsChatQuery)

Các lựa chọn dành riêng cho dịch vụ đối với yêu cầu lưu giữ dữ liệu trong Chat. Nếu được đặt, CorpusType phải là HANGOUTS_CHAT.
voiceQuery

object (HeldVoiceQuery)

Các lựa chọn dành riêng cho dịch vụ đối với tính năng Giữ cuộc gọi bằng giọng nói. Nếu được đặt, CorpusType phải là VOICE.
calendarQuery

object (HeldCalendarQuery)

Các lựa chọn dành riêng cho dịch vụ đối với sự kiện giữ chỗ trên Lịch. Nếu được đặt, CorpusType phải là CALENDAR.
geminiQuery

object (HeldGeminiQuery)

Các lựa chọn theo từng dịch vụ đối với lệnh giữ lại của Gemini. Nếu được đặt, CorpusType phải là GEMINI.

HeldDriveQuery

Các lựa chọn về lệnh giữ trên Drive.

Biểu diễn dưới dạng JSON 
{
  "includeTeamDriveFiles": boolean,
  "includeSharedDriveFiles": boolean
}
Trường
includeTeamDriveFiles
(deprecated)

boolean

Để đưa các tệp trong ổ đĩa nhóm vào lệnh giữ lại, hãy đặt thành true.
includeSharedDriveFiles

boolean

Để đưa các tệp trong bộ nhớ dùng chung vào lệnh giữ lại, hãy đặt thành true.

HeldMailQuery

Các lựa chọn về cụm từ tìm kiếm cho lệnh giữ dữ liệu trong Gmail.

Biểu diễn dưới dạng JSON 
{
  "terms": string,
  "startTime": string,
  "endTime": string
}
Trường
terms

string

Toán tử tìm kiếm được dùng để tinh chỉnh những tin nhắn thuộc phạm vi lưu giữ.
startTime

string (Timestamp format)

Thời gian bắt đầu của truy vấn. Chỉ định theo giờ GMT. Giá trị được làm tròn đến 00:00 vào ngày đã chỉ định.

Hãy dùng RFC 3339, trong đó dữ liệu đầu ra được tạo sẽ luôn được chuẩn hoá theo múi giờ và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các khoảng lệch khác ngoài "Z" cũng được chấp nhận. Ví dụ: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" hoặc "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Thời gian kết thúc của truy vấn. Chỉ định theo giờ GMT. Giá trị được làm tròn đến 00:00 vào ngày đã chỉ định.

Hãy dùng RFC 3339, trong đó dữ liệu đầu ra được tạo sẽ luôn được chuẩn hoá theo múi giờ và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các khoảng lệch khác ngoài "Z" cũng được chấp nhận. Ví dụ: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" hoặc "2014-10-02T15:01:23+05:30".

HeldGroupsQuery

Các lựa chọn truy vấn cho yêu cầu lưu giữ dữ liệu của nhóm.

Biểu diễn dưới dạng JSON 
{
  "terms": string,
  "startTime": string,
  "endTime": string
}
Trường
terms

string

Toán tử tìm kiếm được dùng để tinh chỉnh những tin nhắn thuộc phạm vi lưu giữ.
startTime

string (Timestamp format)

Thời gian bắt đầu của truy vấn. Chỉ định theo giờ GMT. Giá trị được làm tròn đến 00:00 vào ngày đã chỉ định.

Hãy dùng RFC 3339, trong đó dữ liệu đầu ra được tạo sẽ luôn được chuẩn hoá theo múi giờ và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các khoảng lệch khác ngoài "Z" cũng được chấp nhận. Ví dụ: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" hoặc "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Thời gian kết thúc của truy vấn. Chỉ định theo giờ GMT. Giá trị được làm tròn đến 00:00 vào ngày đã chỉ định.

Hãy dùng RFC 3339, trong đó dữ liệu đầu ra được tạo sẽ luôn được chuẩn hoá theo múi giờ và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các khoảng lệch khác ngoài "Z" cũng được chấp nhận. Ví dụ: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" hoặc "2014-10-02T15:01:23+05:30".

HeldHangoutsChatQuery

Các lựa chọn cho yêu cầu lưu giữ dữ liệu trong Chat.

Biểu diễn dưới dạng JSON 
{
  "includeRooms": boolean
}
Trường
includeRooms

boolean

Để bao gồm cả tin nhắn trong các phòng Chat mà người dùng là thành viên, hãy đặt thành true.

HeldVoiceQuery

Các lựa chọn cho tính năng Giữ giọng nói.

Biểu diễn dưới dạng JSON 
{
  "coveredData": [
    enum (VoiceCoveredData)
  ]
}
Trường
coveredData[]

enum (VoiceCoveredData)

Danh sách các loại dữ liệu thuộc phạm vi áp dụng của lệnh giữ lại. Không được để trống. Thứ tự không quan trọng và các giá trị trùng lặp sẽ bị bỏ qua.

HeldCalendarQuery

Loại này không có trường nào.

Các lựa chọn cho sự kiện giữ chỗ trên Lịch.

HeldGeminiQuery

Loại này không có trường nào.

Các lựa chọn về lệnh tạm dừng Gemini.

Phương thức

addHeldAccounts

 Thêm tài khoản vào yêu cầu lưu giữ dữ liệu.

create

 Tạo yêu cầu lưu giữ trong vấn đề được chỉ định.

delete

 Xoá yêu cầu lưu giữ được chỉ định và giải phóng các tài khoản hoặc đơn vị tổ chức thuộc phạm vi của yêu cầu lưu giữ đó.

get

 Lấy lệnh giữ được chỉ định.

list

 Liệt kê các lệnh giữ lại trong một vấn đề.

removeHeldAccounts

 Xoá các tài khoản được chỉ định khỏi yêu cầu lưu giữ.

update

 Cập nhật phạm vi (đơn vị tổ chức hoặc tài khoản) và các tham số truy vấn của yêu cầu lưu giữ.