Method: query.sources.list

عرض قائمة بالمصادر التي يمكن للمستخدم استخدامها في query.search وSuggest API

ملاحظة: تتطلّب واجهة برمجة التطبيقات هذه حساب مستخدم نهائي عادي لتنفيذها. لا يمكن لحساب الخدمة تنفيذ طلبات Query API مباشرةً. لاستخدام حساب خدمة لإجراء طلبات بحث، عليك إعداد تفويض السلطة على مستوى نطاق 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

قائمة القيم المحتملة لحقل opeatror لا يتم ملء هذا الحقل إلا عندما نتمكّن من سرد جميع القيم المحتمَلة لهذا العامل بأمان.
objectType

string

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

QueryOperator.Type

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

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