クエリをオートコンプリートするための候補を提供します。
注: この API を実行するには、標準のエンドユーザー アカウントが必要です。サービス アカウントが Query API リクエストを直接実行することはできません。サービス アカウントを使用してクエリを実行するには、Google Workspace ドメイン全体の権限の委任を設定します。
HTTP リクエスト
POST https://cloudsearch.googleapis.com/v1/query/suggest
この URL は gRPC Transcoding 構文を使用します。
リクエスト本文
リクエストの本文には、次の構造のデータが含まれます。
JSON 表現 |
---|
{ "requestOptions": { object ( |
フィールド | |
---|---|
requestOptions |
検索アプリケーションやユーザーのタイムゾーンなどのリクエスト オプション。 |
query |
オートコンプリートの候補を表示する部分的なクエリ。たとえば、クエリが「sea」の場合、サーバーは「season」、「search」、「seagull」などを返します。 |
dataSourceRestrictions[] |
候補に使用するソース。指定しない場合、データソースは現在の検索アプリケーションから取得されます。 注: 提案は、次のソースに対してのみサポートされています。
|
レスポンスの本文
成功すると、レスポンスの本文に次の構造のデータが含まれます。
提案 API のレスポンス。
JSON 表現 |
---|
{
"suggestResults": [
{
object ( |
フィールド | |
---|---|
suggestResults[] |
候補のリスト。 |
認可スコープ
次の OAuth スコープのいずれかが必要です。
https://www.googleapis.com/auth/cloud_search.query
https://www.googleapis.com/auth/cloud_search
詳細については、承認ガイドをご覧ください。
SuggestResult
候補が 1 件あります。
JSON 表現 |
---|
{ "suggestedQuery": string, "source": { object ( |
フィールド | |
---|---|
suggestedQuery |
ユーザーが候補をクリックしたときに、検索に使用されるクエリ候補 |
source |
候補のソース。 |
共用体フィールド suggestion 。提案されたクエリに関する追加のメタデータが含まれます。また、提案されたクエリの種類も表示されます。たとえば、PeopleSuggestion がある場合は、suggested_query が人物の候補であることを示しています。suggestion は次のいずれかになります。 |
|
querySuggestion |
候補のクエリが単語またはフレーズの補完である場合に、このフィールドが存在します。 |
peopleSuggestion |
候補が人物を示す場合に存在します。メール ID や名前など、そのユーザーに関する詳細情報が含まれています。 |
QuerySuggestion
このフィールドには現時点では何も含まれておらず、候補の結果がフレーズの補完であったことを示すインジケーターとして使用されます。
PeopleSuggestion
このフィールドには、候補として表示されるユーザーの情報が含まれます。
JSON 表現 |
---|
{
"person": {
object ( |
フィールド | |
---|---|
person |
友だち候補。person オブジェクトのすべてのフィールドにデータが入力されていない可能性があります。 |