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

Tên của Mặt hàng. Định dạng: datasources/{sourceId}/items/{itemId}

Đây là trường bắt buộc. Độ dài tối đa là 1536 ký tự.

object (ItemAcl)

Danh sách kiểm soát quyền truy cập cho mục này.

object (ItemMetadata)

Thông tin siêu dữ liệu.

object (ItemStructuredData)

Dữ liệu có cấu trúc cho mục phải tuân thủ định nghĩa đối tượng đã đăng ký trong giản đồ cho nguồn dữ liệu.

object (ItemContent)

Nội dung của mục sẽ được lập chỉ mục và giúp người dùng có thể tìm kiếm được văn bản.

string (bytes format)

Bắt buộc. Hệ thống lập chỉ mục lưu trữ phiên bản từ nguồn dữ liệu dưới dạng chuỗi byte và so sánh phiên bản của Mục trong chỉ mục với phiên bản của Mục trong hàng đợi bằng cách sử dụng thứ tự từ vựng.

Tính năng Lập chỉ mục Cloud Search sẽ không lập chỉ mục hoặc xoá bất kỳ mục nào trong hàng đợi có giá trị phiên bản thấp hơn hoặc bằng phiên bản của mục hiện đã được lập chỉ mục. Độ dài tối đa cho trường này là 1024 byte.

Để biết thông tin về mức độ ảnh hưởng của phiên bản mặt hàng đến quá trình xoá, hãy tham khảo bài viết Xử lý các bản sửa đổi sau khi xoá theo cách thủ công.

Chuỗi được mã hoá base64.

object (ItemStatus)

Trạng thái của mục. Trường chỉ có đầu ra.

string

Hàng đợi chứa mục này. Độ dài tối đa là 100 ký tự.

string (bytes format)

Trình kết nối trạng thái bổ sung có thể lưu trữ cho mục này. Độ dài tối đa là 10000 byte.

Chuỗi được mã hoá base64.

enum (Item.ItemType)

Loại cho mục này.

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

string

Tên của mục sẽ kế thừa Danh sách quyền truy cập (ACL). Lưu ý: Tính năng kế thừa ACL chỉ cung cấp quyền truy cập vào các mục con và không xác định mối quan hệ có cấu trúc, cũng như không cung cấp các cách thuận tiện để xoá nhiều nhóm mục. Việc xoá mục cha mẹ trong danh sách kiểm soát quyền truy cập (ACL) khỏi chỉ mục chỉ làm thay đổi quyền truy cập của các mục con tham chiếu đến mục mẹ trong trường inheritAclFrom. Mục này vẫn còn trong chỉ mục nhưng có thể không xuất hiện trong kết quả tìm kiếm. Ngược lại, thao tác xoá một mục vùng chứa cũng sẽ xoá tất cả các mục tham chiếu đến vùng chứa đó thông qua trường containerName. Độ dài tối đa cho trường này là 1536 ký tự.

enum (ItemAcl.AclInheritanceType)

Đặt loại quy tắc truy cập sẽ áp dụng khi một mục kế thừa Danh sách kiểm soát quyền truy cập (ACL) từ cấp độ gốc. Trường này phải luôn được thiết lập song song với trường inheritAclFrom. Ngoài ra, khi bạn đặt trường inheritAclFrom, bạn phải đặt trường này thành AclInheritanceType hợp lệ.

object (Principal)

Danh sách người quản lý được phép xem mục này trong kết quả tìm kiếm. Không bắt buộc nếu kế thừa quyền từ một mục khác hoặc nếu mục đó không định hiển thị, chẳng hạn như virtual containers. Số lượng phần tử tối đa là 1000.

object (Principal)

Danh sách những người dùng chính bị từ chối quyền truy cập vào mục đó trong kết quả tìm kiếm một cách rõ ràng. Mặc dù các đối tượng chính bị từ chối quyền truy cập theo mặc định, hãy sử dụng trình đọc bị từ chối để xử lý các trường hợp ngoại lệ và ghi đè danh sách những người đọc được phép. Số lượng phần tử tối đa là 100.

object (Principal)

Không bắt buộc. Danh sách chủ sở hữu của mục. Trường này không liên quan đến quyền truy cập tài liệu. Tuy nhiên, tính năng này giúp tăng thứ hạng một chút cho những mặt hàng mà người dùng truy vấn là chủ sở hữu. Số lượng phần tử tối đa là 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)

Người dùng chính này là một người dùng, nhóm hoặc miền của Google Workspace.

string

Người dùng chính này là một người dùng được xác định bằng danh tính bên ngoài. Trường tên phải chỉ định tên tài nguyên người dùng ở định dạng sau: identitysources/{sourceId}/users/{ID}

string

Người này là một nhóm được xác định bằng danh tính bên ngoài. Trường tên phải chỉ định tên tài nguyên nhóm ở định dạng sau: 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

Tiêu đề của mặt hàng. Nếu được cung cấp, đây sẽ là tiêu đề hiển thị của kết quả query.search. Độ dài tối đa là 2048 ký tự.

string

Đường liên kết đến kho lưu trữ nguồn phân phát dữ liệu. Kết quả tìm kiếm sẽ áp dụng liên kết này cho tiêu đề. Khoảng trắng hoặc ký tự đặc biệt có thể khiến đường liên kết kết quả Cloud Seach kích hoạt thông báo chuyển hướng; để tránh điều này, hãy mã hoá URL. Độ dài tối đa là 2048 ký tự.

string

Tên vùng chứa cho mục này. Việc xoá mặt hàng trong vùng chứa sẽ dẫn đến việc mặt hàng này tự động bị xoá. Lưu ý: Danh sách kiểm soát quyền truy cập (ACL) không được kế thừa từ mục vùng chứa. Để cung cấp tính năng kế thừa ACL cho một mục, hãy sử dụng trường inheritAclFrom. Độ dài tối đa là 1536 ký tự.

string

Loại của mục. Tên này phải tương ứng với tên của định nghĩa đối tượng trong giản đồ đã đăng ký cho nguồn dữ liệu. Ví dụ: nếu giản đồ cho nguồn dữ liệu chứa định nghĩa đối tượng có tên "tài liệu", thì yêu cầu lập chỉ mục mục cho các đối tượng thuộc loại đó phải đặt objectType thành "tài liệu". Độ dài tối đa là 256 ký tự.

string (Timestamp format)

Thời điểm mục được tạo trong kho lưu trữ nguồn.

Dấu thời gian theo múi giờ "Zulu" RFC3339 (giờ UTC) với độ phân giải nano giây và lên đến 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".

string (Timestamp format)

Thời điểm mục được sửa đổi lần gần đây nhất trong kho lưu trữ nguồn.

Dấu thời gian theo múi giờ "Zulu" RFC3339 (giờ UTC) với độ phân giải nano giây và lên đến 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".

object (Interaction)

Danh sách các hoạt động tương tác cho mặt hàng. Các hoạt động tương tác được dùng để cải thiện chất lượng query.search, nhưng không hiển thị với người dùng cuối. Số lượng phần tử tối đa là 1000.

string

Mã ngôn ngữ BCP-47 của mặt hàng, chẳng hạn như "en-US" hoặc "sr-Latn". Để biết thêm thông tin, hãy truy cập vào http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. Độ dài tối đa là 32 ký tự.

string

Loại mime ban đầu của ItemContent.content trong kho lưu trữ nguồn. Độ dài tối đa là 256 ký tự.

object (SearchQualityMetadata)

Siêu dữ liệu bổ sung về chất lượng tìm kiếm của mặt hàng

string

Từ khoá hoặc cụm từ bổ sung phù hợp với mục. Được sử dụng nội bộ cho nội dung do người dùng tạo. Số lượng phần tử tối đa là 100. Độ dài tối đa là 8192 ký tự.

string

Giá trị băm do phương thức gọi API cung cấp. Bạn có thể sử dụng thuộc tính này với phương thức items.push để tính trạng thái đã sửa đổi. Độ dài tối đa là 2048 ký tự.

object (ContextAttribute)

Một tập hợp các thuộc tính có tên liên kết với mặt hàng. Dữ liệu này có thể dùng để tác động đến thứ hạng của mặt hàng dựa trên bối cảnh trong yêu cầu. Số lượng phần tử tối đa là 10.

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

enum (Interaction.InteractionType)

object (Principal)

Người dùng đã thực hiện hành động trên mục.

string (Timestamp format)

Thời điểm người dùng thực hiện hành động trên mục. Nếu một người dùng có nhiều hành động cùng loại thì chỉ hành động gần đây nhất mới được ghi lại.

Dấu thời gian theo múi giờ "Zulu" RFC3339 (giờ UTC) với độ phân giải nano giây và lên đến 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".

{
  "quality": number
}

number

Chỉ báo chất lượng của mục, dùng để ảnh hưởng đến chất lượng tìm kiếm. giá trị phải nằm trong khoảng từ 0.0 (chất lượng thấp nhất) đến 1.0 (chất lượng cao nhất). Giá trị mặc định là 0,0.

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

string

Tên thuộc tính. Không được để trống trường này. Độ dài tối đa là 32 ký tự. Tên phải bắt đầu bằng một chữ cái và chỉ được chứa chữ cái (A-Z, a-z) hoặc chữ số (0-9). Tên sẽ được chuẩn hoá (viết thường) trước khi được so khớp.

string

Giá trị văn bản của thuộc tính. Số lượng phần tử tối đa là 10. Độ dài tối đa của một phần tử trong mảng là 32 ký tự. Giá trị sẽ được chuẩn hoá (chữ thường) trước khi khớp.

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

object (StructuredDataObject)

Đối tượng dữ liệu có cấu trúc phải tuân thủ định nghĩa đối tượng đã đăng ký trong giản đồ cho nguồn dữ liệu.

string

Giá trị băm do phương thức gọi API cung cấp. Bạn có thể sử dụng thuộc tính này với phương thức items.push để tính trạng thái đã sửa đổi. Độ dài tối đa là 2048 ký tự.

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

object (NamedProperty)

Các thuộc tính của đối tượng. Số lượng phần tử tối đa là 1000.

{
  "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

Tên của cơ sở lưu trú. Tên này phải tương ứng với tên của thuộc tính đã đăng ký để định nghĩa đối tượng trong giản đồ. Độ dài tối đa cho phép đối với thuộc tính này là 256 ký tự.

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)

Dấu thời gian theo múi giờ "Zulu" RFC3339 (giờ UTC) với độ phân giải nano giây và lên đến 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".

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

object (StructuredDataObject)

{
  "values": [
    string
  ]
}

string

Độ dài tối đa cho phép đối với các giá trị chuỗi là 32 ký tự.

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

object (Date)

{
  "values": [
    string
  ]
}

string

Độ dài tối đa cho phép đối với các giá trị văn bản là 2.048 ký tự.

{
  "values": [
    string
  ]
}

string

Độ dài tối đa cho phép đối với các giá trị html là 2.048 ký tự.

{
  "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

Thông tin băm do ứng dụng API tính toán và cung cấp cho nội dung. Có thể sử dụng với phương thức items.push để tính trạng thái đã sửa đổi. Độ dài tối đa là 2048 ký tự.

string (bytes format)

Nội dung được cung cấp cùng dòng trong phương thức cập nhật. Độ dài tối đa là 102400 byte (100 KiB).

Chuỗi được mã hoá base64.

object (UploadItemRef)

Tải mã tham chiếu của nội dung đã tải lên trước đây lên thông qua phương thức ghi.

{
  "name": string
}

string

Tên của tham chiếu nội dung. Độ dài tối đa là 2048 ký tự.

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

enum (ItemStatus.Code)

Mã trạng thái.

object (ProcessingError)

Thông tin chi tiết về lỗi trong trường hợp mặt hàng ở trạng thái LỖI.

object (RepositoryError)

Lỗi kho lưu trữ do trình kết nối báo cáo.

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

enum (ProcessingErrorCode)

Mã lỗi cho biết bản chất của lỗi.

string

Nội dung mô tả về lỗi.

object (FieldViolation)

Trong trường hợp các trường mặt hàng không hợp lệ, trường này chứa thông tin chi tiết về lỗi xác thực.

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

string

Đường dẫn của trường có lỗi vi phạm.

string

Nội dung mô tả về lỗi.

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

enum (RepositoryError.Type)

Loại lỗi.

integer

Mã lỗi. Khớp với định nghĩa mã trạng thái HTTP.

string

Thông báo mô tả lỗi. Thông báo này có thể dài tối đa 8.192 ký tự.