Method: query.suggest

クエリのオートコンプリート候補を提供します。

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

レスポンスの本文

suggest 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 が存在する場合、suggested_query は人物の候補であることを示します。suggestion は次のいずれかになります。
querySuggestion

object (QuerySuggestion)

このフィールドは、候補のクエリが単語/フレーズ補完の場合に存在します。
peopleSuggestion

object (PeopleSuggestion)

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

QuerySuggestion

この型にはフィールドがありません。

このフィールドには現時点では何も含まれておらず、候補結果がフレーズ補完であることを示すインジケータとしてのみ使用されます。

PeopleSuggestion

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

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

object (Person)

候補の人物。人物オブジェクトのすべてのフィールドが入力されない場合があります。