REST Resource: matters.holds

Tài nguyên: Giữ lại

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

Để làm việc với các tài nguyên của Vault, tài khoản phải có các đặc quyền bắt buộc của Vault và quyền truy cập vào vấn đề. Để truy cập vào một vấn đề, tài khoản phải đã tạo vấn đề, chia sẻ vấn đề với họ hoặc có đặc quyền Xem tất cả cá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)
  }
}
Các trường
holdId

string

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

string

Tên yêu cầu lưu giữ dữ liệu.
updateTime

string (Timestamp format)

Lần sửa đổi gần đây nhất về yêu cầu lưu giữ dữ liệu này.

Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, với độ phân giải nano giây và tối đa 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".
accounts[]

object (HeldAccount)

Nếu bạn đặt chính sách này, thì yêu cầu lưu giữ dữ liệu sẽ áp dụng cho các tài khoản đã chỉ định và phải để trống orgUnit.
orgUnit

object (HeldOrgUnit)

Nếu bạn đặt chính sách này, thì yêu cầu lưu giữ dữ liệu sẽ áp dụng cho mọi 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ể thay đổi. Đối với yêu cầu lưu giữ dữ liệu trên Groups, hãy thiết lập tài khoản.
corpus

enum (CorpusType)

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

object (CorpusQuery)

Tuỳ 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 một yêu cầu lưu giữ dữ liệu. Cấu trúc này là bất biến.

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

string

Mã không thể thay đổi của đơn vị tổ chức do SDK quản trị cung cấp.
holdTime

string (Timestamp format)

Khi đơn vị tổ chức bị tạm ngưng. Thuộc tính này không thể thay đổi.

Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, với độ phân giải nano giây và tối đa 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".

CorpusQuery

Các tuỳ chọn dành riêng cho dịch vụ của yêu cầu lưu giữ dữ liệu.

Biểu diễn dưới dạng 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)
  }
  // End of list of possible types for union field corpus_query.
}
Các 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 đây:
driveQuery

object (HeldDriveQuery)

Các tuỳ chọn dành riêng cho dịch vụ của yêu cầu lưu giữ dữ liệu trên Drive. Nếu được đặt, giá trị CorpusType phải là DRIVE.
mailQuery

object (HeldMailQuery)

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

object (HeldGroupsQuery)

Các tuỳ chọn dành riêng cho dịch vụ đối với yêu cầu lưu giữ dữ liệu trong Groups. Nếu đặt, CorpusType phải là groups.
hangoutsChatQuery

object (HeldHangoutsChatQuery)

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

object (HeldVoiceQuery)

Các tuỳ chọn dành riêng cho dịch vụ cho yêu cầu lưu giữ dữ liệu Voice. Nếu được đặt, giá trị CorpusType phải là VOICE.

HeldDriveQuery

Các lựa chọn về yêu cầu lưu giữ dữ liệu trên Drive.

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

boolean

Để đưa các tệp trong Drive nhóm vào yêu cầu lưu giữ dữ liệu, hãy đặt thành true.
includeSharedDriveFiles

boolean

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

HeldMailQuery

Tuỳ chọn truy vấn đối với yêu cầu lưu giữ dữ liệu trong Gmail.

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

string

Các toán tử tìm kiếm dùng để tinh chỉnh những tin nhắn thuộc phạm vi yêu cầu lưu giữ dữ liệu.
startTime

string (Timestamp format)

Thời gian bắt đầu truy vấn. Nêu rõ theo giờ GMT. Giá trị này được làm tròn đến 12 giờ đêm vào ngày được chỉ định.

Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, với độ phân giải nano giây và tối đa 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

Thời gian kết thúc cho truy vấn. Nêu rõ theo giờ GMT. Giá trị này được làm tròn đến 12 giờ đêm vào ngày được chỉ định.

Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, với độ phân giải nano giây và tối đa 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".

HeldGroupsQuery

Tuỳ 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
}
Các trường
terms

string

Các toán tử tìm kiếm dùng để tinh chỉnh những tin nhắn thuộc phạm vi yêu cầu lưu giữ dữ liệu.
startTime

string (Timestamp format)

Thời gian bắt đầu truy vấn. Nêu rõ theo giờ GMT. Giá trị này được làm tròn đến 12 giờ đêm vào ngày được chỉ định.

Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, với độ phân giải nano giây và tối đa 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

Thời gian kết thúc cho truy vấn. Nêu rõ theo giờ GMT. Giá trị này được làm tròn đến 12 giờ đêm vào ngày được chỉ định.

Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, với độ phân giải nano giây và tối đa 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".

HeldHangoutsChatQuery

Các tuỳ chọn về yêu cầu lưu giữ dữ liệu trong Chat.

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

boolean

Để đưa tin nhắn vào phòng Chat mà người dùng là thành viên, hãy đặt thành true.

HeldVoiceQuery

Các tuỳ chọn dành cho yêu cầu lưu giữ dữ liệu trong Voice.

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

enum (VoiceCoveredData)

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

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ữ dữ liệu trong vấn đề đã chỉ định.

delete

 Xoá yêu cầu lưu giữ dữ liệu đã chỉ định và huỷ bỏ 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ữ dữ liệu đó.

get

 Lấy yêu cầu lưu giữ dữ liệu được chỉ định.

list

 Liệt kê các yêu cầu lưu giữ dữ liệu liên quan đến một vấn đề.

removeHeldAccounts

 Xóa các tài khoản được chỉ định khỏi yêu cầu lưu giữ dữ liệu.

update

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