Method: query.search

Cloud Search Query API は、ユーザーのクエリから最も関連性の高い結果を返す検索メソッドを提供します。検索結果は、Gmail や Google ドライブなどの Google Workspace アプリから取得することも、サードパーティからインデックスに登録したデータから取得することもできます。

注: この API を実行するには、標準のエンドユーザー アカウントが必要です。サービス アカウントはクエリ API リクエストを直接実行できません。サービス アカウントを使用してクエリを実行するには、Google Workspace ドメイン全体の権限の委任を設定します。

HTTP リクエスト

POST https://cloudsearch.googleapis.com/v1/query/search

この URL は gRPC Transcoding 構文を使用します。

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "requestOptions": {
    object (RequestOptions)
  },
  "query": string,
  "pageSize": integer,
  "start": integer,
  "dataSourceRestrictions": [
    {
      object (DataSourceRestriction)
    }
  ],
  "facetOptions": [
    {
      object (FacetOptions)
    }
  ],
  "sortOptions": {
    object (SortOptions)
  },
  "queryInterpretationOptions": {
    object (QueryInterpretationOptions)
  },
  "contextAttributes": [
    {
      object (ContextAttribute)
    }
  ]
}
フィールド
requestOptions

object (RequestOptions)

検索アプリやユーザーのタイムゾーンなどのリクエスト オプション。
query

string

未加工のクエリ文字列。サポートされている検索演算子については、演算子を使用して検索を絞り込むをご覧ください。
pageSize

integer

1 ページで返される検索結果の最大数。有効な値は 1 ～ 100 です。デフォルト値は 10 です。2,000 件を超える結果がリクエストされた場合の最小値は 50 です。
start

integer

結果の開始インデックス。
dataSourceRestrictions[]

object (DataSourceRestriction)

クエリに使用するソース。指定しない場合、現在の検索アプリケーションのすべてのデータソースが使用されます。
facetOptions[]

object (FacetOptions)
sortOptions

object (SortOptions)

検索結果の並べ替えオプション
queryInterpretationOptions

object (QueryInterpretationOptions)

オプションを使用してユーザーのクエリを解釈します。
contextAttributes[]

object (ContextAttribute)

検索結果のランキング調整に使用されるリクエストのコンテキスト属性。要素の最大数は 10 です。

レスポンスの本文

成功した場合、レスポンスの本文には SearchResponse のインスタンスが含まれます。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud_search.query
  • https://www.googleapis.com/auth/cloud_search

詳しくは、認可ガイドをご覧ください。