Cloud Search API

Cloud Search는 Google Workspace 데이터에 대해 클라우드 기반 검색 기능을 제공합니다. Cloud Search API를 사용하면 Google Workspace 이외의 데이터에 대해 Cloud Search로 색인을 생성할 수 있습니다.

서비스: cloudsearch.googleapis.com

이 서비스를 호출하려면 Google에서 제공하는 클라이언트 라이브러리를 사용하는 것이 좋습니다. 애플리케이션이 자체 라이브러리를 사용하여 이 서비스를 호출해야 하는 경우 API를 요청할 때 다음 정보를 사용합니다.

검색 문서

검색 문서는 머신에서 읽을 수 있는 사양이며 REST API를 설명하고 사용하는 데 참조할 수 있습니다. 또한 클라이언트 라이브러리, IDE 플러그인, Google API와 상호작용하는 기타 도구를 빌드하는 데 사용됩니다. 하나의 서비스는 여러 개의 검색 문서를 제공할 수 있습니다. 이 서비스는 다음 검색 문서를 제공합니다.

서비스 엔드포인트

서비스 엔드포인트는 API 서비스의 네트워크 주소를 지정하는 기본 URL입니다. 하나의 서비스는 여러 서비스 엔드포인트를 포함할 수 있습니다. 이 서비스에는 다음 서비스 엔드포인트가 포함되고, 그 아래의 모든 URI는 이 서비스 엔드포인트와 관련됩니다.

  • https://cloudsearch.googleapis.com

REST 리소스: v1

메소드
initializeCustomer POST /v1:initializeCustomer
Google Cloud Search에서 third party 지원을 사용 설정합니다.

REST 리소스: v1.debug.datasources.items

메소드
checkAccess POST /v1/debug/{name=datasources/*/items/*}:checkAccess
지정된 주 구성원이 항목에 액세스할 수 있는지 확인합니다.
searchByViewUrl POST /v1/debug/{name=datasources/*}/items:searchByViewUrl
요청에 제공된 URL의 viewUrl과 정확하게 일치하는 항목을 가져옵니다.

REST 리소스: v1.debug.datasources.items.unmappedids

메소드
list GET /v1/debug/{parent=datasources/*/items/*}/unmappedids
특정 항목의 매핑되지 않은 모든 ID를 나열합니다.

REST 리소스: v1.debug.identitysources.items

메소드
listForunmappedidentity GET /v1/debug/{parent=identitysources/*}/items:forunmappedidentity
매핑되지 않은 ID와 연결된 항목의 이름을 나열합니다.

REST 리소스: v1.debug.identitysources.unmappedids

메소드
list GET /v1/debug/{parent=identitysources/*}/unmappedids
ID 소스의 매핑되지 않은 사용자 ID를 나열합니다.

REST 리소스: v1.indexing.datasources

메소드
deleteSchema DELETE /v1/indexing/{name=datasources/*}/schema
데이터 소스의 스키마를 삭제합니다.
getSchema GET /v1/indexing/{name=datasources/*}/schema
데이터 소스의 스키마를 가져옵니다.
updateSchema PUT /v1/indexing/{name=datasources/*}/schema
데이터 소스의 스키마를 업데이트합니다.

REST 리소스: v1.indexing.datasources.items

메소드
delete DELETE /v1/indexing/{name=datasources/*/items/*}
지정된 리소스 이름의 Item resource을 삭제합니다.
deleteQueueItems POST /v1/indexing/{name=datasources/*}/items:deleteQueueItems
큐에 있는 모든 항목을 삭제합니다.
get GET /v1/indexing/{name=datasources/*/items/*}
항목 이름으로 Item resource를 가져옵니다.
index POST /v1/indexing/{item.name=datasources/*/items/*}:index
ACL, 메타데이터, 콘텐츠를 Item 업데이트합니다.
list GET /v1/indexing/{name=datasources/*}/items
Item resources의 전체 또는 일부를 나열합니다.
poll POST /v1/indexing/{name=datasources/*}/items:poll
색인 생성 대기열에서 예약되지 않은 항목을 폴링하고 집합을 예약된 것으로 표시합니다. 처음에는 우선순위가 가장 높은 ItemStatus에서 타임스탬프가 가장 오래된 항목부터 시작합니다.
push POST /v1/indexing/{item.name=datasources/*/items/*}:push
나중에 폴링 및 업데이트할 수 있도록 항목을 큐로 푸시합니다.
unreserve POST /v1/indexing/{name=datasources/*}/items:unreserve
대기열의 모든 항목을 예약 취소하여 모두 폴링할 수 있도록 합니다.
upload POST /v1/indexing/{name=datasources/*/items/*}:upload
항목 콘텐츠를 업로드하기 위한 업로드 세션을 만듭니다.

REST 리소스: v1.media

메소드
upload POST /v1/media/{resourceName=**}
POST /upload/v1/media/{resourceName=**}
색인 생성을 위해 미디어를 업로드합니다.

REST 리소스: v1.operations

메소드
get GET /v1/{name=operations/**}
장기 실행 작업의 최신 상태를 가져옵니다.

REST 리소스: v1.query

메소드
search POST /v1/query/search
Cloud Search Query API는 사용자 쿼리에서 가장 관련성 높은 결과를 반환하는 검색 메서드를 제공합니다.
suggest POST /v1/query/suggest
쿼리 자동 완성을 위한 제안사항을 제공합니다.

REST 리소스: v1.query.sources

메소드
list GET /v1/query/sources
사용자가 검색 및 추천 API에 사용할 수 있는 소스 목록을 반환합니다.

REST 리소스: v1.settings

메소드
getCustomer GET /v1/settings/customer
고객 설정을 가져옵니다.
updateCustomer PATCH /v1/settings/customer
고객 설정을 업데이트합니다.

REST 리소스: v1.settings.datasources

메소드
create POST /v1/settings/datasources
데이터 소스를 만듭니다.
delete DELETE /v1/settings/{name=datasources/*}
데이터 소스를 삭제합니다.
get GET /v1/settings/{name=datasources/*}
데이터 소스를 가져옵니다.
list GET /v1/settings/datasources
데이터 소스를 나열합니다.
update PUT /v1/settings/{source.name=datasources/*}
데이터 소스를 업데이트합니다.

REST 리소스: v1.settings.searchapplications

메소드
create POST /v1/settings/searchapplications
검색 애플리케이션을 만듭니다.
delete DELETE /v1/settings/{name=searchapplications/*}
검색 애플리케이션을 삭제합니다.
get GET /v1/settings/{name=searchapplications/*}
지정된 검색 애플리케이션을 가져옵니다.
list GET /v1/settings/searchapplications
모든 검색 애플리케이션을 나열합니다.
reset POST /v1/settings/{name=searchapplications/*}:reset
검색 애플리케이션을 기본 설정으로 재설정합니다.
update PUT /v1/settings/{searchApplication.name=searchapplications/*}
검색 애플리케이션을 업데이트합니다.

REST 리소스: v1.stats

메소드
getIndex GET /v1/stats/index
모든 데이터 소스에서 색인 생성된 항목 통계를 집계합니다.
getQuery GET /v1/stats/query
고객의 쿼리 통계를 가져옵니다.
getSearchapplication GET /v1/stats/searchapplication
고객의 검색 애플리케이션 통계를 확인합니다.
getSession GET /v1/stats/session
클릭 세션 통계로 성공적인 검색 세션의 수, 성공한 세션의 비율을 가져옵니다.
getUser GET /v1/stats/user
고객의 사용자 통계를 가져옵니다.

REST 리소스: v1.stats.index.datasources

메소드
get GET /v1/stats/index/{name=datasources/*}
단일 데이터 소스의 색인 생성된 항목 통계를 가져옵니다.

REST 리소스: v1.stats.query.searchapplications

메소드
get GET /v1/stats/query/{name=searchapplications/*}
검색 애플리케이션에 대한 쿼리 통계를 가져옵니다.

REST 리소스: v1.stats.session.searchapplications

메소드
get GET /v1/stats/session/{name=searchapplications/*}
검색 애플리케이션의 클릭 쿼리 통계를 통해 검색 세션의 수, 성공적인 세션의 비율을 가져옵니다.

REST 리소스: v1.stats.user.searchapplications

메소드
get GET /v1/stats/user/{name=searchapplications/*}
검색 애플리케이션에 대한 사용자 통계를 가져옵니다.