Method: indexing.datasources.updateSchema
コレクションでコンテンツを整理
必要に応じて、コンテンツの保存と分類を行います。
データソースのスキーマを更新します。この方法では、スキーマの増分更新は行われません。代わりに、このメソッドはスキーマ全体を上書きしてスキーマを更新します。
注: この API を実行するには、管理者またはサービス アカウントが必要です。
HTTP リクエスト
PUT https://cloudsearch.googleapis.com/v1/indexing/{name=datasources/*}/schema
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ |
name |
string
スキーマを更新するデータソースの名前。形式: datasources/{sourceId}
|
リクエストの本文
リクエストの本文には、次の構造のデータが含まれます。
JSON 表現 |
{
"validateOnly": boolean,
"schema": {
object (Schema )
},
"debugOptions": {
object (DebugOptions )
}
} |
フィールド |
validateOnly |
boolean
true の場合、スキーマの有効性がチェックされますが、有効であってもデータソースには登録されません。
|
schema |
object (Schema )
ソースの新しいスキーマ。
|
debugOptions |
object (DebugOptions )
一般的なデバッグ オプション。
|
レスポンスの本文
成功した場合、レスポンスの本文には 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: indexing.datasources.updateSchema\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nUpdates the schema of a data source. This method does not perform incremental updates to the schema. Instead, this method updates the schema by overwriting the entire schema.\n\n**Note:** This API requires an admin or service account to execute.\n\n### HTTP request\n\n`PUT https://cloudsearch.googleapis.com/v1/indexing/{name=datasources/*}/schema`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|---------------------------------------------------------------------------------------|\n| `name` | `string` The name of the data source to update Schema. Format: datasources/{sourceId} |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"validateOnly\": boolean, \"schema\": { object (/workspace/cloud-search/docs/reference/rest/v1/Schema) }, \"debugOptions\": { object (/workspace/cloud-search/docs/reference/rest/v1/DebugOptions) } } ``` |\n\n| Fields ||\n|----------------|-----------------------------------------------------------------------------------------------------------------------------|\n| `validateOnly` | `boolean` If true, the schema will be checked for validity, but will not be registered with the data source, even if valid. |\n| `schema` | `object (`[Schema](/workspace/cloud-search/docs/reference/rest/v1/Schema)`)` The new schema for the source. |\n| `debugOptions` | `object (`[DebugOptions](/workspace/cloud-search/docs/reference/rest/v1/DebugOptions)`)` Common debug options. |\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)."]]