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> है, तो <value> जैसी क्वेरी सिर्फ़ इस सोर्स के लिए नतीजे देंगी. सभी डेटा सोर्स में वैल्यू यूनीक होनी चाहिए. मान में सिर्फ़ अक्षर और अंक (a-zA-Z0-9) होने चाहिए. मान 'google' से नहीं शुरू हो सकता साथ ही, यह इनमें से कोई भी नहीं हो सकता: मेल, Gmail, दस्तावेज़, ड्राइव, ग्रुप, साइटें, कैलेंडर, Hangouts, gplus, Keep, लोग, टीम. इसमें ज़्यादा से ज़्यादा 32 वर्ण हो सकते हैं.

source.indexingServiceAccounts[]

string

इंडेक्स करने का ऐक्सेस रखने वाले सेवा खातों की सूची.

source.disableServing

boolean

खोज या सहायक नतीजे दिखाना बंद करें.

source.disableModifications

boolean

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

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

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