Method: indexing.datasources.items.push

Đẩy một mục vào hàng đợi để thăm dò ý kiến và cập nhật sau.

API này yêu cầu tài khoản quản trị hoặc tài khoản dịch vụ để thực thi. Tài khoản dịch vụ được sử dụng là tài khoản được đưa vào danh sách trắng trong nguồn dữ liệu tương ứng.

Yêu cầu HTTP

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

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số đường dẫn

Thông số
item.name

string

Tên của item để đẩy vào hàng đợi lập chỉ mục.

Định dạng: datasources/{sourceId}/items/{ID}

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

Nội dung yêu cầu

Nội dung yêu cầu chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "item": {
    "name": string,
    "type": enum (PushItem.Type),
    "metadataHash": string,
    "structuredDataHash": string,
    "contentHash": string,
    "payload": string,
    "queue": string,
    "repositoryError": {
      "type": enum (RepositoryError.Type),
      "httpStatusCode": integer,
      "errorMessage": string
    }
  },
  "connectorName": string,
  "debugOptions": {
    object (DebugOptions)
  }
}
Trường
item.type

enum (PushItem.Type)

Loại thao tác đẩy xác định hành vi đẩy.
item.metadataHash

string

Hàm băm siêu dữ liệu của mục theo kho lưu trữ. Nếu được chỉ định, giá trị này sẽ được dùng để xác định cách sửa đổi trạng thái của mục này. Việc thiết lập trường này và trường type sẽ dẫn đến lỗi đối số. Độ dài tối đa là 2048 ký tự.
item.structuredDataHash

string

Hàm băm dữ liệu có cấu trúc của mặt hàng theo kho lưu trữ. Nếu được chỉ định, giá trị này sẽ được dùng để xác định cách sửa đổi trạng thái của mục này. Việc thiết lập trường này và trường type sẽ dẫn đến lỗi đối số. Độ dài tối đa là 2048 ký tự.
item.contentHash

string

Hàm băm nội dung của mục theo kho lưu trữ. Nếu được chỉ định, giá trị này sẽ được dùng để xác định cách sửa đổi trạng thái của mục này. Việc thiết lập trường này và trường type sẽ dẫn đến lỗi đối số. Độ dài tối đa là 2048 ký tự.
item.payload

string (bytes format)

Cung cấp thêm thông tin về trạng thái tài liệu cho trình kết nối, chẳng hạn như mã nhận dạng kho lưu trữ thay thế và siêu dữ liệu khác. Độ dài tối đa là 8192 byte.

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

string

Hàng đợi chứa mục này. Hàng đợi default sẽ được chọn nếu bạn không chỉ định trường này. Độ dài tối đa là 512 ký tự.
item.repositoryError

object (RepositoryError)

Điền vào trường này để lưu trữ thông tin chi tiết về lỗi của Trình kết nối hoặc kho lưu trữ. Thông tin này sẽ xuất hiện trong Bảng điều khiển dành cho quản trị viên. Bạn chỉ có thể điền trường này khi type là REPOSITORY_ERROR.
connectorName

string

Tên của trình kết nối thực hiện lệnh gọi này.

Định dạng: datasources/{sourceId}/connectors/{ID}
debugOptions

object (DebugOptions)

Các tuỳ chọn gỡ lỗi phổ biến.

Nội dung phản hồi

Nếu thành công, nội dung phản hồi sẽ chứa một phiên bản của Item.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem Hướng dẫn uỷ quyền.

PushItem

Biểu thị một mục sẽ được đẩy vào hàng đợi lập chỉ mục.

Biểu diễn dưới dạng JSON 
{
  "name": string,
  "type": enum (PushItem.Type),
  "metadataHash": string,
  "structuredDataHash": string,
  "contentHash": string,
  "payload": string,
  "queue": string,
  "repositoryError": {
    object (RepositoryError)
  }
}
Trường
name

string

Tên của item để đẩy vào hàng đợi lập chỉ mục.

Định dạng: datasources/{sourceId}/items/{ID}

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

enum (PushItem.Type)

Loại thao tác đẩy xác định hành vi đẩy.
metadataHash

string

Hàm băm siêu dữ liệu của mục theo kho lưu trữ. Nếu được chỉ định, giá trị này sẽ được dùng để xác định cách sửa đổi trạng thái của mục này. Việc thiết lập trường này và trường type sẽ dẫn đến lỗi đối số. Độ dài tối đa là 2048 ký tự.
structuredDataHash

string

Hàm băm dữ liệu có cấu trúc của mặt hàng theo kho lưu trữ. Nếu được chỉ định, giá trị này sẽ được dùng để xác định cách sửa đổi trạng thái của mục này. Việc thiết lập trường này và trường type sẽ dẫn đến lỗi đối số. Độ dài tối đa là 2048 ký tự.
contentHash

string

Hàm băm nội dung của mục theo kho lưu trữ. Nếu được chỉ định, giá trị này sẽ được dùng để xác định cách sửa đổi trạng thái của mục này. Việc thiết lập trường này và trường type sẽ dẫn đến lỗi đối số. Độ dài tối đa là 2048 ký tự.
payload

string (bytes format)

Cung cấp thêm thông tin về trạng thái tài liệu cho trình kết nối, chẳng hạn như mã nhận dạng kho lưu trữ thay thế và siêu dữ liệu khác. Độ dài tối đa là 8192 byte.

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

string

Hàng đợi chứa mục này. Hàng đợi default sẽ được chọn nếu bạn không chỉ định trường này. Độ dài tối đa là 512 ký tự.
repositoryError

object (RepositoryError)

Điền vào trường này để lưu trữ thông tin chi tiết về lỗi của Trình kết nối hoặc kho lưu trữ. Thông tin này sẽ xuất hiện trong Bảng điều khiển dành cho quản trị viên. Bạn chỉ có thể điền trường này khi type là REPOSITORY_ERROR.

PushItem.Type

Loại thao tác đẩy xác định hành vi đẩy.

Enum
UNSPECIFIED Giá trị mặc định là UNSPECIFIED. Chỉ định rằng thao tác đẩy không được sửa đổi ItemStatus
MODIFIED Cho biết tài liệu kho lưu trữ đã được sửa đổi hoặc cập nhật kể từ lệnh gọi update trước đó. Thao tác này sẽ thay đổi trạng thái thành trạng thái MODIFIED cho một mục hiện có. Nếu phương thức này được gọi trên một mục không tồn tại, trạng thái sẽ được thay đổi thành NEW_ITEM.
NOT_MODIFIED Mục trong kho lưu trữ chưa được sửa đổi kể từ lệnh gọi cập nhật gần đây nhất. Thao tác đẩy này sẽ đặt trạng thái thành ACCEPTED.
REPOSITORY_ERROR Trình kết nối đang gặp lỗi kho lưu trữ liên quan đến mục này. Thay đổi trạng thái thành trạng thái REPOSITORY_ERROR. Mục này sẽ bị huỷ đặt trước và được lên lịch lại vào một thời điểm trong tương lai do thời gian đợi luỹ thừa xác định.
REQUEUE Chỉ gọi lệnh đẩy bằng REQUEUE cho các mục đã được đặt trước. Thao tác này sẽ huỷ đặt trước mặt hàng và đặt lại thời gian có sẵn của mặt hàng thành thời gian theo đồng hồ treo tường.