Query

คำจำกัดความของคำค้นหาที่ใช้สำหรับการค้นหาและการส่งออก

การแสดง 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)
  }
}
ช่อง
corpus

enum (CorpusType)

บริการ Google Workspace ที่จะค้นหา
dataScope

enum (DataScope)

แหล่งข้อมูลที่จะค้นหา
searchMethod
(deprecated)

enum (SearchMethod)

วิธีการค้นหาที่จะใช้
method

enum (SearchMethod)

เอนทิตีที่จะค้นหา ฟิลด์นี้จะแทนที่ searchMethod เพื่อรองรับไดรฟ์ที่แชร์ เมื่อ searchMethod เป็น TEAM_DRIVE การตอบกลับของฟิลด์นี้จะเป็น SHARED_DRIVE
terms

string

โอเปอเรเตอร์การค้นหาเฉพาะบริการเพื่อกรองผลการค้นหา
startTime

string (Timestamp format)

เวลาเริ่มต้นของคำค้นหา ระบุใน GMT ระบบจะปัดค่าเป็น 00:00 น. ของวันที่ที่ระบุ

ใช้ RFC 3339 โดยเอาต์พุตที่สร้างขึ้นจะได้รับการแปลงเป็นรูปแบบ Z เสมอ และใช้ตัวเลขเศษส่วน 0, 3, 6 หรือ 9 หลัก นอกจากนี้ ระบบยังยอมรับออฟเซ็ตอื่นๆ นอกเหนือจาก "Z" ด้วย เช่น "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" หรือ "2014-10-02T15:01:23+05:30"
endTime

string (Timestamp format)

เวลาสิ้นสุดของคำค้นหา ระบุใน GMT ระบบจะปัดค่าเป็น 00:00 น. ของวันที่ที่ระบุ

ใช้ RFC 3339 โดยเอาต์พุตที่สร้างขึ้นจะได้รับการแปลงเป็นรูปแบบ Z เสมอ และใช้ตัวเลขเศษส่วน 0, 3, 6 หรือ 9 หลัก นอกจากนี้ ระบบยังยอมรับออฟเซ็ตอื่นๆ นอกเหนือจาก "Z" ด้วย เช่น "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" หรือ "2014-10-02T15:01:23+05:30"
teamDriveInfo
(deprecated)

object (TeamDriveInfo)

ต้องระบุเมื่อ SearchMethod เป็น TEAM_DRIVE
timeZone

string

ชื่อเขตเวลา ควรเป็นชื่อ TZ ของ IANA เช่น "America/Los_Angeles" ดูรายชื่อชื่อเขตเวลาได้ที่เขตเวลา ดูข้อมูลเพิ่มเติมเกี่ยวกับวิธีที่ห้องนิรภัยใช้เขตเวลาได้ที่ศูนย์ช่วยเหลือของห้องนิรภัย
ฟิลด์ Union search_method_field เมื่อจำเป็น รายละเอียดของเอนทิตีที่จะค้นหา search_method_field ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
accountInfo

object (AccountInfo)

ต้องระบุเมื่อ SearchMethod เป็น ACCOUNT
orgUnitInfo

object (OrgUnitInfo)

ต้องระบุเมื่อ SearchMethod เป็น ORG_UNIT
sharedDriveInfo

object (SharedDriveInfo)

ต้องระบุเมื่อ SearchMethod เป็น SHARED_DRIVE
hangoutsChatInfo

object (HangoutsChatInfo)

ต้องระบุเมื่อ SearchMethod เป็น ROOM (อ่านอย่างเดียว)
sitesUrlInfo

object (SitesUrlInfo)

ต้องระบุเมื่อ SearchMethod เป็น SITES_URL
driveDocumentInfo

object (DriveDocumentInfo)

ต้องระบุเมื่อ SearchMethod เป็น DRIVE_DOCUMENT
ฟิลด์ Union corpus_options_field ตัวเลือกการค้นหาเพิ่มเติมสำหรับบริการที่เฉพาะเจาะจง corpus_options_field ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
mailOptions

object (MailOptions)

ตั้งค่าตัวเลือกเฉพาะการค้นหาของ Gmail
driveOptions

object (DriveOptions)

ตั้งค่าตัวเลือกเฉพาะการค้นหาในไดรฟ์
hangoutsChatOptions

object (HangoutsChatOptions)

ตั้งค่าตัวเลือกเฉพาะการค้นหาใน Chat (อ่านอย่างเดียว)
voiceOptions

object (VoiceOptions)

ตั้งค่าตัวเลือกเฉพาะสำหรับการค้นหาด้วยเสียง
calendarOptions

object (CalendarOptions)

ตั้งค่าตัวเลือกเฉพาะการค้นหาในปฏิทิน
geminiOptions

object (GeminiOptions)

ตั้งค่าตัวเลือกเฉพาะการค้นหาของ Gemini

DataScope

แหล่งข้อมูลที่จะค้นหา

Enum
DATA_SCOPE_UNSPECIFIED ไม่ได้ระบุแหล่งข้อมูล
ALL_DATA ข้อมูลทั้งหมดที่พร้อมใช้งาน
HELD_DATA เฉพาะข้อมูลที่คงไว้ชั่วคราว
UNPROCESSED_DATA เฉพาะข้อมูลที่ห้องนิรภัยยังไม่ได้ประมวลผล (Gmail และ Groups เท่านั้น)

SearchMethod

ประเภทเอนทิตีสำหรับการค้นหา

Enum
SEARCH_METHOD_UNSPECIFIED ต้องระบุวิธีการค้นหา มิฉะนั้นจะถูกปฏิเสธ
ACCOUNT ค้นหาข้อมูลของบัญชีที่ระบุใน AccountInfo
ORG_UNIT ค้นหาข้อมูลของบัญชีทั้งหมดในหน่วยขององค์กรที่ระบุใน OrgUnitInfo
TEAM_DRIVE

ค้นหาข้อมูลในไดรฟ์ของทีมที่ระบุใน teamDriveInfo
ENTIRE_ORG ค้นหาข้อมูลของบัญชีทั้งหมดในองค์กร รองรับเฉพาะ Gmail เมื่อระบุแล้ว คุณไม่จำเป็นต้องระบุ AccountInfo หรือ OrgUnitInfo
ROOM ค้นหาข้อความในพื้นที่ Chat ที่ระบุใน HangoutsChatInfo
SITES_URL ค้นหาเว็บไซต์ตาม URL ของเว็บไซต์ที่เผยแพร่ซึ่งระบุไว้ใน SitesUrlInfo
SHARED_DRIVE ค้นหาไฟล์ในไดรฟ์ที่แชร์ที่ระบุใน SharedDriveInfo
DRIVE_DOCUMENT เรียกข้อมูลเอกสารที่ระบุใน DriveDocumentInfo

AccountInfo

บัญชีที่จะค้นหา

การแสดง JSON 
{
  "emails": [
    string
  ]
}
ช่อง
emails[]

string

ชุดบัญชีที่จะค้นหา

OrgUnitInfo

หน่วยขององค์กรที่จะค้นหา

การแสดง JSON 
{
  "orgUnitId": string
}
ช่อง
orgUnitId

string

ชื่อหน่วยขององค์กรที่จะค้นหาตามที่ระบุโดย Admin SDK Directory API

SharedDriveInfo

ไดรฟ์ที่แชร์ที่จะค้นหา

การแสดง JSON 
{
  "sharedDriveIds": [
    string
  ]
}
ช่อง
sharedDriveIds[]

string

รายการรหัสไดรฟ์ที่แชร์ตามที่ Drive API ระบุ

HangoutsChatInfo

พื้นที่ใน Chat ที่จะค้นหา

การแสดง JSON 
{
  "roomId": [
    string
  ]
}
ช่อง
roomId[]

string

รายการรหัสพื้นที่ใน Chat ตามที่ Chat API ระบุ โดยจะส่งออกจากพื้นที่ทำงาน Chat ได้สูงสุด 500 รายการต่อคำขอ

SitesUrlInfo

URL ของเว็บไซต์ที่เผยแพร่ของ Google Sites ใหม่ที่จะค้นหา

การแสดง JSON 
{
  "urls": [
    string
  ]
}
ช่อง
urls[]

string

รายการ URL ของเว็บไซต์ที่เผยแพร่แล้ว

DriveDocumentInfo

เอกสารในไดรฟ์ที่จะค้นหา

การแสดง JSON 
{

  "documentIds": {
    object (DriveDocumentIds)
  }
}
ช่อง
ฟิลด์ Union identifier รูปแบบในการดึงข้อมูลเอกสารในไดรฟ์ identifier ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
documentIds

object (DriveDocumentIds)

ระบุเอกสารในไดรฟ์ตามรหัสเอกสาร

DriveDocumentIds

ระบุเอกสารในไดรฟ์ตามรหัสเอกสาร

การแสดง JSON 
{
  "ids": [
    string
  ]
}
ช่อง
ids[]

string

ต้องระบุ รายการรหัสเอกสารในไดรฟ์

TeamDriveInfo

ไดรฟ์ของทีมที่จะค้นหา

การแสดง JSON 
{
  "teamDriveIds": [
    string
  ]
}
ช่อง
teamDriveIds[]
(deprecated)

string

รายการรหัสไดรฟ์ของทีมตามที่ Drive API ระบุ

MailOptions

ตัวเลือกเพิ่มเติมสำหรับการค้นหาใน Gmail

การแสดง JSON 
{
  "excludeDrafts": boolean,
  "clientSideEncryptedOption": enum (ClientSideEncryptedOption)
}
ช่อง
excludeDrafts

boolean

ตั้งค่าเป็น true เพื่อยกเว้นข้อความร่าง
clientSideEncryptedOption

enum (ClientSideEncryptedOption)

ระบุว่าผลการค้นหาควรมีเนื้อหาที่เข้ารหัส เนื้อหาที่ไม่ได้เข้ารหัส หรือทั้ง 2 อย่าง ค่าเริ่มต้นคือรวมทั้ง 2 อย่าง

ClientSideEncryptedOption

หากองค์กรใช้การเข้ารหัสฝั่งไคลเอ็นต์ของ Google Workspace สถานะการเข้ารหัสของเนื้อหา

Enum
CLIENT_SIDE_ENCRYPTED_OPTION_UNSPECIFIED ไม่ได้ระบุสถานะการเข้ารหัส ผลการค้นหาจะมีทั้งเนื้อหาที่เข้ารหัสฝั่งไคลเอ็นต์และเนื้อหาที่ไม่ได้เข้ารหัส
CLIENT_SIDE_ENCRYPTED_OPTION_ANY รวมทั้งเนื้อหาที่เข้ารหัสฝั่งไคลเอ็นต์และไม่ได้เข้ารหัสไว้ในผลการค้นหา
CLIENT_SIDE_ENCRYPTED_OPTION_ENCRYPTED รวมเฉพาะเนื้อหาที่เข้ารหัสฝั่งไคลเอ็นต์
CLIENT_SIDE_ENCRYPTED_OPTION_UNENCRYPTED รวมเฉพาะเนื้อหาที่ไม่ได้เข้ารหัส

DriveOptions

ตัวเลือกเพิ่มเติมสำหรับการค้นหาในไดรฟ์

การแสดง JSON 
{
  "versionDate": string,
  "includeTeamDrives": boolean,
  "includeSharedDrives": boolean,
  "clientSideEncryptedOption": enum (ClientSideEncryptedOption),
  "sharedDrivesOption": enum (SharedDrivesOption)
}
ช่อง
versionDate

string (Timestamp format)

ค้นหาเวอร์ชันปัจจุบันของไฟล์ในไดรฟ์ แต่ส่งออกเนื้อหาของเวอร์ชันล่าสุดที่บันทึกไว้ก่อนเวลา 00:00 น. ตามเขตเวลา UTC ของวันที่ระบุ ป้อนวันที่ในรูปแบบ UTC

ใช้ RFC 3339 โดยเอาต์พุตที่สร้างขึ้นจะได้รับการแปลงเป็นรูปแบบ Z เสมอ และใช้ตัวเลขเศษส่วน 0, 3, 6 หรือ 9 หลัก นอกจากนี้ ระบบยังยอมรับออฟเซ็ตอื่นๆ นอกเหนือจาก "Z" ด้วย เช่น "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" หรือ "2014-10-02T15:01:23+05:30"
includeTeamDrives
(deprecated)

boolean

ตั้งค่าเป็น "จริง" เพื่อรวมไดรฟ์ของทีม
includeSharedDrives
(deprecated)

boolean

ตั้งค่าเป็น true เพื่อรวมไดรฟ์ที่แชร์
clientSideEncryptedOption

enum (ClientSideEncryptedOption)

กำหนดว่าผลการค้นหาจะมีเฉพาะเนื้อหาที่เข้ารหัสด้วยการเข้ารหัสฝั่งไคลเอ็นต์ของ Google Workspace เท่านั้น มีเฉพาะเนื้อหาที่ไม่ได้เข้ารหัส หรือมีทั้ง 2 อย่าง ค่าเริ่มต้นคือทั้ง 2 อย่าง ปัจจุบันรองรับสำหรับไดรฟ์
sharedDrivesOption

enum (SharedDrivesOption)

ไม่บังคับ ตัวเลือกในการรวมหรือยกเว้นเอกสารในไดรฟ์ที่แชร์ เราขอแนะนำให้ใช้ช่องนี้แทน includeSharedDrives ฟิลด์นี้จะลบล้าง includeSharedDrives และ includeTeamDrives เมื่อตั้งค่า

SharedDrivesOption

ตัวเลือกเกี่ยวกับประเภทเอกสารในไดรฟ์ที่แชร์ที่จะรวม

Enum
SHARED_DRIVES_OPTION_UNSPECIFIED ไม่ได้ระบุตัวเลือกไดรฟ์ที่แชร์
NOT_INCLUDED หากทรัพยากรอยู่ในไดรฟ์ที่แชร์ ระบบจะไม่รวมทรัพยากรดังกล่าวไว้ในการค้นหา
INCLUDED_IF_ACCOUNT_IS_NOT_A_MEMBER ระบบจะรวมทรัพยากรในไดรฟ์ที่แชร์ในกรณีที่บัญชีเป็นผู้ทำงานร่วมกันในทรัพยากร แต่ไม่ได้เป็นสมาชิกของไดรฟ์ที่แชร์เท่านั้น ซึ่งสอดคล้องกับตัวเลือก "รวมอยู่เฉพาะเมื่อมีการแชร์เอกสารโดยตรง (ไม่ใช่เนื่องจากการเป็นสมาชิกไดรฟ์ที่แชร์)" ใน UI ของ Vault (เดิมคือ "includeSharedDrives" ปิด)
INCLUDED ระบบจะรวมทรัพยากรในไดรฟ์ที่แชร์ไว้ในการค้นหา (เดิมคือ "includeSharedDrives" ใน)

HangoutsChatOptions

ตัวเลือกเพิ่มเติมสำหรับการค้นหาใน Google Chat

การแสดง JSON 
{
  "includeRooms": boolean
}
ช่อง
includeRooms

boolean

สำหรับการค้นหาตามบัญชีหรือหน่วยขององค์กร ให้ตั้งค่าเป็น true เพื่อรวมห้องแชท

VoiceOptions

ตัวเลือกเพิ่มเติมสำหรับการค้นหาด้วยเสียง

การแสดง JSON 
{
  "coveredData": [
    enum (VoiceCoveredData)
  ]
}
ช่อง
coveredData[]

enum (VoiceCoveredData)

ประเภทข้อมูลที่จะค้นหา

CalendarOptions

ตัวเลือกเพิ่มเติมสำหรับการค้นหาในปฏิทิน

การแสดง JSON 
{
  "locationQuery": [
    string
  ],
  "peopleQuery": [
    string
  ],
  "minusWords": [
    string
  ],
  "responseStatuses": [
    enum (AttendeeResponse)
  ],
  "versionDate": string
}
ช่อง
locationQuery[]

string

จับคู่เฉพาะกิจกรรมที่มีสถานที่ตั้งซึ่งมีคำทั้งหมดในชุดที่ระบุ หากสตริงมีวลีที่อยู่ในเครื่องหมายคำพูด เมธอดนี้จะจับคู่เฉพาะเหตุการณ์ที่มีวลีที่ตรงกันในตำแหน่ง รายการในชุดจะถือว่าอยู่ใน "และ"

ตัวอย่างการแยกคำ: ["New Zealand"] เทียบกับ ["New","Zealand"] "New Zealand": จับคู่กับทั้ง 2 รายการ "New and better Zealand": จับคู่กับรายการหลังเท่านั้น
peopleQuery[]

string

จับคู่เฉพาะกิจกรรมที่มีผู้เข้าร่วมซึ่งมีคำทั้งหมดในชุดที่ระบุ รายการในชุดจะถือว่าอยู่ใน "และ"
minusWords[]

string

จับคู่เฉพาะกิจกรรมที่ไม่มีคำใดๆ ในชุดที่ระบุในชื่อ คำอธิบาย สถานที่ หรือผู้เข้าร่วม ระบบจะพิจารณารายการในชุดเป็น "หรือ"
responseStatuses[]

enum (AttendeeResponse)

จับคู่เฉพาะเหตุการณ์ที่ผู้ดูแลให้การตอบกลับอย่างใดอย่างหนึ่งต่อไปนี้ หากชุดข้อมูลว่างเปล่าหรือมี ATTENDEE_RESPONSE_UNSPECIFIED จะไม่มีการกรองคำตอบ
versionDate

string (Timestamp format)

ค้นหาเวอร์ชันปัจจุบันของกิจกรรมในปฏิทิน แต่ส่งออกเนื้อหาของเวอร์ชันล่าสุดที่บันทึกไว้ก่อนเวลา 00:00 น. ตามเขตเวลา UTC ของวันที่ระบุ ป้อนวันที่ในรูปแบบ UTC

ใช้ RFC 3339 โดยเอาต์พุตที่สร้างขึ้นจะได้รับการแปลงเป็นรูปแบบ Z เสมอ และใช้ตัวเลขเศษส่วน 0, 3, 6 หรือ 9 หลัก นอกจากนี้ ระบบยังยอมรับออฟเซ็ตอื่นๆ นอกเหนือจาก "Z" ด้วย เช่น "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" หรือ "2014-10-02T15:01:23+05:30"

AttendeeResponse

การตอบกลับคำเชิญของผู้ใช้

Enum
ATTENDEE_RESPONSE_UNSPECIFIED ไม่ได้ระบุคำตอบของผู้เข้าร่วม หากตั้งค่านี้ ระบบจะไม่กรองคำตอบ และจะละเว้นคำตอบอื่นๆ ของผู้เข้าร่วมที่เป็นส่วนหนึ่งของตัวเลือกการค้นหา
ATTENDEE_RESPONSE_NEEDS_ACTION ผู้เข้าร่วมได้รับเชิญแล้วแต่ยังไม่ได้ตอบกลับ
ATTENDEE_RESPONSE_ACCEPTED ผู้เข้าร่วมวางแผนที่จะเข้าร่วม
ATTENDEE_RESPONSE_DECLINED ผู้เข้าร่วมไม่ได้วางแผนที่จะเข้าร่วม
ATTENDEE_RESPONSE_TENTATIVE ผู้เข้าร่วมคาดหวังว่าจะเข้าร่วมได้

GeminiOptions

ประเภทนี้ไม่มีฟิลด์

ตัวเลือกเพิ่มเติมสำหรับการค้นหาของ Gemini