Method: query.sources.list

تعرض قائمة بالمصادر التي يمكن للمستخدم استخدامها لواجهات برمجة تطبيقات query.search وsuggest.

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

طلب HTTP

GET https://cloudsearch.googleapis.com/v1/query/sources

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

معامِلات طلب البحث

المعلمات
requestOptions

object (RequestOptions)

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

string

عدد المصادر المطلوب عرضها في الردّ

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

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

إدراج ردّ المصادر

تمثيل JSON 
{
  "sources": [
    {
      object (QuerySource)
    }
  ],
  "nextPageToken": string
}
الحقول
sources[]

object (QuerySource)
nextPageToken

string

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

يتطلب هذا الإعداد أحد نطاقات OAuth التالية:

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

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

QuerySource

قائمة بالمصادر التي يمكن للمستخدم البحث فيها باستخدام واجهة برمجة تطبيقات طلبات البحث

تمثيل JSON 
{
  "source": {
    object (Source)
  },
  "shortName": string,
  "displayName": string,
  "operators": [
    {
      object (QueryOperator)
    }
  ]
}
الحقول
source

object (Source)

اسم المصدر
shortName

string

اسم مختصر أو اسم مستعار للمصدر. يمكن استخدام هذه القيمة مع السمة "source" .
displayName

string

الاسم المعروض لمصدر البيانات.
operators[]

object (QueryOperator)

قائمة بجميع عوامل التشغيل السارية على هذا المصدر

QueryOperator

يشير ذلك المصطلح إلى تعريف عامل تشغيل يمكن استخدامه في طلب query.search/query.suggest.

تمثيل JSON 
{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string,
  "type": enum (QueryOperator.Type),
  "displayName": string,
  "isSortable": boolean,
  "isFacetable": boolean,
  "isReturnable": boolean,
  "isRepeatable": boolean,
  "isSuggestable": boolean,
  "enumValues": [
    string
  ],
  "objectType": string
}
الحقول
operatorName

string

اسم عامل التشغيل.
lessThanOperatorName

string

تشير إلى اسم عامل التشغيل الذي يمكن استخدامه لعزل الخاصية باستخدام عامل تشغيل أقل من.
greaterThanOperatorName

string

تشير إلى اسم عامل التشغيل الذي يمكن استخدامه لعزل الخاصية باستخدام عامل التشغيل "أكبر من".
type

enum (QueryOperator.Type)

نوع عامل التشغيل.
displayName

string

الاسم المعروض لعامل التشغيل
isSortable

boolean

هل يمكن استخدام هذا العامل لترتيب النتائج.
isFacetable

boolean

هل يمكن استخدام هذا العامل للحصول على الواجهات.
isReturnable

boolean

هل سيتم عرض الموقع المرتبط بهذه الواجهة كجزء من نتائج البحث.
isRepeatable

boolean

يشير هذا الحقل إلى ما إذا كان يمكن ضبط قيم متعدّدة لهذه السمة.
isSuggestable

boolean

يمكن الحصول على اقتراحات لهذا الحقل.
enumValues[]

string

قائمة القيم المحتملة في حقل الأداة التجريبية. يتم ملء هذا الحقل فقط عندما يمكننا تعداد جميع القيم الممكنة لعامل التشغيل هذا بأمان.
objectType

string

اسم العنصر المتوافق مع عامل التشغيل. يتم ملء هذا الحقل لعوامل التشغيل الخاصة بالمخطط فقط، ولم يتم ضبطه للعوامل الشائعة.

QueryOperator.Type

نوع الموقع الذي أشار إليه عامل التشغيل.

عمليات التعداد
UNKNOWN القيمة غير صالحة.
INTEGER
DOUBLE
TIMESTAMP
BOOLEAN
ENUM
DATE
TEXT
HTML