- 리소스: 상품
- ItemAcl
- ItemAcl.AclInheritanceType
- 주 구성원
- ItemMetadata
- 상호작용
- Interaction.InteractionType
- SearchQualityMetadata
- ContextAttribute
- ItemStructuredData
- StructuredDataObject
- NamedProperty
- NamedProperty.IntegerValues
- NamedProperty.DoubleValues
- NamedProperty.TimestampValues
- NamedProperty.ObjectValues
- NamedProperty.EnumValues
- NamedProperty.DateValues
- NamedProperty.TextValues
- NamedProperty.HtmlValues
- ItemContent
- ItemContent.ContentFormat
- UploadItemRef
- ItemStatus
- ProcessingError
- ProcessingErrorCode
- FieldViolation
- RepositoryError
- RepositoryError.Type
- Item.ItemType
- 메서드
리소스: Item
파일, 폴더, 데이터베이스 레코드와 같이 검색 색인의 항목인 단일 객체를 나타냅니다.
JSON 표현 |
---|
{ "name": string, "acl": { object ( |
필드 | |
---|---|
name |
상품의 이름입니다. 형식: datasources/{sourceId}/items/{itemId} 필수 입력란입니다. 최대 길이는 1,536자(영문 기준)입니다. |
acl |
이 항목의 액세스 제어 목록입니다. |
metadata |
메타데이터 정보 |
structuredData |
데이터 소스의 스키마에 등록된 객체 정의를 준수해야 하는 항목의 구조화된 데이터입니다. |
content |
색인이 생성되고 텍스트 검색이 가능한 항목 콘텐츠입니다. |
version |
필수 항목입니다. 색인 생성 시스템은 데이터 소스의 버전을 바이트 문자열로 저장하고 색인에 있는 항목 버전을 문자순서를 사용하여 대기열에 추가된 항목의 버전과 비교합니다. Cloud Search 색인 생성은 현재 색인이 생성된 항목의 버전과 같거나 작은 버전 값을 가진 대기열에 있는 항목을 색인 생성하거나 삭제하지 않습니다. 이 필드의 최대 길이는 1,024바이트입니다. 상품 버전이 삭제 프로세스에 미치는 영향에 대한 자세한 내용은 수동 삭제 후 버전 처리를 참고하세요. base64 인코딩 문자열입니다. |
status |
상품의 상태입니다. 출력 전용 필드입니다. |
queue |
이 항목이 속한 대기열입니다. 최대 길이는 100자입니다. |
payload |
이 항목에 대한 추가 상태 커넥터를 저장할 수 있습니다. 최대 길이는 10,000바이트입니다. base64 인코딩 문자열입니다. |
itemType |
이 항목의 유형입니다. |
ItemAcl
항목의 액세스 제어 목록 정보입니다. 자세한 내용은 ACL 매핑을 참고하세요.
JSON 표현 |
---|
{ "inheritAclFrom": string, "aclInheritanceType": enum ( |
필드 | |
---|---|
inheritAclFrom |
액세스 권한 목록 (ACL)을 상속할 항목의 이름입니다. 참고: ACL 상속은 서드 파티에 대한 액세스 권한만 제공하며 구조적 관계를 정의하지도 않고 대규모 항목 그룹을 삭제하는 편리한 방법도 제공하지 않습니다. 색인에서 ACL 상위 요소를 삭제하면 |
aclInheritanceType |
항목이 상위 항목에서 ACL을 상속할 때 적용할 액세스 규칙 유형을 설정합니다. 항상 |
readers[] |
검색 결과에서 항목을 볼 수 있는 주 구성원 목록입니다. 다른 항목에서 권한을 상속받는 경우 또는 |
deniedReaders[] |
검색 결과의 항목에 대한 액세스가 명시적으로 거부된 주 구성원 목록입니다. 기본적으로 주 구성원에게는 액세스가 거부되지만 거부된 리더를 사용하여 예외를 처리하고 허용된 리더 목록을 재정의합니다. 최대 요소 수는 100개입니다. |
owners[] |
선택사항입니다. 항목의 소유자 목록입니다. 이 필드는 문서 액세스 권한과 관련이 없습니다. 그러나 쿼리하는 사용자가 소유자인 항목의 경우 약간의 순위 상승이 제공됩니다. 최대 요소 수는 5개입니다. |
ItemAcl.AclInheritanceType
ACL 상속 유형입니다.
열거형 | |
---|---|
NOT_APPLICABLE |
이 항목이 ACL을 상속하지 않는 경우의 기본값입니다. inheritAclFrom 가 비어 있으면 NOT_APPLICABLE을 사용합니다. ACL 상속이 없는 항목에도 자체 readers 및 deniedReaders 필드에서 제공하는 ACL이 있을 수 있습니다. |
CHILD_OVERRIDE |
승인 충돌 중에 하위 항목의 ACL에 따라 읽기 액세스 권한이 결정됩니다. |
PARENT_OVERRIDE |
승인 충돌이 발생하면 inheritAclFrom 필드에 지정된 상위 항목의 ACL에 따라 읽기 액세스 권한이 결정됩니다. |
BOTH_PERMIT |
이 항목과 inheritAclFrom 필드에 지정된 상위 항목 모두 읽기 액세스를 허용하는 경우에만 액세스가 부여됩니다. |
주 구성원
사용자, 그룹 또는 도메인 참조입니다.
JSON 표현 |
---|
{ // Union field |
필드 | |
---|---|
통합 필드
|
|
gsuitePrincipal |
이 주 구성원은 Google Workspace 사용자, 그룹 또는 도메인입니다. |
userResourceName |
이 주 구성원은 외부 ID를 사용하여 식별된 사용자입니다. name 필드는 identitysources/{sourceId}/users/{ID} 형식으로 사용자 리소스 이름을 지정해야 합니다. |
groupResourceName |
이 주 구성원은 외부 ID를 사용하여 식별된 그룹입니다. 이름 필드는 identitysources/{sourceId}/groups/{ID} 형식으로 그룹 리소스 이름을 지정해야 합니다. |
ItemMetadata
항목에 사용할 수 있는 메타데이터 필드입니다.
JSON 표현 |
---|
{ "title": string, "sourceRepositoryUrl": string, "containerName": string, "objectType": string, "createTime": string, "updateTime": string, "interactions": [ { object ( |
필드 | |
---|---|
title |
상품의 제목입니다. 지정된 경우 query.search 결과의 표시 제목이 됩니다. 최대 길이는 2,048자(영문 기준)입니다. |
sourceRepositoryUrl |
데이터를 제공하는 소스 저장소 링크입니다. 검색 결과에서 이 링크를 제목에 적용합니다. 공백이나 특수문자로 인해 Cloud Search 결과 링크에서 리디렉션 알림이 트리거될 수 있습니다. 이를 방지하려면 URL을 인코딩하세요. 최대 길이는 2,048자(영문 기준)입니다. |
containerName |
이 항목의 컨테이너 이름입니다. 컨테이너 항목을 삭제하면 이 항목이 자동으로 삭제됩니다. 참고: ACL은 컨테이너 항목에서 상속되지 않습니다. 항목에 ACL 상속을 제공하려면 |
objectType |
항목의 유형입니다. 이는 데이터 소스에 등록된 스키마의 객체 정의 이름과 일치해야 합니다. 예를 들어 데이터 소스의 스키마에 이름이 'document'인 객체 정의가 포함되어 있으면 해당 유형의 객체에 대한 항목 색인 생성 요청은 objectType을 'document'로 설정해야 합니다. 최대 길이는 256자(영문 기준)입니다. |
createTime |
소스 저장소에서 항목이 생성된 시간입니다. RFC3339 UTC 'Zulu' 형식의 타임스탬프입니다(나노초 단위, 소수점 이하 9자리). 예를 들면 |
updateTime |
소스 저장소에서 항목이 마지막으로 수정된 시간입니다. RFC3339 UTC 'Zulu' 형식의 타임스탬프입니다(나노초 단위, 소수점 이하 9자리). 예를 들면 |
interactions[] |
항목의 상호작용 목록입니다. 상호작용은 query.search 품질을 개선하는 데 사용되지만 최종 사용자에게는 노출되지 않습니다. 요소의 최대 개수는 1,000개입니다. |
contentLanguage |
상품의 BCP-47 언어 코드입니다(예: 'en-US' 또는 'sr-Latn'). 자세한 내용은 http://www.unicode.org/reports/tr35/#Unicode_locale_identifier를 참조하세요. 최대 길이는 32자(영문 기준)입니다. |
mimeType |
소스 저장소의 |
searchQualityMetadata |
상품의 추가 검색 품질 메타데이터 |
keywords[] |
상품과 일치해야 하는 추가 키워드 또는 구문입니다. 사용자 제작 콘텐츠에 내부적으로 사용됩니다. 최대 요소 수는 100개입니다. 최대 길이는 8,192자(영문 기준)입니다. |
hash |
API 호출자가 제공한 해싱 값입니다. |
contextAttributes[] |
상품과 연결된 이름이 지정된 속성 집합입니다. 요청의 컨텍스트를 기반으로 항목의 순위에 영향을 줄 때 사용할 수 있습니다. 최대 요소 수는 10개입니다. |
상호작용
사용자와 항목 간의 상호작용을 나타냅니다.
JSON 표현 |
---|
{ "type": enum ( |
필드 | |
---|---|
type |
|
principal |
항목에 조치를 취한 사용자입니다. |
interactionTime |
사용자가 항목에 대해 작업한 시간입니다. 한 사용자에 대해 동일한 유형의 작업이 여러 개 있는 경우 가장 최근 작업만 기록됩니다. RFC3339 UTC 'Zulu' 형식의 타임스탬프입니다(나노초 단위, 소수점 이하 9자리). 예를 들면 |
Interaction.InteractionType
사용자가 항목에서 수행한 활동 유형입니다.
열거형 | |
---|---|
UNSPECIFIED |
값이 올바르지 않습니다. |
VIEW |
이 상호작용은 사용자가 항목을 조회했음을 나타냅니다. |
EDIT |
이 상호작용은 사용자가 항목을 수정했음을 나타냅니다. |
SearchQualityMetadata
상품의 추가 검색 품질 메타데이터입니다.
JSON 표현 |
---|
{ "quality": number } |
필드 | |
---|---|
quality |
검색 품질에 영향을 주기 위해 사용되는 상품 품질의 지표입니다. 값은 0.0 (최저 품질)과 1.0 (최고 품질) 사이여야 합니다. 기본값은 0.0입니다. |
ContextAttribute
항목과 연결된 이름이 지정된 속성으로, 요청의 컨텍스트를 기반으로 항목의 순위에 영향을 줄 때 사용할 수 있습니다.
JSON 표현 |
---|
{ "name": string, "values": [ string ] } |
필드 | |
---|---|
name |
속성 이름입니다. 비워 둘 수 없습니다. 최대 길이는 32자(영문 기준)입니다. 이름은 문자로 시작해야 하며 문자 (A~Z, a~z) 또는 숫자 (0~9)만 포함할 수 있습니다. 이름은 일치하기 전에 정규화 (소문자로 변환)됩니다. |
values[] |
속성의 텍스트 값입니다. 최대 요소 수는 10개입니다. 배열의 요소 최대 길이는 32자(영문 기준)입니다. 값은 일치하기 전에 정규화 (소문자로 변환)됩니다. |
ItemStructuredData
상품에 사용할 수 있는 구조화된 데이터 필드입니다.
JSON 표현 |
---|
{
"object": {
object ( |
필드 | |
---|---|
object |
데이터 소스의 스키마에 등록된 객체 정의를 준수해야 하는 구조화된 데이터 객체입니다. |
hash |
API 호출자가 제공한 해싱 값입니다. |
StructuredDataObject
이름이 지정된 속성으로 구성된 구조화된 데이터 객체입니다.
JSON 표현 |
---|
{
"properties": [
{
object ( |
필드 | |
---|---|
properties[] |
객체의 속성입니다. 요소의 최대 개수는 1,000개입니다. |
NamedProperty
구조화된 데이터의 유형이 지정된 이름-값 쌍입니다. 값의 유형은 objectType
의 객체 정의에서 name
속성에 등록된 유형과 동일해야 합니다.
JSON 표현 |
---|
{ "name": string, // Union field |
필드 | |
---|---|
name |
속성 이름입니다. 이 이름은 스키마에서 객체 정의에 등록된 속성의 이름과 일치해야 합니다. 이 속성의 최대 허용 길이는 256자(영문 기준)입니다. |
통합 필드 value . 이름이 지정된 속성의 값입니다. 속성은 한 유형의 값만 보유할 수 있습니다. value 은 다음 중 하나여야 합니다. |
|
integerValues |
|
doubleValues |
|
timestampValues |
|
booleanValue |
|
objectValues |
|
enumValues |
|
dateValues |
|
textValues |
|
htmlValues |
|
NamedProperty.IntegerValues
정수 값 목록
JSON 표현 |
---|
{ "values": [ string ] } |
필드 | |
---|---|
values[] |
|
NamedProperty.DoubleValues
double 값 목록입니다.
JSON 표현 |
---|
{ "values": [ number ] } |
필드 | |
---|---|
values[] |
|
NamedProperty.TimestampValues
타임스탬프 값 목록입니다.
JSON 표현 |
---|
{ "values": [ string ] } |
필드 | |
---|---|
values[] |
RFC3339 UTC 'Zulu' 형식의 타임스탬프입니다(나노초 단위, 소수점 이하 9자리). 예를 들면 |
NamedProperty.ObjectValues
객체 값 목록입니다.
JSON 표현 |
---|
{
"values": [
{
object ( |
필드 | |
---|---|
values[] |
|
NamedProperty.EnumValues
enum 값 목록
JSON 표현 |
---|
{ "values": [ string ] } |
필드 | |
---|---|
values[] |
문자열 값의 허용되는 최대 길이는 32자(영문 기준)입니다. |
NamedProperty.DateValues
날짜 값 목록입니다.
JSON 표현 |
---|
{
"values": [
{
object ( |
필드 | |
---|---|
values[] |
|
NamedProperty.TextValues
텍스트 값 목록
JSON 표현 |
---|
{ "values": [ string ] } |
필드 | |
---|---|
values[] |
텍스트 값의 최대 허용 길이는 2,048자(영문 기준)입니다. |
NamedProperty.HtmlValues
html 값 목록
JSON 표현 |
---|
{ "values": [ string ] } |
필드 | |
---|---|
values[] |
html 값의 최대 허용 길이는 2,048자(영문 기준)입니다. |
ItemContent
Cloud Search에서 색인을 생성하고 표시할 항목의 콘텐츠입니다. UTF-8로 인코딩된 문자열만 inlineContent
로 허용됩니다. 바이너리가 아닌 콘텐츠를 업로드하는 경우 UTF-8로 인코딩되어야 합니다.
JSON 표현 |
---|
{ "contentFormat": enum ( |
필드 | |
---|---|
contentFormat |
|
hash |
콘텐츠에 대해 API 클라이언트가 계산하고 제공하는 해싱 정보입니다. items.push 메서드와 함께 사용하여 수정된 상태를 계산할 수 있습니다. 최대 길이는 2,048자(영문 기준)입니다. |
통합 필드
|
|
inlineContent |
업데이트 메서드 내에 인라인으로 제공되는 콘텐츠입니다. 최대 길이는 102,400바이트 (100KiB)입니다. base64 인코딩 문자열입니다. |
contentDataRef |
write 메서드를 통해 이전에 업로드된 콘텐츠의 참조 ID를 업로드합니다. |
ItemContent.ContentFormat
콘텐츠의 형식입니다. 형식이 RAW인 경우 콘텐츠는 mimeType
에서 지정한 형식이어야 합니다.
열거형 | |
---|---|
UNSPECIFIED |
값이 올바르지 않습니다. |
HTML |
contentFormat은 HTML입니다. |
TEXT |
contentFormat은 자유 텍스트입니다. |
RAW |
contentFormat은 원시 바이트입니다. |
UploadItemRef
업로드 세션 참조를 나타냅니다. 이 참조는 upload method
를 통해 생성됩니다. 이 참조는 생성 후 30일 동안 유효합니다. 상품 콘텐츠를 업데이트할 때 contentDataRef
를 통해 업로드된 콘텐츠를 참조할 수 있습니다.
JSON 표현 |
---|
{ "name": string } |
필드 | |
---|---|
name |
콘텐츠 참조의 이름입니다. 최대 길이는 2,048자(영문 기준)입니다. |
ItemStatus
여기에는 항목의 상태와 오류가 포함됩니다.
JSON 표현 |
---|
{ "code": enum ( |
필드 | |
---|---|
code |
상태 코드입니다. |
processingErrors[] |
항목이 ERROR 상태인 경우의 오류 세부정보입니다. |
repositoryErrors[] |
커넥터에서 저장소 오류를 보고했습니다. |
ProcessingError
JSON 표현 |
---|
{ "code": enum ( |
필드 | |
---|---|
code |
오류의 성격을 나타내는 오류 코드입니다. |
errorMessage |
오류에 대한 설명입니다. |
fieldViolations[] |
상품 필드가 잘못된 경우 이 필드에 유효성 검사 오류에 관한 세부정보가 포함됩니다. |
ProcessingErrorCode
Cloud Search 서버에서 항목을 처리하는 중에 발생한 오류를 나타내는 코드입니다. 단일 항목에 여러 처리 오류가 포함될 수 있습니다.
열거형 | |
---|---|
PROCESSING_ERROR_CODE_UNSPECIFIED |
값만 입력합니다. 항목에서 이 값을 사용합니다. |
MALFORMED_REQUEST |
항목의 ACL, 메타데이터 또는 콘텐츠가 잘못되거나 잘못된 상태입니다. FieldViolations에는 문제가 발생한 위치에 관한 자세한 내용이 포함되어 있습니다. |
UNSUPPORTED_CONTENT_FORMAT |
지원되지 않는 콘텐츠 형식입니다. |
INDIRECT_BROKEN_ACL |
ACL이 손상된 다른 항목을 상속받았거나 매핑되지 않은 하위 요소가 있는 그룹이 포함되어 있어 ACL 정보가 불완전한 항목 |
ACL_CYCLE |
ACL 상속 그래프가 순환을 형성했습니다. |
FieldViolation
JSON 표현 |
---|
{ "field": string, "description": string } |
필드 | |
---|---|
field |
위반이 있는 필드의 경로입니다. |
description |
오류에 대한 설명입니다. |
RepositoryError
커넥터가 소스 저장소와 통신할 때 발생하는 오류입니다.
JSON 표현 |
---|
{
"type": enum ( |
필드 | |
---|---|
type |
오류 유형입니다. |
httpStatusCode |
오류 코드 HTTP 상태 코드의 정의와 일치합니다. |
errorMessage |
오류를 설명하는 메시지입니다. 허용되는 최대 메시지 길이는 8,192자(영문 기준)입니다. |
RepositoryError.Type
저장소와의 통신 문제에 대한 오류 코드 목록입니다.
열거형 | |
---|---|
UNKNOWN |
알 수 없는 오류입니다. |
NETWORK_ERROR |
알 수 없는 호스트 또는 연결할 수 없는 호스트 |
DNS_ERROR |
DNS 서버가 응답하지 않는 등 DNS 문제 |
CONNECTION_ERROR |
저장소 서버에 연결할 수 없습니다. |
AUTHENTICATION_ERROR |
잘못된 사용자 인증 정보로 인해 인증에 실패했습니다. |
AUTHORIZATION_ERROR |
저장소에 대한 서비스 계정 권한이 없습니다. |
SERVER_ERROR |
저장소 서버 오류입니다. |
QUOTA_EXCEEDED |
용량을 초과했습니다. |
SERVICE_UNAVAILABLE |
서버를 일시적으로 사용할 수 없습니다. |
CLIENT_ERROR |
커넥터에서 저장소 서버로 전송한 잘못된 요청과 같은 클라이언트 관련 오류입니다. |
Item.ItemType
열거형 | |
---|---|
UNSPECIFIED |
|
CONTENT_ITEM |
정보를 제공하기 위한 목적으로만 색인이 생성된 항목입니다. 이러한 항목은 containerName 또는 inheritAclFrom 필드에서 참조할 수 없습니다. |
CONTAINER_ITEM |
색인이 생성되며 다른 항목에 ACL을 제공하거나 다른 항목을 포함하는 것을 목적으로 하는 항목입니다. |
VIRTUAL_CONTAINER_ITEM |
색인이 생성되지 않지만 CONTAINER_ITEM과 목적이 동일한 항목입니다. |
메서드 |
|
---|---|
|
지정된 리소스 이름의 Item resource 를 삭제합니다. |
|
대기열의 모든 항목을 삭제합니다. |
|
상품 이름별로 Item resource 를 가져옵니다. |
|
Item ACL, 메타데이터, 콘텐츠를 업데이트합니다. |
|
Item resources 의 전체 또는 하위 집합을 나열합니다. |
|
색인 생성 대기열에서 예약되지 않은 항목을 폴링하고 가장 높은 우선순위 ItemStatus 에서 가장 오래된 타임스탬프가 있는 항목부터 시작하여 세트를 예약됨으로 표시합니다. |
|
나중에 폴링 및 업데이트할 수 있도록 항목을 큐에 푸시합니다. |
|
대기열에서 모든 항목의 예약을 해제하여 모두 폴링할 수 있도록 합니다. |
|
상품 콘텐츠를 업로드하기 위한 업로드 세션을 만듭니다. |