- คำขอ HTTP
- พารามิเตอร์เส้นทาง
- เนื้อความของคำขอ
- เนื้อหาการตอบกลับ
- ขอบเขตการให้สิทธิ์
- IndexItemOptions
- ลองใช้งาน
อัปเดต ACL, ข้อมูลเมตา และเนื้อหาของ Item ระบบจะแทรก Item หากยังไม่มี วิธีการนี้ไม่รองรับการอัปเดตบางส่วน ระบบจะล้างช่องที่ไม่มีค่าที่ระบุในดัชนี Cloud Search
API นี้ต้องใช้บัญชีผู้ดูแลระบบหรือบัญชีบริการในการดําเนินการ บัญชีบริการที่ใช้คือบัญชีที่อยู่ในรายการที่อนุญาตในแหล่งข้อมูลที่เกี่ยวข้อง
คำขอ HTTP
POST https://cloudsearch.googleapis.com/v1/indexing/{item.name=datasources/*/items/*}:index
URL ใช้ไวยากรณ์การแปลง gRPC
พารามิเตอร์เส้นทาง
| พารามิเตอร์ | |
|---|---|
| item.name | 
 ชื่อของสินค้า รูปแบบ: datasources/{sourceId}/items/{itemId} นี่เป็นฟิลด์ที่ต้องระบุ ความยาวสูงสุดคือ 1,536 อักขระ | 
เนื้อหาของคำขอ
เนื้อความของคำขอมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
| การแสดง JSON | 
|---|
| { "item": { "name": string, "acl": { "inheritAclFrom": string, "aclInheritanceType": enum ( | 
| ช่อง | |
|---|---|
| item.acl | 
 รายการควบคุมการเข้าถึงสำหรับรายการนี้ | 
| item.metadata | 
 ข้อมูลเมตา | 
| item.structuredData | 
 Structured Data สำหรับรายการที่ควรเป็นไปตามคำจำกัดความออบเจ็กต์ที่ลงทะเบียนในสคีมาสำหรับแหล่งข้อมูล | 
| item.content | 
 เนื้อหาของรายการที่จะจัดทำดัชนีและทำให้ข้อความค้นหาได้ | 
| item.version | 
 ต้องระบุ ระบบการจัดทําดัชนีจะจัดเก็บเวอร์ชันจากแหล่งข้อมูลเป็นสตริงไบต์ และเปรียบเทียบเวอร์ชันของรายการในดัชนีกับเวอร์ชันของรายการที่รอดำเนินการโดยใช้การจัดลําดับตามคําศัพท์ การจัดทําดัชนีของ Cloud Search จะไม่จัดทําดัชนีหรือลบรายการที่อยู่ในคิวซึ่งมีค่าเวอร์ชันน้อยกว่าหรือเท่ากับเวอร์ชันของรายการที่จัดทําดัชนีอยู่ในขณะนี้ ความยาวสูงสุดของช่องนี้คือ 1,024 ไบต์ ดูข้อมูลเกี่ยวกับผลกระทบของเวอร์ชันสินค้าต่อกระบวนการลบได้ที่จัดการการแก้ไขหลังจากการลบด้วยตนเอง สตริงที่เข้ารหัส Base64 | 
| item.status | 
 สถานะของสินค้า ช่องเอาต์พุตเท่านั้น | 
| item.queue | 
 คิวของรายการนี้ โดยมีความยาวสูงสุดได้ 100 อักขระ | 
| item.payload | 
 คุณสามารถจัดเก็บตัวเชื่อมต่อสถานะเพิ่มเติมสําหรับรายการนี้ได้ ความยาวสูงสุดคือ 10,000 ไบต์ สตริงที่เข้ารหัส Base64 | 
| item.itemType | 
 ประเภทของรายการนี้ | 
| connectorName | 
 ชื่อของเครื่องมือเชื่อมต่อที่เรียกใช้การดําเนินการนี้ รูปแบบ: datasources/{sourceId}/connectors/{id} | 
| mode | 
 ต้องระบุ RequestMode สำหรับคำขอนี้ | 
| debugOptions | 
 ตัวเลือกการแก้ไขข้อบกพร่องทั่วไป | 
| indexItemOptions | 
 | 
เนื้อหาการตอบกลับ
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ Operation
ขอบเขตการให้สิทธิ์
ต้องใช้ขอบเขต OAuth ต่อไปนี้
- https://www.googleapis.com/auth/cloud_search.indexing
- https://www.googleapis.com/auth/cloud_search
ดูข้อมูลเพิ่มเติมได้ที่คู่มือการให้สิทธิ์
IndexItemOptions
| การแสดง JSON | 
|---|
| { "allowUnknownGsuitePrincipals": boolean } | 
| ช่อง | |
|---|---|
| allowUnknownGsuitePrincipals | 
 ระบุว่าคำขอจัดทำดัชนีควรอนุญาตผู้ใช้หลักของ Google Workspace ที่ไม่มีอยู่หรือถูกลบไปแล้วหรือไม่ |