Method: query.sources.list

Возвращает список источников, которые пользователь может использовать для API query.search и Offer.

Примечание. Для выполнения этого API требуется стандартная учетная запись конечного пользователя. Учетная запись службы не может напрямую выполнять запросы 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

Дополнительную информацию см. в руководстве по авторизации .

Источник запроса

Список источников, которые пользователь может искать с помощью API запросов.

JSON-представление 
{
  "source": {
    object (Source)
  },
  "shortName": string,
  "displayName": string,
  "operators": [
    {
      object (QueryOperator)
    }
  ]
}
Поля
source

object ( Source )

Название источника

shortName

string

Короткое имя или псевдоним источника. Это значение можно использовать с оператором source.

displayName

string

Отображаемое имя источника данных.

operators[]

object ( 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