Query

Định nghĩa truy vấn được sử 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.
}
Các trường
corpus

enum (CorpusType)

Dịch vụ tìm kiếm của Google Workspace.
dataScope

enum (DataScope)

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

enum (SearchMethod)

Phương thức tìm kiếm 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 sẽ là SHARED_DRIVE.
terms

string

Toán tử tìm kiếm dành riêng cho dịch vụ để lọc kết quả tìm kiếm.
startTime

string (Timestamp format)

Thời gian bắt đầu cho cụm từ tìm kiếm. 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 cụm từ tìm kiếm. 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".
teamDriveInfo
(deprecated)

object (TeamDriveInfo)

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

string

Tên múi giờ. Đó phải là tên TZ IANA, 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 nhóm search_method_field. Khi cần, thông tin chi tiết về các thực thể cần tìm kiếm search_method_field chỉ được là một trong những thông tin sau đây:
accountInfo

object (AccountInfo)

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

object (OrgUnitInfo)

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

object (SharedDriveInfo)

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

object (HangoutsChatInfo)

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

object (SitesUrlInfo)

Bắt buộc khi SearchMethod là SearchMethod.
Trường nhóm corpus_options_field. Các tuỳ 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 tuỳ chọn dành riêng cho tìm kiếm trong Gmail.
driveOptions

object (DriveOptions)

Đặt các tuỳ chọn dành riêng cho tìm kiếm trong Drive.
hangoutsChatOptions

object (HangoutsChatOptions)

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

object (VoiceOptions)

Đặt các tuỳ chọn dành riêng cho 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 cần tìm kiếm.

Enum
DATA_SCOPE_UNSPECIFIED Chưa chỉ định nguồn dữ liệu nào.
ALL_DATA Tất cả dữ liệu có sẵn.
HELD_DATA Chỉ dữ liệu đang chờ xử lý.
UNPROCESSED_DATA Chỉ những dữ liệu chưa được Vault xử lý. (Chỉ dành cho 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 một phương thức tìm kiếm, nếu không phương thức đó sẽ bị từ chối.
ACCOUNT Tì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 kiế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 được 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 của trang web đã xuất bản được chỉ định trong SitesUrlInfo.
SHARED_DRIVE Tìm tệp trong bộ nhớ dùng chung được chỉ định trong SharedDriveInfo.

AccountInfo

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

Biểu diễn dưới dạng JSON 
{
  "emails": [
    string
  ]
}
Các 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
}
Các trường
orgUnitId

string

Tên của đơn vị tổ chức cần tìm kiếm, do API Thư mục của SDK dành cho quản trị viên cung cấp.

SharedDriveInfo

Bộ nhớ dùng chung cần tìm kiếm

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

string

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

HangoutsChatInfo

Các phòng Chat để tìm kiếm

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

string

Danh sách mã phòng Chat do API Chat cung cấp. Mỗi yêu cầu chỉ được xuất tối đa 500 phòng Chat.

SitesUrlInfo

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

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

string

Danh sách URL của 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
  ]
}
Các trường
teamDriveIds[]
(deprecated)

string

Danh sách mã Drive nhóm, do API Drive cung cấp.

MailOptions

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)
}
Các trường
excludeDrafts

boolean

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

enum (ClientSideEncryptedOption)

Chỉ định xem kết quả sẽ 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á 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 không được mã hoá.
CLIENT_SIDE_ENCRYPTED_OPTION_ANY Đưa cả nội dung đã mã hoá và chưa mã hoá phía máy khách vào 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ỉ đưa vào nội dung chưa mã hoá.

DriveOptions

Các tuỳ chọn bổ sung 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)
}
Các 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 đã chỉ định. Nhập ngày theo giờ UTC.

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".
includeTeamDrives
(deprecated)

boolean

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

boolean

Đặt thành true (đúng) để 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á hoặc cả hai. Giá trị mặc định là cả hai. Hiện được hỗ trợ cho Drive.

HangoutsChatOptions

Các tuỳ chọn bổ sung cho tính năng tìm kiếm trong Google Chat

Biểu diễn dưới dạng JSON 
{
  "includeRooms": boolean
}
Các 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 các phòng.

VoiceOptions

Các tuỳ chọn bổ sung 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)
  ]
}
Các trường
coveredData[]

enum (VoiceCoveredData)

Loại dữ liệu cần tìm kiếm

CalendarOptions

Các tuỳ chọn bổ sung để 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
}
Các 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 nhóm đã cho. Nếu chuỗi chứa cụm từ trong dấu ngoặc kép, phương thức này chỉ so khớp các sự kiện có vị trí chứa cụm từ chính xác. Các mục nhập trong tập hợp được coi là nằm trong phần "và".

Ví dụ về cách phân tách từ: ["New Zealand"] so với ["New","Zealand"] "New Zealand": khớp bởi cả "New Zealand và tốt hơn": chỉ khớp bởi "New Zealand"
peopleQuery[]

string

Chỉ so 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 nhập trong tập hợp được coi là nằm trong phần "và".
minusWords[]

string

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

enum (AttendeeResponse)

Chỉ khớp với những sự kiện mà người giám hộ đưa ra một trong các câu trả lời sau. Nếu tập hợp này trống hoặc chứa ATTENDEE_PERCENTAGE_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 mới nhất được lưu trước 0:00 (giờ UTC) vào ngày đã chỉ định. Nhập ngày theo giờ UTC.

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".

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 chính sách này, thì tất cả phản hồi của người tham dự khác thuộc các tùy 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 dự định tham dự.
ATTENDEE_RESPONSE_TENTATIVE Người tham gia mong muốn có thể tham dự.