Query

Định nghĩa truy vấn dùng để tìm kiếm và xuất dữ liệu.

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,

  "accountInfo": {
    object (AccountInfo)
  },
  "orgUnitInfo": {
    object (OrgUnitInfo)
  },
  "sharedDriveInfo": {
    object (SharedDriveInfo)
  },
  "hangoutsChatInfo": {
    object (HangoutsChatInfo)
  },
  "sitesUrlInfo": {
    object (SitesUrlInfo)
  },
  "driveDocumentInfo": {
    object (DriveDocumentInfo)
  }

  "mailOptions": {
    object (MailOptions)
  },
  "driveOptions": {
    object (DriveOptions)
  },
  "hangoutsChatOptions": {
    object (HangoutsChatOptions)
  },
  "voiceOptions": {
    object (VoiceOptions)
  },
  "calendarOptions": {
    object (CalendarOptions)
  },
  "geminiOptions": {
    object (GeminiOptions)
  },
  "geminiInWorkspaceOptions": {
    object (GeminiInWorkspaceOptions)
  }
}
Trường
corpus

enum (CorpusType)

Dịch vụ Google Workspace cần 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, thì phản hồi của trường này 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. Chỉ định theo giờ GMT. Giá trị được làm tròn thành 12 giờ sáng 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 cho cụm từ tìm kiếm. Chỉ định theo giờ GMT. Giá trị được làm tròn thành 12 giờ sáng 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".
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 múi giờ IANA, chẳng hạn như "America/Los_Angeles". Để xem 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.
Chỉ định thông tin chi tiết về các thực thể cần tìm kiếm, khi cần. Sau đây là danh sách các trường loại trừ lẫn nhau. Tối đa một trong các trường sẽ được đặt trong phản hồi:
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à SITES_URL.
driveDocumentInfo

object (DriveDocumentInfo)

Bắt buộc khi SearchMethod là DRIVE_DOCUMENT.
Kết thúc các trường loại trừ lẫn nhau.
Các lựa chọn tìm kiếm bổ sung cho các dịch vụ cụ thể. Sau đây là danh sách các trường loại trừ lẫn nhau. Tối đa một trong các trường sẽ được đặt trong phản hồi:
mailOptions

object (MailOptions)

Đặt các lựa chọn dành riêng cho tính năng tìm kiếm trong Gmail.
driveOptions

object (DriveOptions)

Đặt các lựa chọn dành riêng cho tính năng tìm kiếm trên Drive.
hangoutsChatOptions

object (HangoutsChatOptions)

Đặt các lựa chọn dành riêng cho tính năng 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 các lựa chọn dành riêng cho tính năng tìm kiếm trên Lịch.
geminiOptions

object (GeminiOptions)

Đặt các lựa chọn dành riêng cho tính năng tìm kiếm của ứng dụng Gemini.
geminiInWorkspaceOptions

object (GeminiInWorkspaceOptions)

Đặt các lựa chọn dành riêng cho tính năng tìm kiếm của Gemini trong Workspace.
Kết thúc các trường loại trừ lẫn nhau.

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.
ALL_DATA Tất cả dữ liệu hiện có.
HELD_DATA Chỉ dữ liệu được lưu giữ.
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, yêu cầu 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 kiếm dữ liệu trong Bộ nhớ dùng chung đượ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 tin nhắn trong các không gian của Chat được chỉ định trong HangoutsChatInfo.
SITES_URL Tì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.
DRIVE_DOCUMENT Truy xuất các tài liệu được chỉ định trong DriveDocumentInfo.

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, do API Thư mục SDK dành cho quản trị viên cung cấp.

SharedDriveInfo

Bộ nhớ dùng chung để 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 kiếm

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

string

Danh sách mã nhận dạng không gian trò chuyện, do API Chat cung cấp. Mỗi yêu cầu chỉ được xuất tối đa 500 không gian trò chuyện.

SitesUrlInfo

URL trang web đã xuất bản của 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 của trang web đã xuất bản.

DriveDocumentInfo

Tài liệu trên Drive cần tìm kiếm.

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

  "documentIds": {
    object (DriveDocumentIds)
  }
}
Trường
Định dạng để truy xuất tài liệu trên Drive. Sau đây là danh sách các trường loại trừ lẫn nhau. Tối đa một trong các trường sẽ được đặt trong phản hồi:
documentIds

object (DriveDocumentIds)

Chỉ định tài liệu trên Drive theo mã tài liệu.
Kết thúc các trường loại trừ lẫn nhau.

DriveDocumentIds

Chỉ định tài liệu trên Drive theo mã tài liệu.

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

string

Bắt buộc. Danh sách mã tài liệu trên Drive.

TeamDriveInfo

Bộ nhớ dùng chung cần 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 của Bộ nhớ dùng chung, do API Drive cung cấp.

MailOptions

Các lựa chọn khác để 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ó nên bao gồm nội dung đã mã hoá, nội dung chưa mã hoá hay cả hai. Theo mặc định, cả hai đều được bao gồm.

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 Trạng thái mã hoá không xác định. Kết quả bao gồm cả nội dung đã mã hoá phía máy khách và nội dung chưa mã hoá.
CLIENT_SIDE_ENCRYPTED_OPTION_ANY Bao gồm cả nội dung đã mã hoá phía máy khách và nội dung chưa mã hoá 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),
  "sharedDrivesOption": enum (SharedDrivesOption)
}
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 được lưu gần đây nhất trước 12:00 giờ đêm (giờ UTC) vào ngày đã chỉ định. Nhập ngày theo giờ UTC.

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

boolean

Đặt thành true để thêm Bộ nhớ dùng chung.
includeSharedDrives
(deprecated)

boolean

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

enum (ClientSideEncryptedOption)

Đặt 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ỉ nội dung không được mã hoá hay cả hai. Mặc định là cả hai. Hiện được hỗ trợ cho Drive.
sharedDrivesOption

enum (SharedDrivesOption)

Không bắt buộc. Các lựa chọn để bao gồm hoặc loại trừ tài liệu trong bộ nhớ dùng chung. Bạn nên sử dụng trường này thay vì includeSharedDrives. Trường này sẽ ghi đè includeSharedDrives và includeTeamDrives khi được đặt.

SharedDrivesOption

Lựa chọn về loại tài liệu trong bộ nhớ dùng chung cần đưa vào.

Enum
SHARED_DRIVES_OPTION_UNSPECIFIED Chưa chỉ định lựa chọn bộ nhớ dùng chung.
NOT_INCLUDED Nếu tài nguyên nằm trong một bộ nhớ dùng chung, thì tài nguyên đó sẽ không có trong kết quả tìm kiếm.
INCLUDED_IF_ACCOUNT_IS_NOT_A_MEMBER Tài nguyên trong bộ nhớ dùng chung chỉ được đưa vào trong trường hợp tài khoản là cộng tác viên của một tài nguyên nhưng không phải là thành viên của bộ nhớ dùng chung. Giá trị này tương ứng với lựa chọn "Chỉ được đưa vào nếu tài liệu được chia sẻ trực tiếp (không phải vì người dùng là thành viên trong bộ nhớ dùng chung)" trong giao diện người dùng của Vault. (Trước đây là tắt "includeSharedDrives")
INCLUDED Các tài nguyên trong bộ nhớ dùng chung sẽ được đưa vào kết quả tìm kiếm. (Trước đây là "includeSharedDrives" bật)

HangoutsChatOptions

Các lựa chọn khác cho tính năng tìm kiếm trong 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 cả phòng.

VoiceOptions

Các lựa 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)

Kiểu dữ liệu cần tìm kiếm

CalendarOptions

Các lựa chọn khác cho tính năng 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ỉ tìm 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ừ trong dấu ngoặc kép, thì phương thức này chỉ khớp với 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 logic "và".

Ví dụ về việc tách từ: ["New Zealand"] so với ["New","Zealand"] "New Zealand": khớp với cả hai "New and better Zealand": chỉ khớp với từ sau
peopleQuery[]

string

Chỉ tìm 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 nhóm được xem xét theo điều kiện "và".
minusWords[]

string

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

enum (AttendeeResponse)

Chỉ khớp với các 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 theo câu trả lờ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 đây nhất được lưu trước 12:00 giờ đêm (giờ UTC) vào ngày đã chỉ định. Nhập ngày theo giờ UTC.

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

AttendeeResponse

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

Enum
ATTENDEE_RESPONSE_UNSPECIFIED Chưa chỉ định phản hồi của người tham dự. Nếu bạn đặt giá trị này, thì hệ thống sẽ không lọc câu trả lời và bỏ qua tất cả câu trả lời khác của người tham dự trong các lựa chọn truy vấn.
ATTENDEE_RESPONSE_NEEDS_ACTION Người tham gia đã được mời nhưng chưa trả lờ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 dự kiến có thể tham dự.

GeminiOptions

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

Các lựa chọn khác cho tính năng tìm kiếm trong ứng dụng Gemini

GeminiInWorkspaceOptions

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

Các lựa chọn khác cho tính năng tìm kiếm của Gemini trong Workspace