Method: settings.datasources.update

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

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

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

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

यूआरएल में 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

सोर्स का छोटा नाम या कोई दूसरा नाम. इस वैल्यू का इस्तेमाल, 'सोर्स' ऑपरेटर से मैच करने के लिए किया जाएगा. उदाहरण के लिए, अगर छोटा नाम <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

क्या कोई उपयोगकर्ता, इस डेटा सोर्स में इंडेक्स किए गए आइटम के थंबनेल का यूआरआई पाने का अनुरोध कर सकता है.
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

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