Method: query.suggest

تقدّم اقتراحات للإكمال التلقائي لطلب البحث.

ملاحظة: تتطلّب واجهة برمجة التطبيقات هذه حساب مستخدم نهائي عادي لتنفيذها. لا يمكن لحساب الخدمة تنفيذ طلبات واجهة برمجة التطبيقات لطلبات البحث مباشرةً. لاستخدام حساب خدمة لإجراء طلبات بحث، عليك إعداد تفويض السلطة على مستوى نطاق Google Workspace.

طلب HTTP

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

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

نص الطلب

يحتوي نص الطلب على بيانات بالبنية التالية:

تمثيل JSON 
{
  "requestOptions": {
    object (RequestOptions)
  },
  "query": string,
  "dataSourceRestrictions": [
    {
      object (DataSourceRestriction)
    }
  ]
}
الحقول
requestOptions

object (RequestOptions)

خيارات الطلب، مثل تطبيق البحث والمنطقة الزمنية للمستخدم
query

string

طلب بحث جزئي سيتم عرض اقتراحات الإكمال التلقائي له. على سبيل المثال، إذا كان طلب البحث هو "البحر"، قد يعرض الخادم "الموسم" و"البحث" و"طيور النورس" وما إلى ذلك.
dataSourceRestrictions[]

object (DataSourceRestriction)

المصادر التي سيتم استخدامها لاقتراحات. في حال عدم تحديدها، يتم الحصول على مصادر البيانات من طلب البحث الحالي.

ملاحظة: لا تتوفّر الاقتراحات إلا للمصادر التالية:

  • مصادر البيانات التابعة لجهات خارجية
  • PredefinedSource.PERSON
  • PredefinedSource.GOOGLE_DRIVE

نص الاستجابة

استجابة واجهة برمجة التطبيقات المقترَحة

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON 
{
  "suggestResults": [
    {
      object (SuggestResult)
    }
  ]
}
الحقول
suggestResults[]

object (SuggestResult)

قائمة بالاقتراحات

نطاقات التفويض

يتطلب أحد نطاقات OAuth التالية:

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

لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.

SuggestResult

نتيجة اقتراح واحدة

تمثيل JSON 
{
  "suggestedQuery": string,
  "source": {
    object (Source)
  },

  // Union field suggestion can be only one of the following:
  "querySuggestion": {
    object (QuerySuggestion)
  },
  "peopleSuggestion": {
    object (PeopleSuggestion)
  }
  // End of list of possible types for union field suggestion.
}
الحقول
suggestedQuery

string

طلب البحث المقترَح الذي سيتم استخدامه للبحث عندما ينقر المستخدم على الاقتراح
source

object (Source)

مصدر الاقتراح
حقل الربط suggestion يحتوي على بيانات وصفية إضافية عن طلب البحث المقترَح. ويشير أيضًا إلى نوع طلب البحث المقترَح. على سبيل المثال، إذا كان PeopleSuggestion متوفّرًا، يعني ذلك أنّ suggested_query هو اقتراح لمستخدم. يمكن أن يكون suggestion واحدًا فقط مما يلي:
querySuggestion

object (QuerySuggestion)

سيظهر هذا الحقل إذا كان الطلب المقترَح عبارة عن كلمة أو عبارة مكتملة.
peopleSuggestion

object (PeopleSuggestion)

يظهر هذا الرمز عندما يشير الاقتراح إلى مستخدم. يحتوي على مزيد من المعلومات عن المستخدم، مثل رقم تعريف بريده الإلكتروني واسمه وما إلى ذلك.

QuerySuggestion

لا يحتوي هذا النوع على أي حقول.

لا يحتوي هذا الحقل على أيّ شيء حتى الآن، ويتم استخدامه فقط كمؤشر على أنّ النتيجة المقترَحة كانت عبارة عن إكمال عبارة.

PeopleSuggestion

يحتوي هذا الحقل على معلومات عن المستخدم المقترَح.

تمثيل JSON 
{
  "person": {
    object (Person)
  }
}
الحقول
person

object (Person)

شخص مقترَح قد لا يتم تعبئة جميع حقول عنصر الشخص.