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)

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