- בקשת HTTP
- פרמטרים של שאילתה
- גוף הבקשה
- גוף התשובה
- היקפי ההרשאות
- QuerySource
- QueryOperator
- QueryOperator.Type
- רוצים לנסות?
מחזירה רשימה של מקורות שבהם המשתמש יכול להשתמש עבור ממשקי ה-API של query.search ו-Google Suggest.
הערה: כדי להפעיל את ה-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 |
שם קצר או כינוי למקור. ניתן להשתמש בערך הזה עם האופרטור 'מקור'. |
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[] |
רשימת ערכים אפשריים לשדה האופר. שדה זה מתמלא רק כאשר ניתן לספור בבטחה את כל הערכים האפשריים של האופרטור הזה. |
objectType |
שם האובייקט שתואם לאופרטור. השדה הזה מכיל רק אופרטורים ספציפיים לסכימה, והוא לא מוגדר לאופרטורים נפוצים. |
QueryOperator.Type
סוג המאפיין שהאופרטור מפנה אליו.
טיפוסים בני מנייה (enums) | |
---|---|
UNKNOWN |
ערך לא חוקי. |
INTEGER |
|
DOUBLE |
|
TIMESTAMP |
|
BOOLEAN |
|
ENUM |
|
DATE |
|
TEXT |
|
HTML |