Query

Định nghĩa truy vấn được dùng để tìm kiếm và xuất.

Biểu diễn dưới dạng JSON 
{
  "corpus": enum (CorpusType),
  "dataScope": enum (DataScope),
  "searchMethod": enum (SearchMethod),
  "method": enum (SearchMethod),
  "terms": string,
  "startTime": string,
  "endTime": string,
  "teamDriveInfo": {
    object (TeamDriveInfo)
  },
  "timeZone": string,

  // Union field search_method_field can be only one of the following:
  "accountInfo": {
    object (AccountInfo)
  },
  "orgUnitInfo": {
    object (OrgUnitInfo)
  },
  "sharedDriveInfo": {
    object (SharedDriveInfo)
  },
  "hangoutsChatInfo": {
    object (HangoutsChatInfo)
  },
  "sitesUrlInfo": {
    object (SitesUrlInfo)
  }
  // End of list of possible types for union field search_method_field.

  // Union field corpus_options_field can be only one of the following:
  "mailOptions": {
    object (MailOptions)
  },
  "driveOptions": {
    object (DriveOptions)
  },
  "hangoutsChatOptions": {
    object (HangoutsChatOptions)
  },
  "voiceOptions": {
    object (VoiceOptions)
  },
  "calendarOptions": {
    object (CalendarOptions)
  }
  // End of list of possible types for union field corpus_options_field.
}
Trường
corpus

enum (CorpusType)

Dịch vụ Google Workspace để tìm kiếm.
dataScope

enum (DataScope)

Nguồn dữ liệu cần tìm kiếm.
searchMethod
(deprecated)

enum (SearchMethod)

Phương thức tìm kiếm cần sử dụng.
method

enum (SearchMethod)

Thực thể cần tìm kiếm. Trường này thay thế searchMethod để hỗ trợ bộ nhớ dùng chung. Khi searchMethod là team_DRIVE, phản hồi của trường này là SHARED_DRIVE.
terms

string

Toán tử tìm kiếm theo dịch vụ để lọc kết quả tìm kiếm.
startTime

string (Timestamp format)

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

Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, có độ phân giải nano giây và tối đa 9 chữ số thập phân. 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 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.

Dấu thời gian theo múi giờ "Zulu" RFC3339 (giờ UTC) với độ phân giải nano giây và lên đến 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".
teamDriveInfo
(deprecated)

object (TeamDriveInfo)

Bắt buộc khi SearchMethod là team_DRIVE.
timeZone

string

Tên múi giờ. Đây phải là tên IANA TZ, chẳng hạn như "America/Los_Angeles". Để biết danh sách tên múi giờ, hãy xem phần Múi giờ. Để biết thêm thông tin về cách Vault sử dụng múi giờ, hãy xem Trung tâm trợ giúp của Vault.
Trường hợp hợp nhất search_method_field. Khi được yêu cầu, thông tin chi tiết về đối tượng cần tìm kiếm search_method_field chỉ được là một trong các thông tin sau:
accountInfo

object (AccountInfo)

Bắt buộc khi SearchMethod là ACCOUNT.
orgUnitInfo

object (OrgUnitInfo)

Bắt buộc khi SearchMethod là ORG_UNIT.
sharedDriveInfo

object (SharedDriveInfo)

Bắt buộc khi SearchMethod là SHARED_DRIVE.
hangoutsChatInfo

object (HangoutsChatInfo)

Bắt buộc khi SearchMethod là ROOM. (chỉ đọc)
sitesUrlInfo

object (SitesUrlInfo)

Bắt buộc khi SearchMethod là Google_URL.
Trường kết hợp corpus_options_field. Các lựa chọn tìm kiếm bổ sung cho các dịch vụ cụ thể. corpus_options_field chỉ có thể là một trong những trạng thái sau đây:
mailOptions

object (MailOptions)

Đặt các tuỳ chọn dành riêng cho tính năng tìm kiếm trên Gmail.
driveOptions

object (DriveOptions)

Đặt các lựa chọn cho tìm kiếm cụ thể trên Drive.
hangoutsChatOptions

object (HangoutsChatOptions)

Đặt tuỳ chọn dành riêng cho tìm kiếm trong Chat. (chỉ đọc)
voiceOptions

object (VoiceOptions)

Đặt các tuỳ chọn dành riêng cho tính năng Tìm kiếm bằng giọng nói.
calendarOptions

object (CalendarOptions)

Đặt tuỳ chọn dành riêng cho tìm kiếm trên Lịch.

DataScope

Nguồn dữ liệu để tìm kiếm.

Enum
DATA_SCOPE_UNSPECIFIED Chưa chỉ định nguồn dữ liệu.
ALL_DATA Tất cả dữ liệu có sẵn.
HELD_DATA Chỉ dữ liệu bị tạm ngưng.
UNPROCESSED_DATA Chỉ dữ liệu chưa được Vault xử lý. (Chỉ Gmail và Groups)

SearchMethod

Loại thực thể cho nội dung tìm kiếm.

Enum
SEARCH_METHOD_UNSPECIFIED Bạn phải chỉ định phương thức tìm kiếm, nếu không, phương thức tìm kiếm đó sẽ bị từ chối.
ACCOUNT Tìm kiếm dữ liệu của các tài khoản được chỉ định trong AccountInfo.
ORG_UNIT Tìm kiếm dữ liệu của tất cả tài khoản trong đơn vị tổ chức được chỉ định trong OrgUnitInfo.
TEAM_DRIVE

Tìm dữ liệu trong Drive nhóm được chỉ định trong teamDriveInfo.
ENTIRE_ORG Tìm kiếm dữ liệu của tất cả tài khoản trong tổ chức. Chỉ được hỗ trợ cho Gmail. Khi chỉ định, bạn không cần chỉ định AccountInfo hoặc OrgUnitInfo.
ROOM Tìm kiếm tin nhắn trong các phòng Chat được chỉ định trong HangoutsChatInfo.
SITES_URL Tìm kiếm trang web theo URL trang web đã xuất bản được chỉ định trong SitesUrlInfo.
SHARED_DRIVE Tìm kiếm các tệp trong bộ nhớ dùng chung được chỉ định trong SharedDriveInfo.

AccountInfo

Tài khoản cần tìm kiếm

Biểu diễn dưới dạng JSON 
{
  "emails": [
    string
  ]
}
Trường
emails[]

string

Một nhóm tài khoản để tìm kiếm.

OrgUnitInfo

Đơn vị tổ chức cần tìm kiếm

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

string

Tên của đơn vị tổ chức cần tìm kiếm, do Admin SDK Directory API cung cấp.

SharedDriveInfo

Các bộ nhớ dùng chung cần tìm kiếm

Biểu diễn dưới dạng JSON 
{
  "sharedDriveIds": [
    string
  ]
}
Trường
sharedDriveIds[]

string

Danh sách mã bộ nhớ dùng chung, do API Drive cung cấp.

HangoutsChatInfo

Phòng Chat cần tìm

Biểu diễn dưới dạng JSON 
{
  "roomId": [
    string
  ]
}
Trường
roomId[]

string

Danh sách mã phòng Chat do Chat API cung cấp. Bạn chỉ có thể xuất tối đa 500 phòng Chat trong mỗi yêu cầu.

SitesUrlInfo

URL của trang web đã xuất bản trên Google Sites mới để tìm kiếm

Biểu diễn dưới dạng JSON 
{
  "urls": [
    string
  ]
}
Trường
urls[]

string

Danh sách URL trang web đã xuất bản.

TeamDriveInfo

Drive nhóm để tìm kiếm

Biểu diễn dưới dạng JSON 
{
  "teamDriveIds": [
    string
  ]
}
Trường
teamDriveIds[]
(deprecated)

string

Danh sách mã nhận dạng Drive nhóm do API Drive cung cấp.

MailOptions

Các tuỳ chọn bổ sung khi tìm kiếm trong Gmail

Biểu diễn dưới dạng JSON 
{
  "excludeDrafts": boolean,
  "clientSideEncryptedOption": enum (ClientSideEncryptedOption)
}
Trường
excludeDrafts

boolean

Đặt thành true để loại trừ bản nháp.
clientSideEncryptedOption

enum (ClientSideEncryptedOption)

Chỉ định xem kết quả có bao gồm nội dung đã mã hoá, nội dung chưa mã hoá hay cả hai. Mặc định là bao gồm cả hai.

ClientSideEncryptedOption

Nếu tổ chức của bạn sử dụng tính năng Mã hoá phía máy khách của Google Workspace, thì trạng thái mã hoá của nội dung

Enum
CLIENT_SIDE_ENCRYPTED_OPTION_UNSPECIFIED Chưa xác định trạng thái mã hoá. Kết quả bao gồm cả nội dung được mã hoá phía máy khách và nội dung chưa mã hoá.
CLIENT_SIDE_ENCRYPTED_OPTION_ANY Cung cấp cả nội dung đã mã hoá và chưa mã hoá phía máy khách trong kết quả.
CLIENT_SIDE_ENCRYPTED_OPTION_ENCRYPTED Chỉ bao gồm nội dung được mã hoá phía máy khách.
CLIENT_SIDE_ENCRYPTED_OPTION_UNENCRYPTED Chỉ bao gồm nội dung chưa mã hoá.

DriveOptions

Các lựa chọn khác cho tính năng tìm kiếm trên Drive

Biểu diễn dưới dạng JSON 
{
  "versionDate": string,
  "includeTeamDrives": boolean,
  "includeSharedDrives": boolean,
  "clientSideEncryptedOption": enum (ClientSideEncryptedOption)
}
Trường
versionDate

string (Timestamp format)

Tìm kiếm phiên bản hiện tại của tệp trên Drive, nhưng xuất nội dung của phiên bản gần đây nhất được lưu trước 0:00 (giờ UTC) vào ngày được chỉ định. Nhập ngày theo giờ UTC.

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

boolean

Đặt thành đúng để bao gồm Drive nhóm.
includeSharedDrives

boolean

Đặt thành true để bao gồm bộ nhớ dùng chung.
clientSideEncryptedOption

enum (ClientSideEncryptedOption)

Thiết lập xem kết quả chỉ bao gồm nội dung được mã hoá bằng tính năng Mã hoá phía máy khách của Google Workspace, chỉ bao gồm nội dung chưa mã hoá hay cả hai. Giá trị mặc định là cả hai. Hiện được hỗ trợ cho Drive.

HangoutsChatOptions

Các lựa chọn khác cho tính năng tìm kiếm trên Google Chat

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

boolean

Đối với các lượt tìm kiếm theo tài khoản hoặc đơn vị tổ chức, hãy đặt thành true để bao gồm phòng.

VoiceOptions

Các tuỳ chọn khác cho tính năng Tìm kiếm bằng giọng nói

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

enum (VoiceCoveredData)

Loại dữ liệu để tìm kiếm

CalendarOptions

Các tuỳ chọn khác để tìm kiếm trên Lịch

Biểu diễn dưới dạng JSON 
{
  "locationQuery": [
    string
  ],
  "peopleQuery": [
    string
  ],
  "minusWords": [
    string
  ],
  "responseStatuses": [
    enum (AttendeeResponse)
  ],
  "versionDate": string
}
Trường
locationQuery[]

string

Chỉ so khớp những sự kiện có vị trí chứa tất cả các từ trong tập hợp đã cho. Nếu chuỗi chứa các cụm từ được trích dẫn, phương thức này chỉ so khớp những sự kiện có vị trí chứa chính xác cụm từ đó. Các mục trong tập hợp được xem xét theo "và".

Ví dụ về việc tách từ: ["New Zealand"] đấu với ["New Zealand","Zealand"] "New Zealand": khớp với cả "New Zealand": chỉ khớp với
peopleQuery[]

string

Chỉ khớp những sự kiện có người tham dự chứa tất cả các từ trong nhóm đã cho. Các mục trong tập hợp được xem xét theo "và".
minusWords[]

string

Chỉ khớp những sự kiện không chứa bất kỳ từ nào trong nhóm đã cho về tiêu đề, nội dung mô tả, vị trí hoặc người tham dự. Các mục nhập trong tập hợp này được coi là giá trị "or".
responseStatuses[]

enum (AttendeeResponse)

Chỉ khớp với những sự kiện mà người giám hộ đã đưa ra một trong những phản hồi này. Nếu tập hợp này trống hoặc chứa ATTENDEE_RESPONSE_UNSPECIFIED, thì hệ thống sẽ không lọc các phản hồi.
versionDate

string (Timestamp format)

Tìm kiếm phiên bản hiện tại của sự kiện trên Lịch, nhưng xuất nội dung của phiên bản gần nhất được lưu trước 0:00 (giờ UTC) vào ngày được chỉ định. Nhập ngày theo giờ UTC.

Dấu thời gian theo múi giờ "Zulu" RFC3339 (giờ UTC) với độ phân giải nano giây và lên đến 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".

AttendeeResponse

Phản hồi của người dùng đối với lời mời.

Enum
ATTENDEE_RESPONSE_UNSPECIFIED Chưa xác định câu trả lời của người tham dự. Nếu bạn đặt giá trị này, hệ thống sẽ không lọc các câu trả lời. Tất cả câu trả lời khác của người tham dự thuộc các tuỳ chọn truy vấn sẽ bị bỏ qua.
ATTENDEE_RESPONSE_NEEDS_ACTION Người tham gia đã được mời nhưng chưa phản hồi.
ATTENDEE_RESPONSE_ACCEPTED Người tham gia dự định tham dự.
ATTENDEE_RESPONSE_DECLINED Người tham gia không có ý định tham dự.
ATTENDEE_RESPONSE_TENTATIVE Người tham gia muốn có thể tham dự.