Method: query.sources.list

사용자가 query.search 및 suggest API에 사용할 수 있는 소스 목록을 반환합니다.

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

HTTP 요청

GET https://cloudsearch.googleapis.com/v1/query/sources

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

쿼리 매개변수

매개변수
requestOptions

object (RequestOptions)

요청 옵션(예: 검색 애플리케이션 및 사용자 시간대)
pageToken

string

응답에서 반환할 소스 수입니다.

요청 본문

요청 본문은 비어 있어야 합니다.

응답 본문

성공할 경우 응답 본문에 다음 구조의 데이터가 포함됩니다.

소스 나열 응답입니다.

JSON 표현 
{
  "sources": [
    {
      object (QuerySource)
    }
  ],
  "nextPageToken": string
}
필드
sources[]

object (QuerySource)
nextPageToken

string

승인 범위

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

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

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

QuerySource

사용자가 Query API를 사용하여 검색할 수 있는 소스 목록입니다.

JSON 표현 
{
  "source": {
    object (Source)
  },
  "shortName": string,
  "displayName": string,
  "operators": [
    {
      object (QueryOperator)
    }
  ]
}
필드
source

object (Source)

소스 이름입니다.
shortName

string

소스의 짧은 이름 또는 별칭입니다. 이 값은 'source' 연산자와 같습니다.
displayName

string

데이터 소스의 표시 이름입니다.
operators[]

object (QueryOperator)

이 소스에 적용되는 모든 연산자 목록입니다.

QueryOperator

query.search/query.suggest 요청에서 사용할 수 있는 연산자의 정의입니다.

JSON 표현 
{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string,
  "type": enum (QueryOperator.Type),
  "displayName": string,
  "isSortable": boolean,
  "isFacetable": boolean,
  "isReturnable": boolean,
  "isRepeatable": boolean,
  "isSuggestable": boolean,
  "enumValues": [
    string
  ],
  "objectType": string
}
필드
operatorName

string

연산자 이름입니다.
lessThanOperatorName

string

보다 작음 연산자를 사용하여 속성을 격리하는 데 사용할 수 있는 연산자 이름을 나타냅니다.
greaterThanOperatorName

string

보다 큼 연산자를 사용하여 속성을 격리하는 데 사용할 수 있는 연산자 이름을 나타냅니다.
type

enum (QueryOperator.Type)

연산자 유형입니다.
displayName

string

운영자의 표시 이름입니다.
isSortable

boolean

이 연산자를 사용하여 결과를 정렬할 수 있나요?
isFacetable

boolean

이 연산자를 사용하여 패싯을 가져올 수 있나요?
isReturnable

boolean

이 속성과 연결된 속성이 검색 결과의 일부로 반환되나요?
isRepeatable

boolean

이 속성에 여러 값을 설정할 수 있는지 여부를 나타냅니다.
isSuggestable

boolean

이 필드에 관한 추천을 받을 수 있습니다.
enumValues[]

string

opeatror 필드의 가능한 값의 목록입니다. 이 필드는 이 연산자의 가능한 모든 값을 안전하게 열거할 수 있을 때만 채워집니다.
objectType

string

연산자에 해당하는 객체의 이름입니다. 이 필드는 스키마 관련 연산자의 경우에만 입력되며 일반 연산자에는 설정되지 않습니다.

QueryOperator.Type

연산자가 참조하는 속성의 유형입니다.

열거형
UNKNOWN 값이 올바르지 않습니다.
INTEGER
DOUBLE
TIMESTAMP
BOOLEAN
ENUM
DATE
TEXT
HTML