Method: query.debugSearch

Cloud Search 쿼리 API의 디버그 정보를 반환하여 검색 메서드를 제공합니다.

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

HTTP 요청

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

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

요청 본문

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

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~100입니다. 기본값은 10입니다. 2,000개를 초과하는 결과를 요청하는 경우 최솟값은 50입니다.
start

integer

결과의 시작 색인입니다.
dataSourceRestrictions[]

object (DataSourceRestriction)

쿼리에 사용할 소스입니다. 지정하지 않으면 현재 검색 애플리케이션의 모든 데이터 소스가 사용됩니다.
facetOptions[]

object (FacetOptions)
sortOptions

object (SortOptions)

검색 결과 정렬 옵션
queryInterpretationOptions

object (QueryInterpretationOptions)

사용자 검색어를 해석하는 옵션
contextAttributes[]

object (ContextAttribute)

검색 결과의 순위를 조정하는 데 사용되는 요청의 컨텍스트 속성입니다. 최대 요소 수는 10개입니다.

응답 본문

query.search 응답을 디버그합니다.

성공한 경우 응답 본문은 다음과 같은 구조의 데이터를 포함합니다.

JSON 표현 
{
  "searchResponse": {
    object (SearchResponse)
  },
  "gsrRequest": string,
  "gsrResponse": string
}
필드
searchResponse

object (SearchResponse)

Query.search 응답
gsrRequest

string (bytes format)

GenericSearchRequest의 직렬화된 문자열입니다.

base64 인코딩 문자열입니다.
gsrResponse

string (bytes format)

GenericSearchResponse의 직렬화된 문자열입니다.

base64 인코딩 문자열입니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

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

자세한 내용은 승인 가이드를 참고하세요.