อัปเดตแหล่งข้อมูล
หมายเหตุ: API นี้ต้องใช้บัญชีผู้ดูแลระบบจึงจะดำเนินการได้
คำขอ HTTP
PUT https://cloudsearch.googleapis.com/v1/settings/{source.name=datasources/*}
URL ใช้ไวยากรณ์การแปลง gRPC
พารามิเตอร์เส้นทาง
พารามิเตอร์ | |
---|---|
source.name |
ชื่อของทรัพยากรแหล่งข้อมูล รูปแบบ: datasources/{sourceId} ระบบจะไม่สนใจชื่อนี้เมื่อสร้างแหล่งข้อมูล |
เนื้อหาของคำขอ
เนื้อหาของคำขอมีข้อมูลที่มีโครงสร้างต่อไปนี้
การแสดง JSON |
---|
{ "source": { "name": string, "displayName": string, "shortName": string, "indexingServiceAccounts": [ string ], "disableServing": boolean, "disableModifications": boolean, "itemsVisibility": [ { // Union field |
ช่อง | |
---|---|
source.displayName |
ต้องระบุ ชื่อที่แสดงของแหล่งข้อมูล ความยาวสูงสุดคือ 300 อักขระ |
source.shortName |
ชื่อย่อหรือชื่อแทนของแหล่งที่มา ระบบจะใช้ค่านี้เพื่อจับคู่โอเปอเรเตอร์ "source" ตัวอย่างเช่น ถ้าชื่อย่อคือ <value> การค้นหาอย่าง source:<value> จะแสดงผลลัพธ์สำหรับแหล่งที่มานี้เท่านั้น ค่าในแหล่งข้อมูลทั้งหมดต้องไม่ซ้ำกัน ค่าต้องมีเฉพาะอักขระที่เป็นตัวอักษรและตัวเลขคละกัน (a-zA-Z0-9) เท่านั้น ค่าต้องไม่ขึ้นต้นด้วย "google" และไม่สามารถเป็นอย่างใดอย่างหนึ่งต่อไปนี้: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, Teams ความยาวสูงสุด 32 อักขระ |
source.indexingServiceAccounts[] |
รายการบัญชีบริการที่มีสิทธิ์เข้าถึงการจัดทำดัชนี |
source.disableServing |
ปิดใช้การแสดงผลลัพธ์การค้นหาหรือผลการค้นหาความช่วยเหลือ |
source.disableModifications |
หากเป็นจริง ให้ตั้งค่าแหล่งข้อมูลเป็นโหมดอ่านอย่างเดียว ในโหมดอ่านอย่างเดียว Indexing API จะปฏิเสธคำขอจัดทำดัชนีหรือลบรายการในแหล่งที่มานี้ การเปิดใช้โหมดอ่านอย่างเดียวจะไม่หยุดการประมวลผลข้อมูลที่ยอมรับก่อนหน้านี้ |
source.itemsVisibility[] |
ช่องนี้จำกัดระดับการเข้าถึงเฉพาะรายการในระดับแหล่งข้อมูล รายการภายในแหล่งข้อมูลจะจำกัดไว้เพียงสหภาพของผู้ใช้และกลุ่มที่อยู่ในช่องนี้ โปรดทราบว่า วิธีนี้ไม่ได้ประกันการเข้าถึงรายการที่เฉพาะเจาะจง เนื่องจากผู้ใช้ต้องมีสิทธิ์ ACL สำหรับรายการที่มีอยู่ การทำเช่นนี้ช่วยให้มั่นใจได้ว่าแหล่งข้อมูลทั้งหมดจะมีสิทธิ์การเข้าถึงระดับสูง และไม่มีการแชร์แต่ละรายการภายนอกการเปิดเผยนี้ |
source.returnThumbnailUrls |
ผู้ใช้ส่งคำขอรับ URI ภาพขนาดย่อสำหรับรายการที่จัดทำดัชนีในแหล่งข้อมูลนี้ได้หรือไม่ |
source.operationIds[] |
รหัสของการดำเนินการที่ใช้เวลานาน (LRO) ที่ทำงานอยู่สำหรับสคีมานี้ |
debugOptions |
ตัวเลือกการแก้ปัญหาทั่วไป |
updateMask |
ใช้เฉพาะกับ อัปเดตมาสก์เพื่อควบคุมช่องที่จะอัปเดต ตัวอย่างเส้นทางฟิลด์:
|
เนื้อหาการตอบกลับ
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ Operation
ขอบเขตการให้สิทธิ์
ต้องมีขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้
https://www.googleapis.com/auth/cloud_search.settings.indexing
https://www.googleapis.com/auth/cloud_search.settings
https://www.googleapis.com/auth/cloud_search
โปรดดูข้อมูลเพิ่มเติมที่คู่มือการให้สิทธิ์