REST Resource: settings.datasources
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
Ressource: DataSource
„Datenquelle“ ist ein logischer Namespace für zu indexierende Elemente. Alle Elemente müssen zu einer Datenquelle gehören. Dies ist eine Voraussetzung, damit Elemente in Cloud Search indexiert werden können.
JSON-Darstellung |
{
"name": string,
"displayName": string,
"shortName": string,
"indexingServiceAccounts": [
string
],
"disableServing": boolean,
"disableModifications": boolean,
"itemsVisibility": [
{
object (GSuitePrincipal )
}
],
"returnThumbnailUrls": boolean,
"operationIds": [
string
]
} |
Felder |
name |
string
Der Name der Datenquellenressource. Format: datasources/{sourceId}. Der Name wird beim Erstellen einer Datenquelle ignoriert.
|
displayName |
string
Erforderlich. Der Anzeigename der Datenquelle. Die maximale Länge beträgt 300 Zeichen.
|
shortName |
string
Ein Kurzname oder Alias für die Quelle. Dieser Wert wird für den Abgleich mit dem Operator „source“ verwendet. Wenn der Kurzname beispielsweise <Wert> lautet, werden bei Suchanfragen wie Quelle:<Wert> nur Ergebnisse für diese Quelle zurückgegeben. Der Wert muss für alle Datenquellen eindeutig sein. Der Wert darf nur alphanumerische Zeichen (a–zA–Z0–9) enthalten. Der Wert darf nicht mit „google“ beginnen und darf keiner der folgenden Namen sein: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. Die maximale Länge beträgt 32 Zeichen.
|
indexingServiceAccounts[] |
string
Liste der Dienstkonten mit Indexierungszugriff.
|
disableServing |
boolean
Deaktivieren Sie die Bereitstellung von Such- oder Assistenzergebnissen.
|
disableModifications |
boolean
Wenn „true“, wird die Datenquelle in den Lesemodus versetzt. Im Lesemodus lehnt die Indexing API alle Anfragen zum Indexieren oder Löschen von Elementen in dieser Quelle ab. Durch das Aktivieren des Lesemodus wird die Verarbeitung zuvor akzeptierter Daten nicht beendet.
|
itemsVisibility[] |
object (GSuitePrincipal )
Mit diesem Feld wird die Sichtbarkeit auf Elemente auf Datenquellenebene beschränkt. Elemente in der Datenquelle sind auf die Vereinigung der Nutzer und Gruppen beschränkt, die in diesem Feld enthalten sind. Hinweis: Dies ist keine Garantie für den Zugriff auf ein bestimmtes Element, da Nutzer ACL-Berechtigungen für die enthaltenen Elemente benötigen. So wird ein umfassender Zugriff auf die gesamte Datenquelle sichergestellt und die einzelnen Elemente werden nicht außerhalb dieser Sichtbarkeit freigegeben.
|
returnThumbnailUrls |
boolean
Können Nutzer den Thumbnail-URI für Elemente anfordern, die in dieser Datenquelle indexiert sind?
|
operationIds[] |
string
IDs der derzeit für dieses Schema ausgeführten lang andauernden Vorgänge.
|
Methoden |
|
Erstellt eine Datenquelle. |
|
Löscht eine Datenquelle. |
|
Ruft eine Datenquelle ab. |
|
Listet Datenquellen auf. |
|
Aktualisiert eine Datenquelle. |
|
Aktualisiert eine Datenquelle. |
Sofern nicht anders angegeben, sind die Inhalte dieser Seite unter der Creative Commons Attribution 4.0 License und Codebeispiele unter der Apache 2.0 License lizenziert. Weitere Informationen finden Sie in den Websiterichtlinien von Google Developers. Java ist eine eingetragene Marke von Oracle und/oder seinen Partnern.
Zuletzt aktualisiert: 2025-07-25 (UTC).
[null,null,["Zuletzt aktualisiert: 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. |"]]