REST Resource: settings.datasources
컬렉션을 사용해 정리하기
내 환경설정을 기준으로 콘텐츠를 저장하고 분류하세요.
리소스: DataSource
데이터 소스는 색인이 생성될 항목의 논리적 네임스페이스입니다. 모든 항목은 데이터 소스에 속해야 합니다. 이는 Cloud Search에 항목의 색인을 생성하기 위한 기본 요건입니다.
JSON 표현 |
{
"name": string,
"displayName": string,
"shortName": string,
"indexingServiceAccounts": [
string
],
"disableServing": boolean,
"disableModifications": boolean,
"itemsVisibility": [
{
object (GSuitePrincipal )
}
],
"returnThumbnailUrls": boolean,
"operationIds": [
string
]
} |
필드 |
name |
string
데이터 소스 리소스의 이름입니다. 형식: datasources/{sourceId} 데이터 소스를 만들 때 이름은 무시됩니다.
|
displayName |
string
필수 항목입니다. 데이터 소스의 표시 이름입니다. 최대 길이는 300자(영문 기준)입니다.
|
shortName |
string
소스의 짧은 이름 또는 별칭입니다. 이 값은 'source' 연산자를 일치시키는 데 사용됩니다. 예를 들어 닉네임이 <value>인 경우 source:<value>와 같은 검색어는 이 소스의 결과만 반환합니다. 값은 모든 데이터 소스에서 고유해야 합니다. 값은 영숫자 문자 (a~zA~Z0~9)만 포함해야 합니다. 값은 'google'로 시작할 수 없으며 mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams 중 하나일 수 없습니다. 최대 길이는 32자(영문 기준)입니다.
|
indexingServiceAccounts[] |
string
색인 생성 액세스 권한이 있는 서비스 계정의 목록입니다.
|
disableServing |
boolean
검색 또는 어시스턴트 결과 게재를 사용 중지합니다.
|
disableModifications |
boolean
true이면 데이터 소스를 읽기 전용 모드로 설정합니다. 읽기 전용 모드에서는 Indexing API가 이 소스의 항목을 색인화하거나 삭제하는 모든 요청을 거부합니다. 읽기 전용 모드를 사용 설정해도 이전에 수락된 데이터의 처리는 중지되지 않습니다.
|
itemsVisibility[] |
object (GSuitePrincipal )
이 필드는 데이터 소스 수준의 항목으로 공개 상태를 제한합니다. 데이터 소스 내 항목은 이 필드에 포함된 사용자 및 그룹의 합집합으로 제한됩니다. 그러나 사용자가 포함된 항목에 대한 ACL 권한을 보유하고 있어야 하므로 특정 항목에 대한 액세스 권한이 보장되지는 않습니다. 이렇게 하면 전체 데이터 소스에 대한 높은 수준의 액세스 권한이 보장되고 개별 항목이 이 공개 범위 외부로 공유되지 않습니다.
|
returnThumbnailUrls |
boolean
사용자가 이 데이터 소스에 색인이 생성된 상품의 썸네일 URI를 가져오도록 요청할 수 있습니다.
|
operationIds[] |
string
이 스키마에 대해 현재 실행 중인 장기 실행 작업 (LRO)의 ID입니다.
|
메서드 |
|
데이터 소스를 만듭니다. |
|
데이터 소스를 삭제합니다. |
|
데이터 소스를 가져옵니다. |
|
데이터 소스를 나열합니다. |
|
데이터 소스를 업데이트합니다. |
|
데이터 소스를 업데이트합니다. |
달리 명시되지 않는 한 이 페이지의 콘텐츠에는 Creative Commons Attribution 4.0 라이선스에 따라 라이선스가 부여되며, 코드 샘플에는 Apache 2.0 라이선스에 따라 라이선스가 부여됩니다. 자세한 내용은 Google Developers 사이트 정책을 참조하세요. 자바는 Oracle 및/또는 Oracle 계열사의 등록 상표입니다.
최종 업데이트: 2025-07-25(UTC)
[null,null,["최종 업데이트: 2025-07-25(UTC)"],[],[],null,["# REST Resource: settings.datasources\n\n- [Resource: DataSource](#DataSource)\n - [JSON representation](#DataSource.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: DataSource\n--------------------\n\nDatasource is a logical namespace for items to be indexed. All items must belong to a datasource. This is the prerequisite before items can be indexed into Cloud Search.\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"displayName\": string, \"shortName\": string, \"indexingServiceAccounts\": [ string ], \"disableServing\": boolean, \"disableModifications\": boolean, \"itemsVisibility\": [ { object (/workspace/cloud-search/docs/reference/rest/v1/GSuitePrincipal) } ], \"returnThumbnailUrls\": boolean, \"operationIds\": [ string ] } ``` |\n\n| Fields ||\n|-----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` The name of the datasource resource. Format: datasources/{sourceId}. The name is ignored when creating a datasource. |\n| `displayName` | `string` Required. Display name of the datasource The maximum length is 300 characters. |\n| `shortName` | `string` A short name or alias for the source. This value will be used to match the 'source' operator. For example, if the short name is *\\\u003cvalue\\\u003e* then queries like *source:\\\u003cvalue\\\u003e* will only return results for this source. The value must be unique across all datasources. The value must only contain alphanumeric characters (a-zA-Z0-9). The value cannot start with 'google' and cannot be one of the following: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. Its maximum length is 32 characters. |\n| `indexingServiceAccounts[]` | `string` List of service accounts that have indexing access. |\n| `disableServing` | `boolean` Disable serving any search or assist results. |\n| `disableModifications` | `boolean` If true, sets the datasource to read-only mode. In read-only mode, the Indexing API rejects any requests to index or delete items in this source. Enabling read-only mode does not stop the processing of previously accepted data. |\n| `itemsVisibility[]` | `object (`[GSuitePrincipal](/workspace/cloud-search/docs/reference/rest/v1/GSuitePrincipal)`)` This field restricts visibility to items at the datasource level. Items within the datasource are restricted to the union of users and groups included in this field. Note that, this does not ensure access to a specific item, as users need to have ACL permissions on the contained items. This ensures a high level access on the entire datasource, and that the individual items are not shared outside this visibility. |\n| `returnThumbnailUrls` | `boolean` Can a user request to get thumbnail URI for Items indexed in this data source. |\n| `operationIds[]` | `string` IDs of the Long Running Operations (LROs) currently running for this schema. |\n\n| Methods ------- ||\n|------------------------------------------------------------------------------------------|-----------------------|\n| ### [create](/workspace/cloud-search/docs/reference/rest/v1/settings.datasources/create) | Creates a datasource. |\n| ### [delete](/workspace/cloud-search/docs/reference/rest/v1/settings.datasources/delete) | Deletes a datasource. |\n| ### [get](/workspace/cloud-search/docs/reference/rest/v1/settings.datasources/get) | Gets a datasource. |\n| ### [list](/workspace/cloud-search/docs/reference/rest/v1/settings.datasources/list) | Lists datasources. |\n| ### [patch](/workspace/cloud-search/docs/reference/rest/v1/settings.datasources/patch) | Updates a datasource. |\n| ### [update](/workspace/cloud-search/docs/reference/rest/v1/settings.datasources/update) | Updates a datasource. |"]]