Method: query.suggest

쿼리 자동 완성을 위한 추천을 제공합니다.

참고: 이 API를 실행하려면 표준 최종 사용자 계정이 필요합니다. 서비스 계정은 Query API 요청을 직접 실행할 수 없습니다. 서비스 계정을 사용하여 쿼리를 실행하려면 Google Workspace 도메인 전체 권한 위임을 설정하세요.

HTTP 요청

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

URL은 gRPC 트랜스코딩 구문을 사용합니다.

요청 본문

요청 본문에는 다음과 같은 구조의 데이터가 포함됩니다.

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)

추천 사용자 사람 객체의 일부 필드가 채워지지 않을 수 있습니다.