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

ユーザーがクエリ 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

opeatror フィールドの値のリスト。このフィールドが入力されるのは、この演算子のすべての有効な値を安全に列挙できる場合のみです。
objectType

string

演算子に対応するオブジェクトの名前。このフィールドは、スキーマ固有の演算子に対してのみ入力され、一般的な演算子では設定されません。

QueryOperator.Type

演算子によって参照されるプロパティの型。

列挙型
UNKNOWN 値が無効です。
INTEGER
DOUBLE
TIMESTAMP
BOOLEAN
ENUM
DATE
TEXT
HTML