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 ที่จะพุชเข้าไปในคิวการจัดทำดัชนี

รูปแบบ: แหล่งข้อมูล/{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)

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

string

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

string

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

string

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

string (bytes format)

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

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

string

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

object (RepositoryError)

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

string

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

รูปแบบ: แหล่งข้อมูล/{sourceId}/เครื่องมือเชื่อมต่อ/{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 ที่จะพุชเข้าไปในคิวการจัดทำดัชนี

รูปแบบ: แหล่งข้อมูล/{sourceId}/items/{ID}

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

enum (PushItem.Type)

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

string

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

string

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

string

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

string (bytes format)

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

สตริงที่เข้ารหัสฐาน 64
queue

string

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

object (RepositoryError)

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

PushItem.Type

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

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