REST Resource: matters.holds

Tài nguyên: Giữ

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

Để xử lý các tài nguyên trong 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ấn đề. Để truy cập vào một vấn đề, tài khoản phải là người 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 và không thể thay đổi của lệnh giữ. Được chỉ định trong quá trình tạo.
name

string

Tên của khoản tiền giữ lại.
updateTime

string (Timestamp format)

Lần gần đây nhất mà lệnh tạm ngưng này được sửa đổi.

Sử dụng RFC 3339, trong đó đầu ra được tạo sẽ luôn được chuẩn hoá theo Z và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các độ dời 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, trạng thái 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, trạng thái tạm ngưng 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ể thay đổi. Đối với các khoản giữ lại trong Nhóm, hãy đặt tài khoản.
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 chịu ảnh hưởng của yêu cầu lưu giữ dữ liệu. Cấu trúc này không thể thay đổi.

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

string

Mã nhận dạng không thể thay đổi 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 bị tạm ngưng. Thuộc tính này không thể thay đổi.

Sử dụng RFC 3339, trong đó đầu ra được tạo sẽ luôn được chuẩn hoá theo Z và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các độ dời 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 dành riêng cho dịch vụ đối với việc giữ chỗ.

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)
  },
  "calendarQuery": {
    object (HeldCalendarQuery)
  }
  // End of list of possible types for union field corpus_query.
}
Trường
Trường hợp hợp nhất 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 loại sau:
driveQuery

object (HeldDriveQuery)

Các lựa chọn dành riêng cho dịch vụ đối với trường hợp tạm ngưng trên 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 trường hợp tạm ngưng trên Gmail. Nếu được đặt, CorpusType phải là MAIL.
groupsQuery

object (HeldGroupsQuery)

Các tuỳ chọn theo dịch vụ cho yêu cầu lưu giữ dữ liệu của Nhóm. Nếu được đặt, CorpusType phải là GROUPS.
hangoutsChatQuery

object (HeldHangoutsChatQuery)

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 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 thoại. Nếu được đặt, CorpusType phải là VOICE.
calendarQuery

object (HeldCalendarQuery)

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

HeldDriveQuery

Các lựa chọn đối với việc tạm ngưng 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 Drive nhóm vào trạng thái tạm ngưng, hãy đặt thành true.
includeSharedDriveFiles

boolean

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

HeldMailQuery

Các tuỳ chọn truy vấn cho yêu cầu lưu giữ 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 dùng để tinh chỉnh những thư thuộc phạm vi áp dụng của lệnh giữ.
startTime

string (Timestamp format)

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

Sử dụng RFC 3339, trong đó đầu ra được tạo sẽ luôn được chuẩn hoá theo Z và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các độ dời 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 thành 00:00 vào ngày được chỉ định.

Sử dụng RFC 3339, trong đó đầu ra được tạo sẽ luôn được chuẩn hoá theo Z và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các độ dời 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

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
}
Trường
terms

string

Toán tử tìm kiếm dùng để tinh chỉnh những thư thuộc phạm vi áp dụng của lệnh giữ.
startTime

string (Timestamp format)

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

Sử dụng RFC 3339, trong đó đầu ra được tạo sẽ luôn được chuẩn hoá theo Z và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các độ dời 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 thành 00:00 vào ngày được chỉ định.

Sử dụng RFC 3339, trong đó đầu ra được tạo sẽ luôn được chuẩn hoá theo Z và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các độ dời 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 trên 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ữ cuộc gọi thoạ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ữ. 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.

HeldCalendarQuery

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

Các lựa chọn cho việc tạm ngưng trong Lịch.

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ỷ yêu cầu lưu giữ dữ liệu đối với các tài khoản hoặc đơn vị tổ chức chịu ảnh hưởng của yêu cầu đó.

get

 Lấy lệnh giữ đã chỉ định.

list

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

removeHeldAccounts

 Xoá các tài khoản đã chỉ định khỏi trạng thái tạm ngưng.

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 một yêu cầu lưu giữ.