Method: query.search

Cloud Search query API מספק את שיטת החיפוש, שמחזירה את התוצאות הרלוונטיות ביותר משאילתת משתמש. התוצאות יכולות להגיע מאפליקציות של Google Workspace, כמו Gmail או Google Drive, או מנתונים שנוספו לאינדקס מצד שלישי.

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

בקשת HTTP

POST https://cloudsearch.googleapis.com/v1/query/search

כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "requestOptions": {
    object (RequestOptions)
  },
  "query": string,
  "pageSize": integer,
  "start": integer,
  "dataSourceRestrictions": [
    {
      object (DataSourceRestriction)
    }
  ],
  "facetOptions": [
    {
      object (FacetOptions)
    }
  ],
  "sortOptions": {
    object (SortOptions)
  },
  "queryInterpretationOptions": {
    object (QueryInterpretationOptions)
  },
  "contextAttributes": [
    {
      object (ContextAttribute)
    }
  ]
}
שדות
requestOptions

object (RequestOptions)

אפשרויות בקשה, כמו אפליקציית החיפוש ואזור הזמן של המשתמש.
query

string

מחרוזת השאילתה הגולמית. מיקוד החיפוש באמצעות אופרטורים
pageSize

integer

המספר המקסימלי של תוצאות החיפוש שיוצגו בדף אחד. הערכים החוקיים הם בין 1 ל-100, כולל. ערך ברירת המחדל הוא 10. הערך המינימלי הוא 50 כשמבקשים תוצאות מעבר ל-2,000.
start

integer

אינדקס ההתחלה של התוצאות.
dataSourceRestrictions[]

object (DataSourceRestriction)

המקורות שבהם נעשה שימוש לשליחת שאילתות. אם לא מציינים את המאפיין, המערכת משתמשת בכל מקורות הנתונים מאפליקציית החיפוש הנוכחית.
facetOptions[]

object (FacetOptions)
sortOptions

object (SortOptions)

האפשרויות למיון תוצאות החיפוש
queryInterpretationOptions

object (QueryInterpretationOptions)

אפשרויות לפרש את שאילתת המשתמש.
contextAttributes[]

object (ContextAttribute)

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

גוף התשובה

אם הפעולה מצליחה, גוף התגובה מכיל מופע של SearchResponse.

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

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

מידע נוסף זמין במדריך ההרשאות.