Method: settings.datasources.update

تُحدّث مصدر بيانات.

ملاحظة: تتطلّب واجهة برمجة التطبيقات هذه حساب مشرف ليتم تنفيذها.

طلب 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

في حال الضبط على "true"، يتم ضبط مصدر البيانات على وضع القراءة فقط. في وضع القراءة فقط، ترفض 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

لمزيد من المعلومات، راجِع دليل التفويض.