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

في حال ضبطها على "صحيح"، يتم ضبط مصدر البيانات على وضع القراءة فقط. في وضع "القراءة فقط"، ترفض واجهة برمجة التطبيقات Indexing API أي طلبات للفهرسة أو حذف العناصر في هذا المصدر. لا يؤدي تفعيل وضع القراءة فقط إلى إيقاف معالجة البيانات المقبولة سابقًا.
source.itemsVisibility[]

object (GSuitePrincipal)

يحدّ هذا الحقل من مستوى الوصول إلى العناصر على مستوى مصدر البيانات. تقتصر العناصر ضمن مصدر البيانات على اتحاد المستخدمين والمجموعات المضمّنة في هذا الحقل. يُرجى العِلم أنّ هذا الإجراء لا يضمن الوصول إلى عنصر معيّن، لأنّ المستخدمين يحتاجون إلى أذونات قائمة التحكّم في الوصول إلى العناصر المضمّنة. يضمن ذلك الوصول إلى مستوى عالٍ في مصدر البيانات بالكامل، وعدم مشاركة العناصر الفردية خارج نطاق إذن الوصول هذا.
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

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