Method: query.suggest

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

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

طلب HTTP

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

يستخدم عنوان URL بنية gRPC Transcode.

نص الطلب

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

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

object (RequestOptions)

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

query

string

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

dataSourceRestrictions[]

object (DataSourceRestriction)

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

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

  • مصادر البيانات التابعة لجهات خارجية
  • المصدر المحدد مسبقًا
  • إنّه مصدر محدّد مسبقًا.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

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

نتيجة الاقتراح

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

تمثيل 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، يشير ذلك إلى أن اقتراح_الطلب هو اقتراح شخص. لا يمكن أن يكون suggestion سوى واحد مما يلي:
querySuggestion

object (QuerySuggestion)

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

peopleSuggestion

object (PeopleSuggestion)

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

اقتراح اقتراح البحث

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

اقتراح الأشخاص

يتضمن هذا الحقل معلومات حول الشخص المقترح.

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

object (Person)

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