REST Resource: settings.datasources
コレクションでコンテンツを整理
必要に応じて、コンテンツの保存と分類を行います。
リソース: DataSource
データソースは、インデックスに登録するアイテムの論理名前空間です。すべての項目はデータソースに属している必要があります。これは、アイテムを Cloud Search にインデックス登録する前の前提条件です。
JSON 表現 |
{
"name": string,
"displayName": string,
"shortName": string,
"indexingServiceAccounts": [
string
],
"disableServing": boolean,
"disableModifications": boolean,
"itemsVisibility": [
{
object (GSuitePrincipal )
}
],
"returnThumbnailUrls": boolean,
"operationIds": [
string
]
} |
フィールド |
name |
string
データソース リソースの名前。形式: datasources/{sourceId}。 データソースの作成時には、この名前は無視されます。
|
displayName |
string
必須。データソースの表示名。最大長は 300 文字です。
|
shortName |
string
ソースの略称またはエイリアス。この値は「source」演算子との一致に使用されます。たとえば、略称が <value> の場合、source:<value> などのクエリでは、このソースの結果のみが返されます。値は、すべてのデータソースで一意である必要があります。値には英数字(a-zA-Z0-9)のみを使用できます。値の先頭を「google」にすることはできません。また、mail、gmail、docs、drive、groups、sites、calendar、hangouts、gplus、keep、people、teams のいずれにもすることはできません。最大文字数は 32 文字です。
|
indexingServiceAccounts[] |
string
インデックスへのアクセス権を持つサービス アカウントのリスト。
|
disableServing |
boolean
検索結果やアシスト結果の配信を無効にします。
|
disableModifications |
boolean
true の場合、データソースを読み取り専用モードに設定します。読み取り専用モードでは、Indexing API は、このソース内のアイテムのインデックス登録または削除リクエストを拒否します。読み取り専用モードを有効にしても、以前に受け入れたデータの処理は停止されません。
|
itemsVisibility[] |
object (GSuitePrincipal )
このフィールドは、データソース レベルでアイテムの公開設定を制限します。データソース内のアイテムは、このフィールドに含まれるユーザーとグループの結合に制限されます。ただし、ユーザーが含まれるアイテムに対する ACL 権限を持っている必要があるため、特定のアイテムへのアクセスが保証されるわけではありません。これにより、データソース全体に対する高度なアクセスが確保され、個々のアイテムがこの可視性外に共有されることはありません。
|
returnThumbnailUrls |
boolean
ユーザーが、このデータソースにインデックス登録されているアイテムのサムネイル URI の取得をリクエストできますか。
|
operationIds[] |
string
このスキーマに対して現在実行中の長時間実行オペレーション(LRO)の ID。
|
メソッド |
|
データソースを作成します。 |
|
データソースを削除します。 |
|
データソースを取得します。 |
|
データソースを一覧表示します。 |
|
データソースを更新します。 |
|
データソースを更新します。 |
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンスにより使用許諾されます。コードサンプルは Apache 2.0 ライセンスにより使用許諾されます。詳しくは、Google Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2025-07-25 UTC。
[null,null,["最終更新日 2025-07-25 UTC。"],[],[],null,["# REST Resource: settings.datasources\n\n- [Resource: DataSource](#DataSource)\n - [JSON representation](#DataSource.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: DataSource\n--------------------\n\nDatasource is a logical namespace for items to be indexed. All items must belong to a datasource. This is the prerequisite before items can be indexed into Cloud Search.\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"displayName\": string, \"shortName\": string, \"indexingServiceAccounts\": [ string ], \"disableServing\": boolean, \"disableModifications\": boolean, \"itemsVisibility\": [ { object (/workspace/cloud-search/docs/reference/rest/v1/GSuitePrincipal) } ], \"returnThumbnailUrls\": boolean, \"operationIds\": [ string ] } ``` |\n\n| Fields ||\n|-----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` The name of the datasource resource. Format: datasources/{sourceId}. The name is ignored when creating a datasource. |\n| `displayName` | `string` Required. Display name of the datasource The maximum length is 300 characters. |\n| `shortName` | `string` A short name or alias for the source. This value will be used to match the 'source' operator. For example, if the short name is *\\\u003cvalue\\\u003e* then queries like *source:\\\u003cvalue\\\u003e* will only return results for this source. The value must be unique across all datasources. The value must only contain alphanumeric characters (a-zA-Z0-9). The value cannot start with 'google' and cannot be one of the following: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. Its maximum length is 32 characters. |\n| `indexingServiceAccounts[]` | `string` List of service accounts that have indexing access. |\n| `disableServing` | `boolean` Disable serving any search or assist results. |\n| `disableModifications` | `boolean` If true, sets the datasource to read-only mode. In read-only mode, the Indexing API rejects any requests to index or delete items in this source. Enabling read-only mode does not stop the processing of previously accepted data. |\n| `itemsVisibility[]` | `object (`[GSuitePrincipal](/workspace/cloud-search/docs/reference/rest/v1/GSuitePrincipal)`)` This field restricts visibility to items at the datasource level. Items within the datasource are restricted to the union of users and groups included in this field. Note that, this does not ensure access to a specific item, as users need to have ACL permissions on the contained items. This ensures a high level access on the entire datasource, and that the individual items are not shared outside this visibility. |\n| `returnThumbnailUrls` | `boolean` Can a user request to get thumbnail URI for Items indexed in this data source. |\n| `operationIds[]` | `string` IDs of the Long Running Operations (LROs) currently running for this schema. |\n\n| Methods ------- ||\n|------------------------------------------------------------------------------------------|-----------------------|\n| ### [create](/workspace/cloud-search/docs/reference/rest/v1/settings.datasources/create) | Creates a datasource. |\n| ### [delete](/workspace/cloud-search/docs/reference/rest/v1/settings.datasources/delete) | Deletes a datasource. |\n| ### [get](/workspace/cloud-search/docs/reference/rest/v1/settings.datasources/get) | Gets a datasource. |\n| ### [list](/workspace/cloud-search/docs/reference/rest/v1/settings.datasources/list) | Lists datasources. |\n| ### [patch](/workspace/cloud-search/docs/reference/rest/v1/settings.datasources/patch) | Updates a datasource. |\n| ### [update](/workspace/cloud-search/docs/reference/rest/v1/settings.datasources/update) | Updates a datasource. |"]]