- คำขอ HTTP
- เนื้อความของคำขอ
- เนื้อหาการตอบกลับ
- ขอบเขตการให้สิทธิ์
- SuggestResult
- QuerySuggestion
- PeopleSuggestion
- ลองใช้งาน
ให้คำแนะนำสำหรับการเติมข้อความค้นหาอัตโนมัติ
หมายเหตุ: ต้องใช้บัญชีผู้ใช้ปลายทางมาตรฐานจึงจะใช้งาน API นี้ได้ บัญชีบริการจะส่งคำขอ API การค้นหาโดยตรงไม่ได้ หากต้องการใช้บัญชีบริการเพื่อดำเนินการค้นหา ให้ตั้งค่าการมอบสิทธิ์ทั่วทั้งโดเมนของ Google Workspace
คำขอ HTTP
POST https://cloudsearch.googleapis.com/v1/query/suggest
URL ใช้ไวยากรณ์การแปลง gRPC
เนื้อหาของคำขอ
เนื้อหาของคำขอมีข้อมูลที่มีโครงสร้างต่อไปนี้
การแสดง JSON |
---|
{ "requestOptions": { object ( |
ช่อง | |
---|---|
requestOptions |
ตัวเลือกคำขอ เช่น แอปพลิเคชันการค้นหาและเขตเวลาของผู้ใช้ |
query |
ข้อความค้นหาบางส่วนที่คำแนะนำในการเติมข้อความอัตโนมัติจะแสดงขึ้น ตัวอย่างเช่น ถ้าข้อความค้นหาคือ "sea" เซิร์ฟเวอร์อาจแสดง "ซีซัน", "search", "seagull" เป็นต้น |
dataSourceRestrictions[] |
แหล่งที่มาที่จะใช้สำหรับคำแนะนำ หากไม่ได้ระบุไว้ ระบบจะนำแหล่งข้อมูลมาจากแอปพลิเคชันการค้นหาปัจจุบัน หมายเหตุ: ระบบรองรับคำแนะนำในแหล่งที่มาต่อไปนี้เท่านั้น
|
เนื้อหาการตอบกลับ
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
การตอบสนองของ API การแนะนำ
การแสดง JSON |
---|
{
"suggestResults": [
{
object ( |
ช่อง | |
---|---|
suggestResults[] |
รายการคำแนะนำ |
ขอบเขตการให้สิทธิ์
ต้องมีขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้
https://www.googleapis.com/auth/cloud_search.query
https://www.googleapis.com/auth/cloud_search
โปรดดูข้อมูลเพิ่มเติมที่คู่มือการให้สิทธิ์
SuggestResult
ผลลัพธ์คำแนะนำ 1 รายการ
การแสดง JSON |
---|
{ "suggestedQuery": string, "source": { object ( |
ช่อง | |
---|---|
suggestedQuery |
ข้อความค้นหาที่แนะนำที่จะใช้สำหรับการค้นหา เมื่อผู้ใช้คลิกที่คำแนะนำ |
source |
แหล่งที่มาของคำแนะนำ |
ฟิลด์การรวม suggestion มีข้อมูลเมตาเพิ่มเติมเกี่ยวกับคำค้นหาที่แนะนำ และยังระบุประเภทของคำค้นหาที่แนะนำด้วย เช่น ถ้า PeopleSuggestion แสดงอยู่ จะบ่งบอกว่า suggested_query คือการแนะนำบุคคล suggestion ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
querySuggestion |
ช่องนี้จะปรากฏหากคำค้นหาที่แนะนำเป็นการเติมคำ/วลี |
peopleSuggestion |
ตัวเลือกนี้จะแสดงขึ้นเมื่อคำแนะนำนั้นระบุถึงบุคคล ไฟล์นี้มีข้อมูลเพิ่มเติมเกี่ยวกับบุคคลนั้น เช่น รหัสอีเมล ชื่อ ฯลฯ |
QuerySuggestion
ขณะนี้ ฟิลด์นี้ไม่มีองค์ประกอบใดๆ และใช้เป็นตัวบ่งชี้ว่าผลลัพธ์ที่แนะนำเป็นวลีที่สมบูรณ์
PeopleSuggestion
ช่องนี้มีข้อมูลเกี่ยวกับบุคคลที่ได้รับการแนะนำ
การแสดง JSON |
---|
{
"person": {
object ( |
ช่อง | |
---|---|
person |
คนที่แนะนำ ระบบอาจไม่ใส่ข้อมูลทุกช่องของออบเจ็กต์บุคคล |