Method: settings.datasources.update

یک منبع داده را به روز می کند.

توجه: این API برای اجرا به یک حساب کاربری نیاز دارد.

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

پارامترها
source.name

string

نام منبع داده. قالب: منابع داده/{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» شروع شود و نمی‌تواند یکی از موارد زیر باشد: نامه، gmail، اسناد، درایو، گروه‌ها، سایت‌ها، تقویم، hangouts، gplus، keep، افراد، تیم‌ها. حداکثر طول آن 32 کاراکتر است.

source.indexingServiceAccounts[]

string

فهرست حساب‌های خدماتی که دسترسی نمایه‌سازی دارند.

source.disableServing

boolean

غیرفعال کردن ارائه نتایج جستجو یا کمک.

source.disableModifications

boolean

اگر درست باشد، منبع داده را روی حالت فقط خواندنی تنظیم می کند. در حالت فقط خواندنی، API Indexing هرگونه درخواست برای فهرست یا حذف موارد در این منبع را رد می کند. فعال کردن حالت فقط خواندنی، پردازش داده‌های پذیرفته شده قبلی را متوقف نمی‌کند.

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

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.