REST Resource: indexing.datasources.items

{
  "name": string,
  "acl": {
    object (ItemAcl)
  },
  "metadata": {
    object (ItemMetadata)
  },
  "structuredData": {
    object (ItemStructuredData)
  },
  "content": {
    object (ItemContent)
  },
  "version": string,
  "status": {
    object (ItemStatus)
  },
  "queue": string,
  "payload": string,
  "itemType": enum (Item.ItemType)
}

string

상품 이름입니다. 형식: datasources/{sourceId}/items/{itemId}

필수 필드입니다. 최대 길이는 1,536자(영문 기준)입니다.

object (ItemAcl)

이 항목의 액세스 제어 목록입니다.

object (ItemMetadata)

메타데이터 정보입니다.

object (ItemStructuredData)

데이터 소스 스키마에 있는 등록된 객체 정의를 준수해야 하는 항목의 구조화된 데이터입니다.

object (ItemContent)

색인을 생성하고 텍스트를 검색할 수 있도록 만들 항목 콘텐츠

string (bytes format)

필수 항목입니다. 색인 생성 시스템은 데이터 소스의 버전을 바이트 문자열로 저장하고 어휘 순서를 사용하여 색인의 항목 버전을 대기열에 추가된 항목의 버전과 비교합니다.

Cloud Search 색인 생성은 현재 색인이 생성된 항목 버전 이하의 버전 값인 대기 중인 항목의 색인을 생성하거나 삭제하지 않습니다. 이 필드의 최대 길이는 1,024바이트입니다.

항목 버전이 삭제 프로세스에 미치는 영향에 관한 자세한 내용은 수동 삭제 후 버전 처리를 참고하세요.

base64 인코딩 문자열입니다.

object (ItemStatus)

항목의 상태입니다. 출력 전용 필드입니다.

string

이 항목이 속한 대기열입니다. 최대 길이는 100자입니다.

string (bytes format)

추가 상태 커넥터는 이 항목에 대해 저장할 수 있습니다. 최대 길이는 10,000바이트입니다.

base64 인코딩 문자열입니다.

enum (Item.ItemType)

이 항목의 유형입니다.

{
  "inheritAclFrom": string,
  "aclInheritanceType": enum (ItemAcl.AclInheritanceType),
  "readers": [
    {
      object (Principal)
    }
  ],
  "deniedReaders": [
    {
      object (Principal)
    }
  ],
  "owners": [
    {
      object (Principal)
    }
  ]
}

string

액세스 권한 목록 (ACL)을 상속받을 항목의 이름입니다. 참고: ACL 상속은 하위 항목에 대한 액세스 권한만 제공하고 구조적 관계를 정의하지 않으며 대규모 항목 그룹을 삭제하는 편리한 방법을 제공하지 않습니다. 색인에서 ACL 상위 요소를 삭제하면 inheritAclFrom 필드에서 상위 항목을 참조하는 하위 항목의 액세스 권한만 변경됩니다. 항목이 여전히 색인에 포함되어 있지만 검색결과에는 표시되지 않을 수 있습니다. 반대로 컨테이너 항목을 삭제하면 containerName 필드를 통해 컨테이너를 참조하는 모든 항목도 삭제됩니다. 이 필드의 최대 길이는 1,536자(영문 기준)입니다.

enum (ItemAcl.AclInheritanceType)

항목이 상위 항목에서 ACL을 상속받을 때 적용할 액세스 규칙의 유형을 설정합니다. 이 필드는 항상 inheritAclFrom 필드와 함께 설정해야 합니다. 또한 inheritAclFrom 필드가 설정된 경우 이 필드는 유효한 AclInheritanceType으로 설정되어야 합니다.

object (Principal)

검색결과에서 항목을 볼 수 있는 주 구성원 목록 다른 항목에서 권한을 상속받거나 항목을 표시할 의도가 없는 경우(예: virtual containers) 선택사항입니다. 최대 요소 수는 1,000개입니다.

object (Principal)

검색결과에서 항목에 대한 액세스가 명시적으로 거부된 주 구성원 목록 기본적으로 주 구성원의 액세스 권한은 거부되지만 거부된 리더를 사용하여 예외를 처리하고 허용된 리더 목록을 재정의합니다. 최대 요소 수는 100개입니다.

object (Principal)

선택사항입니다. 항목의 소유자 목록입니다. 이 필드는 문서 액세스 권한과 관련이 없습니다. 그러나 검색하는 사용자가 소유자인 항목의 순위는 약간 상승합니다. 최대 요소 수는 5개입니다.

{

  // Union field principal can be only one of the following:
  "gsuitePrincipal": {
    object (GSuitePrincipal)
  },
  "userResourceName": string,
  "groupResourceName": string
  // End of list of possible types for union field principal.
}

object (GSuitePrincipal)

이 주 구성원은 Google Workspace 사용자, 그룹 또는 도메인입니다.

string

이 주 구성원은 외부 ID를 사용하여 식별된 사용자입니다. 이름 필드에는 Identitysources/{sourceId}/users/{ID} 형식으로 사용자 리소스 이름을 지정해야 합니다.

string

이 주 구성원은 외부 ID를 사용하여 식별된 그룹입니다. 이름 필드에는 idsources/{sourceId}/groups/{ID} 형식으로 그룹 리소스 이름을 지정해야 합니다.

{
  "title": string,
  "sourceRepositoryUrl": string,
  "containerName": string,
  "objectType": string,
  "createTime": string,
  "updateTime": string,
  "interactions": [
    {
      object (Interaction)
    }
  ],
  "contentLanguage": string,
  "mimeType": string,
  "searchQualityMetadata": {
    object (SearchQualityMetadata)
  },
  "keywords": [
    string
  ],
  "hash": string,
  "contextAttributes": [
    {
      object (ContextAttribute)
    }
  ]
}

string

상품 제목입니다. 지정된 경우 query.search 결과의 표시 제목이 됩니다. 최대 길이는 2,048자(영문 기준)입니다.

string

데이터를 제공하는 소스 저장소의 링크 검색 결과에서 이 링크를 제목에 적용합니다. 공백 또는 특수문자로 인해 Cloud Search 결과 링크에서 리디렉션 알림이 트리거될 수 있습니다. 이를 방지하려면 URL을 인코딩하세요. 최대 길이는 2,048자(영문 기준)입니다.

string

이 항목의 컨테이너 이름입니다. 컨테이너 항목이 삭제되면 이 항목이 자동으로 삭제됩니다. 참고: ACL은 컨테이너 항목에서 상속되지 않습니다. 항목에 ACL 상속을 제공하려면 inheritAclFrom 필드를 사용합니다. 최대 길이는 1,536자(영문 기준)입니다.

string

항목의 유형입니다. 데이터 소스에 등록된 스키마의 객체 정의 이름과 일치해야 합니다. 예를 들어 데이터 소스의 스키마에 'document'라는 이름의 객체 정의가 포함된 경우 해당 유형의 객체에 대한 항목 색인 생성 요청은 objectType을 'document'로 설정해야 합니다. 최대 길이는 256자(영문 기준)입니다.

string (Timestamp format)

항목이 소스 저장소에 생성된 시간입니다.

RFC3339 UTC 'Zulu' 형식의 타임스탬프입니다(나노초 단위, 소수점 이하 9자리). 예를 들면 "2014-10-02T15:01:23Z" 및 "2014-10-02T15:01:23.045123456Z"입니다.

string (Timestamp format)

소스 저장소에서 항목이 마지막으로 수정된 시간입니다.

RFC3339 UTC 'Zulu' 형식의 타임스탬프입니다(나노초 단위, 소수점 이하 9자리). 예를 들면 "2014-10-02T15:01:23Z" 및 "2014-10-02T15:01:23.045123456Z"입니다.

object (Interaction)

항목에 대한 상호작용 목록입니다. 상호작용은 query.search 품질을 개선하는 데 사용되지만 최종 사용자에게 노출되지는 않습니다. 최대 요소 수는 1,000개입니다.

string

상품의 BCP-47 언어 코드입니다(예: 'en-US' 또는 'sr-Latn'). 자세한 내용은 http://www.unicode.org/reports/tr35/#Unicode_locale_identifier를 참조하세요. 최대 길이는 32자(영문 기준)입니다.

string

소스 저장소에 있는 ItemContent.content의 원래 MIME 유형입니다. 최대 길이는 256자(영문 기준)입니다.

object (SearchQualityMetadata)

항목의 추가 검색 품질 메타데이터입니다.

string

항목과 일치해야 하는 추가 키워드 또는 구문입니다. 사용자 제작 콘텐츠에 내부적으로 사용됩니다. 최대 요소 수는 100개입니다. 최대 길이는 8,192자(영문 기준)입니다.

string

API 호출자가 제공한 해싱 값입니다. items.push 메서드와 함께 사용하여 수정된 상태를 계산할 수 있습니다. 최대 길이는 2,048자(영문 기준)입니다.

object (ContextAttribute)

상품과 연결된 이름이 지정된 속성의 집합입니다. 요청의 컨텍스트에 따라 항목의 순위에 영향을 미치는 데 사용할 수 있습니다. 최대 요소 수는 10개입니다.

{
  "type": enum (Interaction.InteractionType),
  "principal": {
    object (Principal)
  },
  "interactionTime": string
}

enum (Interaction.InteractionType)

object (Principal)

항목에서 작업한 사용자입니다.

string (Timestamp format)

사용자가 항목에서 작업한 시간입니다. 사용자 한 명에게 동일한 유형의 작업이 여러 개 있는 경우 가장 최근 작업만 기록됩니다.

RFC3339 UTC 'Zulu' 형식의 타임스탬프입니다(나노초 단위, 소수점 이하 9자리). 예를 들면 "2014-10-02T15:01:23Z" 및 "2014-10-02T15:01:23.045123456Z"입니다.

{
  "quality": number
}

number

항목의 품질 표시로, 검색 품질에 영향을 미치는 데 사용됩니다. 값은 0.0 (최저 품질)에서 1.0 (최고 품질) 사이여야 합니다. 기본값은 0.0입니다.

{
  "name": string,
  "values": [
    string
  ]
}

string

속성의 이름입니다. 이 입력란은 비워둘 수 없습니다. 최대 길이는 32자(영문 기준)입니다. 이름은 문자로 시작해야 하며 문자 (A~Z, a~z) 또는 숫자 (0~9)만 포함할 수 있습니다. 이름은 일치되기 전에 정규화 (소문자)됩니다.

string

속성의 텍스트 값입니다. 최대 요소 수는 10개입니다. 배열에 있는 요소의 최대 길이는 32자(영문 기준)입니다. 값은 일치되기 전에 정규화 (소문자)됩니다.

{
  "object": {
    object (StructuredDataObject)
  },
  "hash": string
}

object (StructuredDataObject)

데이터 소스 스키마에 있는 등록된 객체 정의를 준수해야 하는 구조화된 데이터 객체입니다.

string

API 호출자가 제공한 해싱 값입니다. items.push 메서드와 함께 사용하여 수정된 상태를 계산할 수 있습니다. 최대 길이는 2,048자(영문 기준)입니다.

{
  "properties": [
    {
      object (NamedProperty)
    }
  ]
}

object (NamedProperty)

객체의 속성입니다. 최대 요소 수는 1,000개입니다.

{
  "name": string,

  // Union field value can be only one of the following:
  "integerValues": {
    object (NamedProperty.IntegerValues)
  },
  "doubleValues": {
    object (NamedProperty.DoubleValues)
  },
  "timestampValues": {
    object (NamedProperty.TimestampValues)
  },
  "booleanValue": boolean,
  "objectValues": {
    object (NamedProperty.ObjectValues)
  },
  "enumValues": {
    object (NamedProperty.EnumValues)
  },
  "dateValues": {
    object (NamedProperty.DateValues)
  },
  "textValues": {
    object (NamedProperty.TextValues)
  },
  "htmlValues": {
    object (NamedProperty.HtmlValues)
  }
  // End of list of possible types for union field value.
}

string

속성의 이름입니다. 이 이름은 스키마의 객체 정의에 등록된 속성의 이름과 일치해야 합니다. 이 속성에 허용되는 최대 길이는 256자(영문 기준)입니다.

object (NamedProperty.IntegerValues)

object (NamedProperty.DoubleValues)

object (NamedProperty.TimestampValues)

boolean

object (NamedProperty.ObjectValues)

object (NamedProperty.EnumValues)

object (NamedProperty.DateValues)

object (NamedProperty.TextValues)

object (NamedProperty.HtmlValues)

{
  "values": [
    string
  ]
}

string (int64 format)

{
  "values": [
    number
  ]
}

number

{
  "values": [
    string
  ]
}

string (Timestamp format)

RFC3339 UTC 'Zulu' 형식의 타임스탬프입니다(나노초 단위, 소수점 이하 9자리). 예를 들면 "2014-10-02T15:01:23Z" 및 "2014-10-02T15:01:23.045123456Z"입니다.

{
  "values": [
    {
      object (StructuredDataObject)
    }
  ]
}

object (StructuredDataObject)

{
  "values": [
    string
  ]
}

string

허용되는 문자열 값의 최대 길이는 32자입니다.

{
  "values": [
    {
      object (Date)
    }
  ]
}

object (Date)

{
  "values": [
    string
  ]
}

string

텍스트 값의 최대 허용 길이는 2,048자입니다.

{
  "values": [
    string
  ]
}

string

HTML 값에 허용되는 최대 길이는 2,048자입니다.

{
  "contentFormat": enum (ItemContent.ContentFormat),
  "hash": string,

  // Union field content can be only one of the following:
  "inlineContent": string,
  "contentDataRef": {
    object (UploadItemRef)
  }
  // End of list of possible types for union field content.
}

enum (ItemContent.ContentFormat)

string

콘텐츠와 관련하여 API 클라이언트가 계산하고 제공하는 해싱 정보입니다. items.push 메서드와 함께 사용하여 수정된 상태를 계산할 수 있습니다. 최대 길이는 2,048자(영문 기준)입니다.

string (bytes format)

업데이트 메서드 내에서 인라인으로 제공되는 콘텐츠. 최대 길이는 102,400바이트 (100KiB)입니다.

base64 인코딩 문자열입니다.

object (UploadItemRef)

쓰기 메서드를 통해 이전에 업로드한 콘텐츠의 참조 ID를 업로드합니다.

{
  "name": string
}

string

콘텐츠 참조의 이름입니다. 최대 길이는 2,048자(영문 기준)입니다.

{
  "code": enum (ItemStatus.Code),
  "processingErrors": [
    {
      object (ProcessingError)
    }
  ],
  "repositoryErrors": [
    {
      object (RepositoryError)
    }
  ]
}

enum (ItemStatus.Code)

상태 코드입니다.

object (ProcessingError)

항목이 오류 상태인 경우의 오류 세부정보입니다.

object (RepositoryError)

커넥터에서 저장소 오류를 보고했습니다.

{
  "code": enum (ProcessingErrorCode),
  "errorMessage": string,
  "fieldViolations": [
    {
      object (FieldViolation)
    }
  ]
}

enum (ProcessingErrorCode)

오류의 특성을 나타내는 오류 코드입니다.

string

오류에 대한 설명입니다.

object (FieldViolation)

항목 필드가 잘못된 경우 이 필드에는 유효성 검사 오류에 대한 세부정보가 포함됩니다.

{
  "field": string,
  "description": string
}

string

위반 항목이 있는 필드의 경로입니다.

string

오류에 대한 설명입니다.

{
  "type": enum (RepositoryError.Type),
  "httpStatusCode": integer,
  "errorMessage": string
}

enum (RepositoryError.Type)

오류 유형

integer

오류 코드 HTTP 상태 코드의 정의와 일치합니다.

string

오류를 설명하는 메시지입니다. 허용되는 메시지 최대 길이는 8,192자(영문 기준)입니다.