Method: query.suggest

クエリの予測入力の候補を提示します。

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

HTTP リクエスト

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

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

リクエストの本文

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

JSON 表現 
{
  "requestOptions": {
    object (RequestOptions)
  },
  "query": string,
  "dataSourceRestrictions": [
    {
      object (DataSourceRestriction)
    }
  ]
}
フィールド
requestOptions

object (RequestOptions)

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

string

予測入力の候補を表示する部分的なクエリ。たとえば、クエリが「sea」の場合、サーバーは「season」、「search」、「seagull」を返す可能性があります。といった具合です
dataSourceRestrictions[]

object (DataSourceRestriction)

候補に使用するソース。指定しない場合、データソースは現在の検索アプリケーションから取得されます。

注: 候補は、次のソースについてのみサポートされます。

  • サードパーティのデータソース
  • PredefinedSource.PERSON
  • PredefinedSource.GOOGLE_DRIVE

レスポンスの本文

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

Suggestion API のレスポンス。

JSON 表現 
{
  "suggestResults": [
    {
      object (SuggestResult)
    }
  ]
}
フィールド
suggestResults[]

object (SuggestResult)

候補のリスト。

認可スコープ

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

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

詳細については、承認ガイドをご覧ください。

SuggestResult

候補が 1 件表示されます。

JSON 表現 
{
  "suggestedQuery": string,
  "source": {
    object (Source)
  },

  // Union field suggestion can be only one of the following:
  "querySuggestion": {
    object (QuerySuggestion)
  },
  "peopleSuggestion": {
    object (PeopleSuggestion)
  }
  // End of list of possible types for union field suggestion.
}
フィールド
suggestedQuery

string

ユーザーが候補をクリックしたときに、検索に使用される候補クエリ
source

object (Source)

提案のソース。
共用体フィールド suggestion。提案されたクエリに関する追加のメタデータが含まれます。また、提案されたクエリのタイプも示されます。例:PeopleSuggestion が存在する場合は、suggest_query が人物の候補であることを示しています。suggestion は次のいずれかになります。
querySuggestion

object (QuerySuggestion)

このフィールドは、提案されたクエリが単語またはフレーズの補完である場合に表示されます。
peopleSuggestion

object (PeopleSuggestion)

候補が人物を示している場合に表示されます。これには、メール ID や名前など、その人物に関する詳細情報が含まれます。

QuerySuggestion

今のところこのフィールドには何も含まれておらず、提案結果がフレーズの完成であったことを示す指標として使用されています。

PeopleSuggestion

このフィールドには、候補として表示された人物に関する情報が含まれます。

JSON 表現 
{
  "person": {
    object (Person)
  }
}
フィールド
person

object (Person)

ユーザー候補。人物オブジェクトのすべてのフィールドに値が入力されていない可能性があります。