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

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

string

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

QueryOperator.Type

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

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