Method: settings.datasources.update

อัปเดตแหล่งข้อมูล

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

คำขอ HTTP

PUT https://cloudsearch.googleapis.com/v1/settings/{source.name=datasources/*}

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

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

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

string

ชื่อของทรัพยากรแหล่งข้อมูล รูปแบบ: แหล่งข้อมูล/{sourceId}

ระบบจะไม่พิจารณาชื่อนี้เมื่อสร้างแหล่งข้อมูล

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

เนื้อหาของคำขอมีข้อมูลที่มีโครงสร้างต่อไปนี้

การแสดง JSON 
{
  "source": {
    "name": string,
    "displayName": string,
    "shortName": string,
    "indexingServiceAccounts": [
      string
    ],
    "disableServing": boolean,
    "disableModifications": boolean,
    "itemsVisibility": [
      {

        // Union field gsuite_principal can be only one of the following:
        "gsuiteUserEmail": string,
        "gsuiteGroupEmail": string,
        "gsuiteDomain": boolean
        // End of list of possible types for union field gsuite_principal.
      }
    ],
    "returnThumbnailUrls": boolean,
    "operationIds": [
      string
    ]
  },
  "debugOptions": {
    object (DebugOptions)
  },
  "updateMask": string
}
ช่อง
source.displayName

string

ต้องระบุ ชื่อที่แสดงของแหล่งข้อมูล ความยาวสูงสุดคือ 300 อักขระ
source.shortName

string

ชื่อย่อหรือชื่อแทนของแหล่งที่มา ระบบจะใช้ค่านี้เพื่อจับคู่ "แหล่งที่มา" ตัวอย่างเช่น ถ้าชื่อย่อคือ <value> การค้นหา เช่น <value> จะแสดงเฉพาะผลการค้นหาสำหรับแหล่งที่มานี้ ค่าในแหล่งข้อมูลทั้งหมดต้องไม่ซ้ำกัน ค่าต้องประกอบด้วยอักขระที่เป็นตัวอักษรและตัวเลขคละกันเท่านั้น (a-zA-Z0-9) ค่าต้องไม่ขึ้นต้นด้วย "google" และไม่สามารถเป็นรายการใดรายการหนึ่งต่อไปนี้: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, team โดยมีความยาวสูงสุด 32 อักขระ
source.indexingServiceAccounts[]

string

รายชื่อบัญชีบริการที่มีสิทธิ์เข้าถึงการจัดทำดัชนี
source.disableServing

boolean

ปิดใช้การแสดงผลการค้นหาหรือผลการค้นหาที่สนับสนุน
source.disableModifications

boolean

หากเป็น "จริง" ให้ตั้งค่าแหล่งข้อมูลเป็นโหมดอ่านอย่างเดียว ในโหมดอ่านอย่างเดียว Indexing API จะปฏิเสธคำขอใดๆ ในการจัดทำดัชนีหรือลบรายการในแหล่งข้อมูลนี้ การเปิดใช้โหมดอ่านอย่างเดียวจะไม่หยุดการประมวลผลข้อมูลที่ยอมรับก่อนหน้านี้
source.itemsVisibility[]

object (GSuitePrincipal)

ช่องนี้จำกัดระดับการเข้าถึงให้แสดงเฉพาะรายการในระดับแหล่งข้อมูล รายการภายในแหล่งข้อมูลจะจำกัดไว้เฉพาะการรวมกลุ่มของผู้ใช้และกลุ่มที่รวมอยู่ในช่องนี้ โปรดทราบว่าวิธีนี้ไม่ได้ช่วยยืนยันสิทธิ์เข้าถึงบางรายการ เนื่องจากผู้ใช้ต้องมีสิทธิ์ ACL ในรายการที่มีอยู่ วิธีนี้ช่วยให้มั่นใจได้ว่ามีการเข้าถึงระดับสูงในแหล่งข้อมูลทั้งหมด และไม่มีการแชร์แต่ละรายการภายนอกการเปิดเผยนี้
source.returnThumbnailUrls

boolean

ผู้ใช้สามารถขอดู URI ของภาพขนาดย่อสำหรับรายการที่ได้รับการจัดทำดัชนีในแหล่งข้อมูลนี้ได้
source.operationIds[]

string

รหัสของการดำเนินการที่ใช้เวลานาน (LRO) ที่กำลังใช้งานสำหรับสคีมานี้
debugOptions

object (DebugOptions)

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

string (FieldMask format)

ซึ่งมีผลกับ settings.datasources.patch เท่านั้น

อัปเดตมาสก์เพื่อควบคุมว่าจะอัปเดตช่องใดบ้าง เส้นทางช่องตัวอย่าง: name, displayName

  • หาก updateMask ไม่ว่างเปล่า ระบบจะอัปเดตเฉพาะช่องที่ระบุใน updateMask
  • หากคุณระบุช่องใน updateMask แต่ไม่ได้ระบุค่าในแหล่งที่มา ระบบจะล้างช่องนั้น
  • หาก 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

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