- HTTP リクエスト
- パスパラメータ
- リクエストの本文
- レスポンスの本文
- 承認スコープ
- IndexItemOptions
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- 試してみる
Item
の ACL、メタデータ、コンテンツを更新します。Item
が存在しない場合は、挿入されます。この方法では部分的な更新はサポートされていません。値が指定されていないフィールドは、Cloud Search インデックスで消去されます。
この API を実行するには、管理者またはサービス アカウントが必要です。使用されるサービス アカウントが、対応するデータソースの許可リストに登録されている。
HTTP リクエスト
POST https://cloudsearch.googleapis.com/v1/indexing/{item.name=datasources/*/items/*}:index
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ | |
---|---|
item.name |
アイテムの名前。形式: datasources/{sourceId}/items/{itemId} これは必須項目です。最大長は 1,536 文字です。 |
リクエスト本文
リクエストの本文には、次の構造のデータが含まれます。
JSON 表現 |
---|
{ "item": { "name": string, "acl": { "inheritAclFrom": string, "aclInheritanceType": enum ( |
フィールド | |
---|---|
item.acl |
このアイテムのアクセス制御リスト。 |
item.metadata |
メタデータ情報。 |
item.structuredData |
データソースのスキーマに登録されているオブジェクト定義に準拠する必要があるアイテムの構造化データ。 |
item.content |
インデックスに登録され、テキストを検索可能にするアイテム コンテンツ。 |
item.version |
必須。インデックス システムは、データソースのバージョンをバイト文字列として格納し、語彙の順序付けを使用して、インデックス内の Item のバージョンとキューに格納された Item のバージョンを比較します。 キューに追加されたアイテムのバージョンが、現在インデックスに登録されているアイテムのバージョン以下の値である場合、Cloud Search Indexing は、それらのアイテムをインデックス登録または削除しません。このフィールドの最大長は 1,024 バイトです。 アイテムのバージョンが削除プロセスに与える影響について詳しくは、手動で削除した後の変更内容を処理するをご覧ください。 Base64 でエンコードされた文字列。 |
item.status |
アイテムのステータス。出力専用フィールド。 |
item.queue |
このアイテムが属するキューに追加します。最大で 100 文字です。 |
item.payload |
このアイテムに保存できる追加の状態コネクタです。最大長は 10,000 バイトです。 Base64 でエンコードされた文字列。 |
item.itemType |
このアイテムのタイプ。 |
connectorName |
この呼び出しを行うコネクタの名前。 形式: datasources/{sourceId}/connectors/{ID} |
mode |
必須。このリクエストの RequestMode。 |
debugOptions |
一般的なデバッグ オプション。 |
indexItemOptions |
|
レスポンスの本文
成功した場合、レスポンスの本文には Operation
のインスタンスが含まれます。
認証スコープ
次の OAuth スコープのいずれかが必要です。
https://www.googleapis.com/auth/cloud_search.indexing
https://www.googleapis.com/auth/cloud_search
詳細については、承認ガイドをご覧ください。
IndexItemOptions
JSON 表現 |
---|
{ "allowUnknownGsuitePrincipals": boolean } |
フィールド | |
---|---|
allowUnknownGsuitePrincipals |
存在しない Google Workspace プリンシパルや削除された Google Workspace プリンシパルをインデックス リクエストで許可するかどうかを指定します。 |