- คำขอ HTTP
- พารามิเตอร์การค้นหา
- เนื้อความของคำขอ
- เนื้อหาการตอบกลับ
- ขอบเขตการให้สิทธิ์
- QuerySource
- QueryOperator
- QueryOperator.Type
- ลองใช้งาน
แสดงรายการแหล่งที่มาที่ผู้ใช้สามารถใช้สำหรับ query.search และ Recommend API ได้
หมายเหตุ: ต้องใช้บัญชีผู้ใช้ปลายทางมาตรฐานจึงจะใช้งาน API นี้ได้ บัญชีบริการจะส่งคำขอ API การค้นหาโดยตรงไม่ได้ หากต้องการใช้บัญชีบริการเพื่อดำเนินการค้นหา ให้ตั้งค่าการมอบสิทธิ์ทั่วทั้งโดเมนของ Google Workspace
คำขอ HTTP
GET https://cloudsearch.googleapis.com/v1/query/sources
URL ใช้ไวยากรณ์การแปลง gRPC
พารามิเตอร์การค้นหา
พารามิเตอร์ | |
---|---|
requestOptions |
ตัวเลือกคำขอ เช่น แอปพลิเคชันการค้นหาและเขตเวลาของผู้ใช้ |
pageToken |
จำนวนแหล่งที่มาที่จะแสดงผลในคำตอบ |
เนื้อหาของคำขอ
เนื้อหาของคำขอต้องว่างเปล่า
เนื้อหาการตอบกลับ
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
ตอบกลับรายการแหล่งที่มา
การแสดง JSON |
---|
{
"sources": [
{
object ( |
ช่อง | |
---|---|
sources[] |
|
nextPageToken |
|
ขอบเขตการให้สิทธิ์
ต้องมีขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้
https://www.googleapis.com/auth/cloud_search.query
https://www.googleapis.com/auth/cloud_search
โปรดดูข้อมูลเพิ่มเติมที่คู่มือการให้สิทธิ์
QuerySource
รายการแหล่งที่มาที่ผู้ใช้ค้นหาได้โดยใช้ API การค้นหา
การแสดง JSON |
---|
{ "source": { object ( |
ช่อง | |
---|---|
source |
ชื่อของแหล่งที่มา |
shortName |
ชื่อย่อหรือชื่อแทนของแหล่งที่มา คุณสามารถใช้ค่านี้กับโอเปอเรเตอร์ "source" |
displayName |
ชื่อที่แสดงของแหล่งข้อมูล |
operators[] |
รายการโอเปอเรเตอร์ทั้งหมดที่เกี่ยวข้องกับแหล่งที่มานี้ |
QueryOperator
คำจำกัดความของโอเปอเรเตอร์ที่สามารถใช้ในคำขอ query.search/query.suggest
การแสดง JSON |
---|
{
"operatorName": string,
"lessThanOperatorName": string,
"greaterThanOperatorName": string,
"type": enum ( |
ช่อง | |
---|---|
operatorName |
ชื่อของโอเปอเรเตอร์ |
lessThanOperatorName |
ระบุชื่อโอเปอเรเตอร์ที่สามารถใช้เพื่อแยกพร็อพเพอร์ตี้โดยใช้โอเปอเรเตอร์ที่น้อยกว่า |
greaterThanOperatorName |
ระบุชื่อโอเปอเรเตอร์ที่สามารถใช้เพื่อแยกพร็อพเพอร์ตี้โดยใช้โอเปอเรเตอร์ "มากกว่า" |
type |
ประเภทของโอเปอเรเตอร์ |
displayName |
ชื่อที่แสดงของโอเปอเรเตอร์ |
isSortable |
โอเปอเรเตอร์นี้ใช้เพื่อจัดเรียงผลการค้นหาได้ไหม |
isFacetable |
โอเปอเรเตอร์นี้ใช้เพื่อรับข้อมูลประกอบได้ไหม |
isReturnable |
พร็อพเพอร์ตี้ที่เชื่อมโยงกับข้อมูลประกอบนี้จะปรากฏเป็นส่วนหนึ่งของผลการค้นหาหรือไม่ |
isRepeatable |
ระบุว่ากำหนดค่าพร็อพเพอร์ตี้นี้ได้หลายค่าหรือไม่ |
isSuggestable |
รับคำแนะนำของช่องนี้ได้ |
enumValues[] |
รายการค่าที่เป็นไปได้สำหรับฟิลด์ Opeatror ระบบจะกรอกช่องนี้เฉพาะเมื่อเราสามารถแจกแจงค่าที่เป็นไปได้ทั้งหมดของโอเปอเรเตอร์นี้ได้อย่างปลอดภัยเท่านั้น |
objectType |
ชื่อของออบเจ็กต์ที่ตรงกับโอเปอเรเตอร์ ช่องนี้จะมีการเติมข้อมูลไว้สำหรับโอเปอเรเตอร์เฉพาะสคีมาเท่านั้น และจะไม่ตั้งค่าสำหรับโอเปอเรเตอร์ทั่วไป |
QueryOperator.Type
ประเภทของพร็อพเพอร์ตี้ที่โอเปอเรเตอร์อ้างอิง
Enum | |
---|---|
UNKNOWN |
ค่าไม่ถูกต้อง |
INTEGER |
|
DOUBLE |
|
TIMESTAMP |
|
BOOLEAN |
|
ENUM |
|
DATE |
|
TEXT |
|
HTML |