Method: settings.datasources.update

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

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

คำขอ HTTP

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

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

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

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

string

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

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

string

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

boolean

ปิดใช้การแสดงผลการค้นหาหรือผลการช่วย
source.disableModifications

boolean

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

object (GSuitePrincipal)

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

boolean

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

string

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

object (DebugOptions)

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

string (FieldMask format)

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

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

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

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