Method: query.sources.list

ユーザーが query.search API と Suggest API で使用できるソースのリストを返します。

注: この API を実行するには、標準のエンドユーザー アカウントが必要です。サービス アカウントは Query 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

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