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,

  // 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.
}
ช่อง
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 น. ของวันที่ที่ระบุ

การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "Zulu" ที่มีความละเอียดระดับนาโนวินาทีและทศนิยมสูงสุด 9 หลัก ตัวอย่างเช่น "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"
endTime

string (Timestamp format)

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

การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "Zulu" ที่มีความละเอียดระดับนาโนวินาทีและทศนิยมสูงสุด 9 หลัก ตัวอย่างเช่น "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"
teamDriveInfo
(deprecated)

object (TeamDriveInfo)

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

string

ชื่อเขตเวลา โดยควรเป็นชื่อ TZ ของ IANA เช่น "America/Los_Angeles" ดูรายชื่อเขตเวลาได้ที่เขตเวลา ดูข้อมูลเพิ่มเติมเกี่ยวกับวิธีที่ห้องนิรภัยใช้เขตเวลาได้ที่ศูนย์ช่วยเหลือของห้องนิรภัย
ฟิลด์สหภาพ 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
ฟิลด์สหภาพ corpus_options_field ตัวเลือกการค้นหาเพิ่มเติมสำหรับบริการที่เฉพาะเจาะจง corpus_options_field ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
mailOptions

object (MailOptions)

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

object (DriveOptions)

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

object (HangoutsChatOptions)

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

object (VoiceOptions)

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

object (CalendarOptions)

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

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

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 ของเว็บไซต์ที่เผยแพร่

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)
}
ช่อง
versionDate

string (Timestamp format)

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

การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "Zulu" ที่มีความละเอียดระดับนาโนวินาทีและทศนิยมสูงสุด 9 หลัก ตัวอย่างเช่น "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"
includeTeamDrives
(deprecated)

boolean

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

boolean

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

enum (ClientSideEncryptedOption)

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

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

การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "Zulu" ที่มีความละเอียดระดับนาโนวินาทีและทศนิยมสูงสุด 9 หลัก ตัวอย่างเช่น "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"

AttendeeResponse

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

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