Method: query.sources.list

הפונקציה מחזירה רשימה של מקורות שהמשתמשים יכולים להשתמש בהם ל-query.search ול-Suggest API.

הערה: כדי להפעיל את ה-API הזה, נדרש חשבון משתמש קצה רגיל. חשבון שירות לא יכול לבצע בקשות Query API ישירות. כדי להשתמש בחשבון שירות לביצוע שאילתות, צריך להגדיר הענקת גישה ברמת הדומיין ב-Google Workspace.

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של Transcoding של 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

רשימת המקורות שבהם המשתמש יכול לחפש באמצעות Query API.

ייצוג ב-JSON 
{
  "source": {
    object (Source)
  },
  "shortName": string,
  "displayName": string,
  "operators": [
    {
      object (QueryOperator)
    }
  ]
}
שדות
source

object (Source)

השם של המקור
shortName

string

שם קצר או כינוי למקור. אפשר להשתמש בערך הזה עם האופרטור 'source'.
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