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)

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

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

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

لمزيد من المعلومات، يُرجى الاطِّلاع على نظرة عامة على OAuth 2.0.

اقتراح نتيجة

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

تمثيل 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)

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

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

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

اقتراح أشخاص

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

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

object (Person)

الشخص المُقترَح. لا يمكن ملء جميع حقول كائن الشخص.