Method: query.sources.list

فهرست منابعی را که کاربر می‌تواند برای جستجو و پیشنهاد API استفاده کند، برمی‌گرداند.

توجه: این API برای اجرا به یک حساب کاربری نهایی استاندارد نیاز دارد. یک حساب سرویس نمی تواند درخواست های API پرس و جو را به طور مستقیم انجام دهد. برای استفاده از حساب سرویس برای انجام پرس و جوها، تفویض اختیار در سراسر دامنه Google Workspace را تنظیم کنید.

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای پرس و جو

پارامترها
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

فهرست منابعی که کاربر می تواند با استفاده از query API جستجو کند.

نمایندگی JSON 
{
  "source": {
    object (Source)
  },
  "shortName": string,
  "displayName": string,
  "operators": [
    {
      object (QueryOperator)
    }
  ]
}
فیلدها
source

object ( Source )

نام منبع

shortName

string

نام کوتاه یا نام مستعار برای منبع. این مقدار را می توان با عملگر 'source' استفاده کرد.

displayName

string

نمایش نام منبع داده

operators[]

object ( QueryOperator )

لیست تمام اپراتورهای قابل استفاده برای این منبع.

QueryOperator

تعریف عملگری که می تواند در یک درخواست 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

نوع ملک ارجاع شده توسط اپراتور.

Enums
UNKNOWN مقدار نامعتبر است.
INTEGER
DOUBLE
TIMESTAMP
BOOLEAN
ENUM
DATE
TEXT
HTML