Method: query.sources.list

แสดงรายการแหล่งที่มาที่ผู้ใช้สามารถใช้สำหรับ query.search และ Recommendation API ได้

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

คำขอ HTTP

GET https://cloudsearch.googleapis.com/v1/query/sources

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

พารามิเตอร์การค้นหา

พารามิเตอร์
requestOptions

object (RequestOptions)

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

string

จำนวนแหล่งที่มาที่จะแสดงผลในคำตอบ

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

เนื้อหาของคำขอต้องว่างเปล่า

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

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

การตอบกลับของรายการแหล่งที่มา

การแสดง JSON 
{
  "sources": [
    {
      object (QuerySource)
    }
  ],
  "nextPageToken": string
}
ช่อง
sources[]

object (QuerySource)
nextPageToken

string

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

ต้องใช้ขอบเขต OAuth รายการใดรายการหนึ่งต่อไปนี้

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

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

QuerySource

รายการแหล่งที่มาที่ผู้ใช้ค้นหาได้โดยใช้ API การค้นหา

การแสดง JSON 
{
  "source": {
    object (Source)
  },
  "shortName": string,
  "displayName": string,
  "operators": [
    {
      object (QueryOperator)
    }
  ]
}
ช่อง
source

object (Source)

ชื่อแหล่งที่มา
shortName

string

ชื่อย่อหรือชื่อแทนของแหล่งที่มา คุณใช้ค่านี้กับ "แหล่งที่มา" ได้

displayName

string

ชื่อที่แสดงของแหล่งข้อมูล
operators[]

object (QueryOperator)

รายการของโอเปอเรเตอร์ทั้งหมดที่ใช้กับแหล่งที่มานี้

QueryOperator

คำจำกัดความของโอเปอเรเตอร์ที่สามารถใช้ในคำขอ query.search/query.suggest

การแสดง JSON 
{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string,
  "type": enum (QueryOperator.Type),
  "displayName": string,
  "isSortable": boolean,
  "isFacetable": boolean,
  "isReturnable": boolean,
  "isRepeatable": boolean,
  "isSuggestable": boolean,
  "enumValues": [
    string
  ],
  "objectType": string
}
ช่อง
operatorName

string

ชื่อของโอเปอเรเตอร์
lessThanOperatorName

string

ระบุชื่อโอเปอเรเตอร์ที่สามารถใช้แยกพร็อพเพอร์ตี้โดยใช้โอเปอเรเตอร์น้อยกว่า
greaterThanOperatorName

string

ระบุชื่อโอเปอเรเตอร์ที่สามารถใช้แยกพร็อพเพอร์ตี้โดยใช้โอเปอเรเตอร์ "มากกว่า"
type

enum (QueryOperator.Type)

ประเภทของโอเปอเรเตอร์
displayName

string

ชื่อที่แสดงของโอเปอเรเตอร์
isSortable

boolean

สามารถใช้ตัวดำเนินการนี้เพื่อจัดเรียงผลการค้นหาได้หรือไม่
isFacetable

boolean

โอเปอเรเตอร์นี้สามารถใช้รับข้อมูลประกอบได้ไหม
isReturnable

boolean

คุณสมบัติที่เชื่อมโยงกับข้อมูลประกอบนี้จะปรากฏในผลการค้นหาหรือไม่
isRepeatable

boolean

ระบุว่าพร็อพเพอร์ตี้นี้ตั้งค่าได้หลายค่าหรือไม่
isSuggestable

boolean

รับคำแนะนำสำหรับช่องนี้ได้
enumValues[]

string

รายการค่าที่เป็นไปได้สำหรับช่อง Opeatror ระบบจะกรอกข้อมูลในฟิลด์นี้ต่อเมื่อเราสามารถแจกแจงค่าที่เป็นไปได้ทั้งหมดของโอเปอเรเตอร์นี้ได้อย่างปลอดภัยเท่านั้น
objectType

string

ชื่อออบเจ็กต์ที่สัมพันธ์กับโอเปอเรเตอร์ ช่องนี้จะกรอกสําหรับโอเปอเรเตอร์ที่เจาะจงสคีมาเท่านั้น และจะไม่ตั้งค่าสําหรับโอเปอเรเตอร์ทั่วไป

QueryOperator.Type

ประเภทของที่พักที่โอเปอเรเตอร์อ้างอิง

Enum
UNKNOWN ค่าไม่ถูกต้อง
INTEGER
DOUBLE
TIMESTAMP
BOOLEAN
ENUM
DATE
TEXT
HTML