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

اسم مختصر أو اسم مستعار للمصدر. سيتم استخدام هذه القيمة لمطابقة "المصدر" . على سبيل المثال، إذا كان الاسم المختصر هو <value>، ستعرض طلبات البحث مثل <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 غير متوفّرة أو فارغة أو كانت قيمتها *، سيتم تعديل جميع الحقول.

نص الاستجابة

إذا كانت الاستجابة ناجحة، يحتوي نص الاستجابة على مثال 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

لمزيد من المعلومات، يُرجى الاطّلاع على دليل التفويض.