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

enum (CorpusType)

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

enum (DataScope)

Nguồn dữ liệu để 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 dành riêng cho từng 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 đến 00:00 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 của cụm từ tìm kiếm. Chỉ định theo giờ GMT. Giá trị được làm tròn đến 00:00 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 TZ của IANA, chẳng hạn như "America/Los_Angeles". Để xem danh sách tên múi giờ, hãy xem 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ó thể là một trong những 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à SITES_URL.
driveDocumentInfo

object (DriveDocumentInfo)

Bắt buộc khi SearchMethod là DRIVE_DOCUMENT.
Trường nhóm corpus_options_field. Các lựa chọn tìm kiếm bổ sung cho một số dịch vụ cụ thể. corpus_options_field chỉ có thể là một trong những trạng thái sau:
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 cuộc trò chuyện. (chỉ đọc)
voiceOptions

object (VoiceOptions)

Đặt các lựa 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 cụ thể 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 hoạt động tìm kiếm trên Gemini.

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 đang tạm ngưng.
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 cụm từ 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 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 không gian Chat được chỉ định trong HangoutsChatInfo.
SITES_URL Tìm kiếm trang web theo URL đã xuất bản của trang web đượ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.
DRIVE_DOCUMENT Truy xuất các tài liệu được chỉ định trong DriveDocumentInfo.

AccountInfo

Các tài khoản cần tì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

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 API Directory 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
  ]
}
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ã nhận dạng của phòng Chat, do API Chat cung cấp. Mỗi yêu cầu chỉ được xuất dữ liệu từ tối đa 500 không gian trò chuyện.

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

DriveDocumentInfo

Các tài liệu trên Drive mà bạn muốn tìm kiếm.

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

  "documentIds": {
    object (DriveDocumentIds)
  }
}
Trường
Trường nhóm identifier. Định dạng để truy xuất tài liệu trên Drive. identifier chỉ có thể là một trong những trạng thái sau:
documentIds

object (DriveDocumentIds)

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

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

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 lựa chọn bổ sung cho tính năng 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. Theo mặc định, cả hai đều được đưa vào.

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 được mã hoá phía máy khách và nội dung không được mã hoá.
CLIENT_SIDE_ENCRYPTED_OPTION_ANY Bao gồm cả nội dung được 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 để 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 mới nhất được lưu trước 12:00 giờ trưa (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 Drive nhóm.
includeSharedDrives
(deprecated)

boolean

Đặt thành true để bao gồm 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 nội dung Mã hoá phía máy khách của Google Workspace, chỉ 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.
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 Bạn chưa chỉ định lựa chọn nào về bộ nhớ dùng chung.
NOT_INCLUDED Nếu tài nguyên nằm trong một bộ nhớ dùng chung thì sẽ không được đưa vào 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 những 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. Chế độ 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à "includeSharedDrives" ở trạng thái tắt)
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")

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 để thêm 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)

Các kiểu dữ liệu để tìm kiếm

CalendarOptions

Các lựa chọn khác cho tính năng tìm kiếm trong 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 bộ từ đã cho. Nếu chuỗi chứa các cụm từ trong dấu ngoặc kép, phương thức này chỉ so khớp những sự kiện có vị trí chứa cụm từ chính xác. Các mục trong tập hợp được xem xét trong "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ỉ khớp với những sự kiện có người tham dự chứa tất cả các từ trong bộ từ đã cho. Các mục trong tập hợp được xem xét trong "và".
minusWords[]

string

Chỉ khớp với những sự kiện không chứa bất kỳ từ nào trong tập hợp đã 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 coi là "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 những câu trả lời này. Nếu tập hợp này trống hoặc chứa ATTENDEE_RESPONSE_UNSPECIFIED, thì sẽ không có hoạt động lọc nào đối với 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 12:00 giờ đêm (giờ UTC) vào ngày được 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 Phản hồi của người tham dự chưa được chỉ định. Nếu bạn đặt giá trị này, hệ thống sẽ không lọc các phản hồi và bỏ qua tất cả các phản hồi khác của người tham dự thuộc 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 có ý đị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 trên Gemini