Method: query.suggest

แสดงคําแนะนําสําหรับการเติมข้อความค้นหาอัตโนมัติ

หมายเหตุ: API นี้ต้องใช้บัญชีผู้ใช้ปลายทางมาตรฐานเพื่อดำเนินการ บัญชีบริการไม่สามารถส่งคําขอไปยัง Query API ได้โดยตรง หากต้องการใช้บัญชีบริการเพื่อทำการค้นหา ให้ตั้งค่าการมอบสิทธิ์ทั้งโดเมนของ Google Workspace

คำขอ HTTP

POST https://cloudsearch.googleapis.com/v1/query/suggest

URL ใช้ไวยากรณ์การแปลง gRPC

เนื้อหาของคำขอ

เนื้อความของคำขอมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง JSON 
{
  "requestOptions": {
    object (RequestOptions)
  },
  "query": string,
  "dataSourceRestrictions": [
    {
      object (DataSourceRestriction)
    }
  ]
}
ช่อง
requestOptions

object (RequestOptions)

ตัวเลือกคำขอ เช่น แอปพลิเคชันการค้นหาและเขตเวลาของผู้ใช้
query

string

ข้อความค้นหาบางส่วนที่ระบบจะแสดงคําแนะนําที่เติมข้อความอัตโนมัติ เช่น หากข้อความค้นหาคือ "sea" เซิร์ฟเวอร์อาจแสดงผลลัพธ์เป็น "season", "search", "seagull" และอื่นๆ
dataSourceRestrictions[]

object (DataSourceRestriction)

แหล่งที่มาที่จะใช้สำหรับคำแนะนำ หากไม่ได้ระบุ ระบบจะนำแหล่งข้อมูลจากแอปพลิเคชันการค้นหาปัจจุบัน

หมายเหตุ: ระบบรองรับคําแนะนําสําหรับแหล่งที่มาต่อไปนี้เท่านั้น

  • แหล่งข้อมูลของบุคคลที่สาม
  • PredefinedSource.PERSON
  • PredefinedSource.GOOGLE_DRIVE

เนื้อหาการตอบกลับ

การตอบกลับของ API แนะนำ

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง JSON 
{
  "suggestResults": [
    {
      object (SuggestResult)
    }
  ]
}
ช่อง
suggestResults[]

object (SuggestResult)

รายการคำแนะนำ

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/cloud_search.query
  • https://www.googleapis.com/auth/cloud_search

ดูข้อมูลเพิ่มเติมได้ที่คู่มือการให้สิทธิ์

SuggestResult

ผลการค้นหาคำแนะนำ 1 รายการ

การแสดง JSON 
{
  "suggestedQuery": string,
  "source": {
    object (Source)
  },

  // Union field suggestion can be only one of the following:
  "querySuggestion": {
    object (QuerySuggestion)
  },
  "peopleSuggestion": {
    object (PeopleSuggestion)
  }
  // End of list of possible types for union field suggestion.
}
ช่อง
suggestedQuery

string

คําค้นหาที่แนะนําซึ่งจะใช้สําหรับการค้นหาเมื่อผู้ใช้คลิกคําแนะนํา
source

object (Source)

แหล่งที่มาของคำแนะนำ
ฟิลด์สหภาพ suggestion มีข้อมูลเมตาเพิ่มเติมเกี่ยวกับการค้นหาที่แนะนำ และยังระบุประเภทของคำค้นหาที่แนะนำด้วย เช่น หากมี PeopleSuggestion แสดงว่า suggested_query คือคําแนะนําบุคคล suggestion ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
querySuggestion

object (QuerySuggestion)

ช่องนี้จะปรากฏขึ้นหากคำค้นหาที่แนะนำเป็นการเติมคำ/วลี
peopleSuggestion

object (PeopleSuggestion)

ตัวเลือกนี้จะปรากฏเมื่อการแนะนำระบุบุคคล อีเมลดังกล่าวมีข้อมูลเพิ่มเติมเกี่ยวกับบุคคลนั้น เช่น รหัสอีเมล ชื่อ ฯลฯ

QuerySuggestion

ประเภทนี้ไม่มีช่อง

ช่องนี้ไม่มีข้อมูลใดๆ ในตอนนี้ และใช้เป็นตัวบ่งชี้ว่าผลการค้นหาที่แนะนำเป็นการเติมข้อความ

PeopleSuggestion

ฟิลด์นี้มีข้อมูลเกี่ยวกับบุคคลที่แนะนำ

การแสดง JSON 
{
  "person": {
    object (Person)
  }
}
ช่อง
person

object (Person)

บุคคลที่แนะนำ ระบบอาจไม่ป้อนข้อมูลในฟิลด์ทั้งหมดของออบเจ็กต์บุคคล