Method: query.sources.list

מחזירה רשימת מקורות שבהם המשתמש יכול להשתמש עבור ממשקי API של query.search ו-suggest API.

הערה: כדי להפעיל את ה-API הזה צריך חשבון משתמש קצה סטנדרטי. חשבון שירות לא יכול לשלוח בקשות ל-Query 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

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

רשימה של ערכים אפשריים לשדה המפעיל. צריך למלא את השדה הזה רק אם אנחנו יכולים לספור בבטחה את כל הערכים האפשריים של האופרטור הזה.
objectType

string

שם האובייקט שתואם לאופרטור. השדה הזה מלא רק לאופרטורים ספציפיים לסכימה, ולא מוגדר עבור אופרטורים נפוצים.

QueryOperator.Type

סוג הנכס שהמפעיל מפנה אליו.

טיפוסים בני מנייה (enum)
UNKNOWN ערך לא חוקי.
INTEGER
DOUBLE
TIMESTAMP
BOOLEAN
ENUM
DATE
TEXT
HTML