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

來源的簡稱或別名。這個值會用於比對「source」運算子。例如，如果簡稱為 <value>，source:<value> 等查詢只會傳回這個來源的結果。所有資料來源的值皆不得重複。這個值只能包含英數字元 (a-zA-Z0-9)。這個值不得以「google」開頭，而且不得為下列任一值：mail、gmail、docs、drive、群組、網站、日曆、Hangouts、gplus、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

詳情請參閱授權指南。