Method: settings.datasources.patch
コレクションでコンテンツを整理
必要に応じて、コンテンツの保存と分類を行います。
データソースを更新します。
注: この API を実行するには、管理者アカウントが必要です。
HTTP リクエスト
PATCH https://cloudsearch.googleapis.com/v1/settings/{source.name=datasources/*}
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ |
source.name |
string
データソース リソースの名前。形式: datasources/{sourceId}。 データソースの作成時には、この名前は無視されます。
|
クエリ パラメータ
パラメータ |
debugOptions |
object (DebugOptions )
一般的なデバッグ オプション。
|
updateMask |
string (FieldMask format)
settings.datasources.patch にのみ適用されます。
更新するフィールドを制御するマスクを更新します。フィールドパスの例: name 、displayName 。
updateMask が空でない場合、updateMask で指定されたフィールドのみが更新されます。
updateMask でフィールドを指定しても、ソースで値を指定しないと、そのフィールドはクリアされます。
updateMask が存在しない場合、空の場合、または値が * の場合、すべてのフィールドが更新されます。
|
リクエストの本文
リクエストの本文には DataSource
のインスタンスが含まれます。
レスポンスの本文
成功した場合、レスポンスの本文には 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
詳しくは、認可ガイドをご覧ください。
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンスにより使用許諾されます。コードサンプルは Apache 2.0 ライセンスにより使用許諾されます。詳しくは、Google Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2025-07-25 UTC。
[null,null,["最終更新日 2025-07-25 UTC。"],[],[],null,["# Method: settings.datasources.patch\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nUpdates a datasource.\n\n**Note:** This API requires an admin account to execute.\n\n### HTTP request\n\n`PATCH https://cloudsearch.googleapis.com/v1/settings/{source.name=datasources/*}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|---------------|-------------------------------------------------------------------------------------------------------------------------------|\n| `source.name` | `string` The name of the datasource resource. Format: datasources/{sourceId}. The name is ignored when creating a datasource. |\n\n### Query parameters\n\n| Parameters ||\n|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `debugOptions` | `object (`[DebugOptions](/workspace/cloud-search/docs/reference/rest/v1/DebugOptions)`)` Common debug options. |\n| `updateMask` | `string (`[FieldMask](https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask)` format)` Only applies to [`settings.datasources.patch`](https://developers.google.com/workspace/cloud-search/docs/reference/rest/v1/settings.datasources/patch). Update mask to control which fields to update. Example field paths: `name`, `displayName`. - If `updateMask` is non-empty, then only the fields specified in the `updateMask` are updated. - If you specify a field in the `updateMask`, but don't specify its value in the source, that field is cleared. - If the `updateMask` is not present or empty or has the value `*`, then all fields are updated. |\n\n### Request body\n\nThe request body contains an instance of [DataSource](/workspace/cloud-search/docs/reference/rest/v1/settings.datasources#DataSource).\n\n### Response body\n\nIf successful, the response body contains an instance of [Operation](/workspace/cloud-search/docs/reference/rest/v1/operations#Operation).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/cloud_search.settings.indexing`\n- `https://www.googleapis.com/auth/cloud_search.settings`\n- `https://www.googleapis.com/auth/cloud_search`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]