Method: indexing.datasources.items.push

พุชรายการลงในคิวเพื่อทำการสำรวจและการอัปเดตในภายหลัง

API นี้ต้องใช้บัญชีผู้ดูแลระบบหรือบัญชีบริการในการดําเนินการ บัญชีบริการที่ใช้คือบัญชีที่อยู่ในรายการที่อนุญาตในแหล่งข้อมูลที่เกี่ยวข้อง

คำขอ HTTP

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

URL ใช้ไวยากรณ์การแปลง gRPC

พารามิเตอร์เส้นทาง

พารามิเตอร์
item.name

string

ชื่อของ item ที่จะส่งไปยังคิวการจัดทําดัชนี

รูปแบบ: datasources/{sourceId}/items/{ID}

นี่เป็นฟิลด์ที่ต้องระบุ ความยาวสูงสุดคือ 1,536 อักขระ

เนื้อหาของคำขอ

เนื้อความของคำขอมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง 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)
  }
}
ช่อง
item.type

enum (PushItem.Type)

ประเภทของการดำเนินการ Push ที่กําหนดลักษณะการทํางานของ Push
item.metadataHash

string

แฮชข้อมูลเมตาของรายการตามพื้นที่เก็บข้อมูล หากระบุไว้ ระบบจะใช้ข้อมูลนี้เพื่อกำหนดวิธีแก้ไขสถานะของรายการนี้ การตั้งค่าช่องนี้และช่อง type จะทำให้เกิดข้อผิดพลาดเกี่ยวกับอาร์กิวเมนต์ ความยาวสูงสุดคือ 2,048 อักขระ
item.structuredDataHash

string

แฮช Structured Data ของรายการตามพื้นที่เก็บข้อมูล หากระบุไว้ ระบบจะใช้ข้อมูลนี้เพื่อกำหนดวิธีแก้ไขสถานะของรายการนี้ การตั้งค่าช่องนี้และช่อง type จะทำให้เกิดข้อผิดพลาดเกี่ยวกับอาร์กิวเมนต์ ความยาวสูงสุดคือ 2,048 อักขระ
item.contentHash

string

แฮชเนื้อหาของรายการตามที่เก็บ หากระบุไว้ ระบบจะใช้ข้อมูลนี้เพื่อกำหนดวิธีแก้ไขสถานะของรายการนี้ การตั้งค่าช่องนี้และช่อง type จะทำให้เกิดข้อผิดพลาดเกี่ยวกับอาร์กิวเมนต์ ความยาวสูงสุดคือ 2,048 อักขระ
item.payload

string (bytes format)

ให้ข้อมูลเพิ่มเติมเกี่ยวกับสถานะเอกสารสำหรับตัวเชื่อมต่อ เช่น รหัสที่เก็บข้อมูลอื่นและข้อมูลเมตาอื่นๆ ความยาวสูงสุดคือ 8192 ไบต์

สตริงที่เข้ารหัส Base64
item.queue

string

คิวของรายการนี้ ระบบจะเลือกคิว default หากไม่ได้ระบุฟิลด์นี้ ความยาวสูงสุด 512 อักขระ
item.repositoryError

object (RepositoryError)

ป้อนข้อมูลในช่องนี้เพื่อจัดเก็บรายละเอียดข้อผิดพลาดของเครื่องมือเชื่อมต่อหรือที่เก็บข้อมูล ข้อมูลนี้จะแสดงในคอนโซลผู้ดูแลระบบ ช่องนี้จะสร้างขึ้นเมื่อ type เป็น REPOSITORY_ERROR เท่านั้น
connectorName

string

ชื่อของเครื่องมือเชื่อมต่อที่เรียกใช้การดําเนินการนี้

รูปแบบ: datasources/{sourceId}/connectors/{ID}
debugOptions

object (DebugOptions)

ตัวเลือกการแก้ไขข้อบกพร่องทั่วไป

เนื้อหาการตอบกลับ

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ Item

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

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

ดูข้อมูลเพิ่มเติมได้ที่คู่มือการให้สิทธิ์

PushItem

แสดงถึงรายการที่จะส่งไปยังคิวการจัดทําดัชนี

การแสดง JSON 
{
  "name": string,
  "type": enum (PushItem.Type),
  "metadataHash": string,
  "structuredDataHash": string,
  "contentHash": string,
  "payload": string,
  "queue": string,
  "repositoryError": {
    object (RepositoryError)
  }
}
ช่อง
name

string

ชื่อของ item ที่จะส่งไปยังคิวการจัดทําดัชนี

รูปแบบ: datasources/{sourceId}/items/{ID}

นี่เป็นฟิลด์ที่ต้องระบุ ความยาวสูงสุดคือ 1,536 อักขระ
type

enum (PushItem.Type)

ประเภทของการดำเนินการ Push ที่กําหนดลักษณะการทํางานของ Push
metadataHash

string

แฮชข้อมูลเมตาของรายการตามพื้นที่เก็บข้อมูล หากระบุไว้ ระบบจะใช้ข้อมูลนี้เพื่อกำหนดวิธีแก้ไขสถานะของรายการนี้ การตั้งค่าช่องนี้และช่อง type จะทำให้เกิดข้อผิดพลาดเกี่ยวกับอาร์กิวเมนต์ ความยาวสูงสุดคือ 2,048 อักขระ
structuredDataHash

string

แฮช Structured Data ของรายการตามพื้นที่เก็บข้อมูล หากระบุไว้ ระบบจะใช้ข้อมูลนี้เพื่อกำหนดวิธีแก้ไขสถานะของรายการนี้ การตั้งค่าช่องนี้และช่อง type จะทำให้เกิดข้อผิดพลาดเกี่ยวกับอาร์กิวเมนต์ ความยาวสูงสุดคือ 2,048 อักขระ
contentHash

string

แฮชเนื้อหาของรายการตามที่เก็บ หากระบุไว้ ระบบจะใช้ข้อมูลนี้เพื่อกำหนดวิธีแก้ไขสถานะของรายการนี้ การตั้งค่าช่องนี้และช่อง type จะทำให้เกิดข้อผิดพลาดเกี่ยวกับอาร์กิวเมนต์ ความยาวสูงสุดคือ 2,048 อักขระ
payload

string (bytes format)

ให้ข้อมูลเพิ่มเติมเกี่ยวกับสถานะเอกสารสำหรับตัวเชื่อมต่อ เช่น รหัสที่เก็บข้อมูลอื่นและข้อมูลเมตาอื่นๆ ความยาวสูงสุดคือ 8192 ไบต์

สตริงที่เข้ารหัส Base64
queue

string

คิวของรายการนี้ ระบบจะเลือกคิว default หากไม่ได้ระบุฟิลด์นี้ ความยาวสูงสุด 512 อักขระ
repositoryError

object (RepositoryError)

ป้อนข้อมูลในช่องนี้เพื่อจัดเก็บรายละเอียดข้อผิดพลาดของเครื่องมือเชื่อมต่อหรือที่เก็บข้อมูล ข้อมูลนี้จะแสดงในคอนโซลผู้ดูแลระบบ ช่องนี้จะสร้างขึ้นเมื่อ type เป็น REPOSITORY_ERROR เท่านั้น

PushItem.Type

ประเภทของการดำเนินการ Push ที่กําหนดลักษณะการทํางานของ Push

Enum
UNSPECIFIED ค่าเริ่มต้นคือ "ไม่ได้ระบุ" ระบุว่าการดำเนินการ Push ไม่ควรแก้ไข ItemStatus
MODIFIED บ่งบอกว่ามีการแก้ไขหรืออัปเดตเอกสารในรีโพซิทอรีนับตั้งแต่การเรียกใช้ update ก่อนหน้านี้ ซึ่งจะเปลี่ยนสถานะเป็นสถานะ MODIFIED สำหรับรายการที่มีอยู่ หากเรียกใช้กับรายการที่ไม่มีอยู่ สถานะจะเปลี่ยนเป็น NEW_ITEM
NOT_MODIFIED รายการในที่เก็บข้อมูลไม่มีการแก้ไขนับตั้งแต่การเรียกใช้การอัปเดตครั้งล่าสุด การดำเนินการ Push นี้จะตั้งค่าสถานะเป็นACCEPTED
REPOSITORY_ERROR เครื่องมือเชื่อมต่อพบข้อผิดพลาดเกี่ยวกับที่เก็บสำหรับรายการนี้ เปลี่ยนสถานะเป็นสถานะ REPOSITORY_ERROR ระบบจะยกเลิกการจองและกำหนดเวลาใหม่ในอนาคตโดยอิงตาม Exponential Backoff
REQUEUE ใช้การเรียกใช้ Push พร้อมคําสั่ง REQUEUE กับรายการที่จองไว้เท่านั้น การดำเนินการนี้จะยกเลิกการจองสินค้าและรีเซ็ตเวลาที่มีให้เป็นเวลาตามนาฬิกา