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 Transcoding 構文を使用します。

パスパラメータ

パラメータ
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 インデックス登録では、現在インデックスに登録されているアイテムのバージョン以下であるバージョン値を持つキュー内のアイテムは、インデックスに登録または削除されません。このフィールドの最大長は 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 プリンシパルを許可するかどうかを指定します。