Method: query.suggest

ให้คำแนะนำในการเติมข้อความค้นหาอัตโนมัติ

หมายเหตุ: API นี้ต้องใช้บัญชีผู้ใช้ปลายทางมาตรฐานเพื่อเรียกใช้ บัญชีบริการจะส่งคำขอ 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

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

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

การตอบสนองของ Recommend 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)

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