Method: indexing.datasources.items.index

Item ACL, 메타데이터, 콘텐츠를 업데이트합니다. Item가 없으면 삽입합니다. 이 메서드는 부분 업데이트를 지원하지 않습니다. 값이 제공되지 않은 필드는 Cloud Search 색인에서 지워집니다.

이 API를 실행하려면 관리자 또는 서비스 계정이 필요합니다. 사용된 서비스 계정이 해당 데이터 소스에서 허용된 계정입니다.

HTTP 요청

POST https://cloudsearch.googleapis.com/v1/indexing/{item.name=datasources/*/items/*}:index

URL은 gRPC 트랜스코딩 문법을 사용합니다.

경로 매개변수

매개변수
item.name

string

항목의 이름입니다. 형식: datasources/{sourceId}/items/{itemId}

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

요청 본문

요청 본문에는 다음과 같은 구조의 데이터가 포함됩니다.

JSON 표현 
{
  "item": {
    "name": string,
    "acl": {
      "inheritAclFrom": string,
      "aclInheritanceType": enum (ItemAcl.AclInheritanceType),
      "readers": [
        {
          object (Principal)
        }
      ],
      "deniedReaders": [
        {
          object (Principal)
        }
      ],
      "owners": [
        {
          object (Principal)
        }
      ]
    },
    "metadata": {
      "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)
        }
      ]
    },
    "structuredData": {
      "object": {
        object (StructuredDataObject)
      },
      "hash": string
    },
    "content": {
      "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.
    },
    "version": string,
    "status": {
      "code": enum (ItemStatus.Code),
      "processingErrors": [
        {
          object (ProcessingError)
        }
      ],
      "repositoryErrors": [
        {
          object (RepositoryError)
        }
      ]
    },
    "queue": string,
    "payload": string,
    "itemType": enum (Item.ItemType)
  },
  "connectorName": string,
  "mode": enum (RequestMode.Mode),
  "debugOptions": {
    object (DebugOptions)
  },
  "indexItemOptions": {
    object (IndexItemOptions)
  }
}
필드
item.acl

object (ItemAcl)

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

object (ItemMetadata)

메타데이터 정보입니다.
item.structuredData

object (ItemStructuredData)

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

object (ItemContent)

색인을 생성하고 텍스트를 검색 가능하게 만들 항목 콘텐츠입니다.
item.version

string (bytes format)

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

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

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

base64 인코딩 문자열입니다.
item.status

object (ItemStatus)

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

string

이 항목이 속한 현재 재생목록에 추가합니다. 최대 길이는 100자입니다.
item.payload

string (bytes format)

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

base64 인코딩 문자열입니다.
item.itemType

enum (Item.ItemType)

이 항목의 유형입니다.
connectorName

string

이 호출을 수행하는 커넥터의 이름입니다.

형식: datasources/{sourceId}/connectors/{ID}
mode

enum (RequestMode.Mode)

필수 항목입니다. 이 요청의 RequestMode입니다.
debugOptions

object (DebugOptions)

일반적인 디버그 옵션입니다.
indexItemOptions

object (IndexItemOptions)

응답 본문

성공한 경우 응답 본문에 Operation의 인스턴스가 포함됩니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/cloud_search.indexing
  • https://www.googleapis.com/auth/cloud_search

자세한 내용은 승인 가이드를 참조하세요.

IndexItemOptions

JSON 표현 
{
  "allowUnknownGsuitePrincipals": boolean
}
필드
allowUnknownGsuitePrincipals

boolean

색인 요청에서 존재하지 않거나 삭제된 Google Workspace 주 구성원을 허용해야 하는지를 지정합니다.