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 موجودًا، فإنه يشير إلى أن Suggestion_query هو اقتراح شخص. يمكن أن يكون suggestion واحدًا فقط مما يلي:
querySuggestion

object (QuerySuggestion)

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

object (PeopleSuggestion)

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

QuerySuggestion

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

PeopleSuggestion

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

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

object (Person)

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