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)

必須。インデックス システムは、データソースのバージョンをバイト文字列として格納し、語彙の順序付けを使用して、インデックス内の Item のバージョンとキューに格納された Item のバージョンを比較します。

キューに追加されたアイテムのバージョンが、現在インデックスに登録されているアイテムのバージョン以下の値である場合、Cloud Search Indexing は、それらのアイテムをインデックス登録または削除しません。このフィールドの最大長は 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 を使用して識別されたユーザーです。name フィールドにユーザー リソース名を次の形式で指定する必要があります: identitysources/{sourceId}/users/{ID}

string

このプリンシパルは、外部 ID を使用して識別されるグループです。name フィールドにグループ リソース名を次の形式で指定する必要があります: identitysources/{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 Seach の検索結果リンクによってリダイレクト通知がトリガーされることがあります。回避するには、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)

ユーザーがアイテムを操作した時刻。1 人のユーザーに同じタイプの操作が複数ある場合は、直近の操作のみが記録されます。

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)

update メソッド内でインラインで提供されるコンテンツ。最大長は 102,400 バイト（100 KiB）です。

Base64 でエンコードされた文字列。

object (UploadItemRef)

以前にアップロードしたコンテンツの参照 ID を write メソッドを使用してアップロードします。

{
  "name": string
}

string

コンテンツ参照の名前。最大長は 2,048 文字です。

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

enum (ItemStatus.Code)

ステータス コード。

object (ProcessingError)

アイテムのステータスが ERROR の場合のエラーの詳細。

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 文字です。