Method: settings.datasources.update

किसी डेटा सोर्स को अपडेट करता है.

ध्यान दें: इस एपीआई का इस्तेमाल करने के लिए, एडमिन खाता होना ज़रूरी है.

एचटीटीपी अनुरोध

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

यूआरएल, gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.

पाथ के पैरामीटर

पैरामीटर
source.name

string

डेटा सोर्स के संसाधन का नाम. फ़ॉर्मैट: datasources/{sourceId}.

डेटा सोर्स बनाते समय नाम को अनदेखा कर दिया जाता है.

अनुरोध का मुख्य भाग

अनुरोध के मुख्य हिस्से में इस तरह का डेटा शामिल होता है:

जेएसओएन के काेड में दिखाना 
{
  "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> है, तो source:<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

सही होने पर, डेटा सोर्स को रीड-ओनली मोड पर सेट करता है. रीड-ओनली मोड में, इंडेक्स करने वाला एपीआई इस सोर्स में मौजूद आइटम को इंडेक्स करने या मिटाने के किसी भी अनुरोध को अस्वीकार कर देता है. रीड-ओनली मोड चालू करने से, पहले स्वीकार किए जा चुके डेटा की प्रोसेसिंग बंद नहीं होती.
source.itemsVisibility[]

object (GSuitePrincipal)

यह फ़ील्ड, डेटा सोर्स के लेवल पर आइटम के दिखने पर पाबंदी लगाता है. डेटा सोर्स में मौजूद आइटम, इस फ़ील्ड में शामिल उपयोगकर्ताओं और ग्रुप के ग्रुप तक सीमित हैं. ध्यान दें, इससे किसी खास आइटम का ऐक्सेस पक्का नहीं होता, क्योंकि उपयोगकर्ताओं के पास शामिल आइटम पर एसीएल अनुमतियां होनी चाहिए. इससे पूरे डेटा सोर्स का हाई लेवल ऐक्सेस पक्का हो जाता है. साथ ही, अलग-अलग आइटम इस विज़िबिलिटी के बाहर शेयर नहीं किए जाते.
source.returnThumbnailUrls

boolean

क्या उपयोगकर्ता, इस डेटा सोर्स में इंडेक्स किए गए आइटम के लिए, थंबनेल यूआरआई पाने का अनुरोध कर सकता है.
source.operationIds[]

string

इस स्कीमा के लिए, मौजूदा समय में चल रहे लॉन्ग रनिंग ऑपरेशन (एलआरओ) के आईडी.
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

ज़्यादा जानकारी के लिए, अनुमति देने से जुड़ी गाइड देखें.