데이터 소스를 업데이트합니다.
참고: 이 API를 실행하려면 관리자 계정이 필요합니다.
HTTP 요청
PUT https://cloudsearch.googleapis.com/v1/settings/{source.name=datasources/*}
URL은 gRPC 트랜스코딩 문법을 사용합니다.
경로 매개변수
매개변수 | |
---|---|
source.name |
데이터 소스 리소스의 이름입니다. 형식: datasources/{sourceId}. 데이터 소스를 만들 때 이름은 무시됩니다. |
요청 본문
요청 본문에는 다음과 같은 구조의 데이터가 포함됩니다.
JSON 표현 |
---|
{ "source": { "name": string, "displayName": string, "shortName": string, "indexingServiceAccounts": [ string ], "disableServing": boolean, "disableModifications": boolean, "itemsVisibility": [ { // Union field |
필드 | |
---|---|
source.displayName |
필수 항목입니다. 데이터 소스의 표시 이름입니다. 최대 길이는 300자(영문 기준)입니다. |
source.shortName |
소스의 짧은 이름 또는 별칭입니다. 이 값은 'source'를 일치시키는 데 사용됩니다. 연산자와 같습니다. 예를 들어 짧은 이름이 <value>인 경우 <value>와 같은 쿼리는 이 소스의 결과만 반환합니다. 값은 모든 데이터 소스에서 고유해야 합니다. 값에는 영숫자 문자 (a~z, A~Z, 0~9)만 포함해야 합니다. 값은 'google'로 시작할 수 없습니다. 메일, Gmail, 문서, 드라이브, 그룹, 사이트, 캘린더, 행아웃, Google+, Keep, 사람, 팀 중 하나일 수 없습니다. 최대 길이는 32자(영문 기준)입니다. |
source.indexingServiceAccounts[] |
색인 생성 액세스 권한이 있는 서비스 계정의 목록입니다. |
source.disableServing |
검색 또는 지원 결과 제공을 사용 중지합니다. |
source.disableModifications |
true인 경우 데이터 소스가 읽기 전용 모드로 설정됩니다. 읽기 전용 모드에서 Indexing API는 이 소스의 항목에 대한 색인 생성 또는 삭제 요청을 거부합니다. 읽기 전용 모드를 사용 설정해도 이전에 수락된 데이터의 처리는 중지되지 않습니다. |
source.itemsVisibility[] |
이 필드는 데이터 소스 수준의 항목에 대한 공개 상태를 제한합니다. 데이터 소스 내의 항목은 이 필드에 포함된 사용자와 그룹의 합집합으로 제한됩니다. 이 경우 포함된 항목에 대한 ACL 권한이 사용자에게 있어야 하므로 특정 항목에 대한 액세스가 보장되지는 않습니다. 이렇게 하면 전체 데이터 소스에 대한 높은 수준의 액세스가 보장되고 개별 항목은 이 공개 범위 외부에서 공유되지 않습니다. |
source.returnThumbnailUrls |
사용자가 이 데이터 소스에서 색인이 생성된 항목의 썸네일 URI 가져오기를 요청할 수 있습니다. |
source.operationIds[] |
현재 이 스키마에 대해 실행 중인 장기 실행 작업 (LRO)의 ID입니다. |
debugOptions |
일반적인 디버그 옵션입니다. |
updateMask |
마스크를 업데이트하여 업데이트할 필드를 제어합니다. 필드 경로 예시:
|
응답 본문
성공한 경우 응답 본문에 Operation
의 인스턴스가 포함됩니다.
승인 범위
다음 OAuth 범위 중 하나가 필요합니다.
https://www.googleapis.com/auth/cloud_search.settings.indexing
https://www.googleapis.com/auth/cloud_search.settings
https://www.googleapis.com/auth/cloud_search
자세한 내용은 승인 가이드를 참조하세요.