Method: settings.datasources.update

更新資料來源。

注意：這個 API 需要管理員帳戶才能執行。

HTTP 要求

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、Google+、Keep、使用者、團隊。長度上限為 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) ID。
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

詳情請參閱授權指南。