Class TextInput
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
TextEingabe
Enthält Informationen zur Texteingabe für die Konfiguration. Mit den Eigenschaften wird festgelegt, wie die Texteingabe in Data Studio dargestellt wird.
const cc = DataStudioApp.createCommunityConnector();
const config = cc.getConfig();
const info1 = config.newTextInput()
.setId('info1')
.setName('Search')
.setHelpText('for example, Coldplay')
.setAllowOverride(true)
.setPlaceholder('Search for an artist for all songs.');
Detaillierte Dokumentation
setAllowOverride(allowOverride)
Aktiviert das Überschreiben für diesen Konfigurationseintrag. Wenn true festgelegt ist, können die Ersteller von Datenquellen diese Option für Mitbearbeiter von Berichten aktivieren.
Parameter
| Name | Typ | Beschreibung |
allowOverride | Boolean | Gibt an, ob dieser Konfigurationseintrag in Berichten überschrieben werden kann. |
Rückflug
TextInput – Dieser Builder zur Verkettung.
setHelpText(helpText)
Hiermit wird der Hilfetext für diesen Konfigurationseintrag festgelegt.
Parameter
| Name | Typ | Beschreibung |
helpText | String | Der zu setzende Hilfetext. |
Rückflug
TextInput – Dieser Builder zur Verkettung.
setId(id)
Hier wird die eindeutige ID für diesen Konfigurationseintrag festgelegt.
Parameter
| Name | Typ | Beschreibung |
id | String | Die ID, die festgelegt werden soll. |
Rückflug
TextInput – Dieser Builder zur Verkettung.
setIsDynamic(isDynamic)
Hier wird der dynamische Status für diesen Konfigurationseintrag festgelegt.
Wenn ein dynamischer Konfigurationseintrag geändert wird, werden nachfolgende Konfigurationseinträge gelöscht.
Parameter
| Name | Typ | Beschreibung |
isDynamic | Boolean | Der festzulegende dynamische Status. |
Rückflug
TextInput – Dieser Builder zur Verkettung.
setName(name)
Legt den Anzeigenamen für diesen Konfigurationseintrag fest.
Parameter
| Name | Typ | Beschreibung |
name | String | Der Name, der festgelegt werden soll. |
Rückflug
TextInput – Dieser Builder zur Verkettung.
setPlaceholder(placeholder)
Hiermit wird der Platzhaltertext für diesen Konfigurationseintrag festgelegt.
Parameter
| Name | Typ | Beschreibung |
placeholder | String | Der zu festlegende Platzhaltertext. |
Rückflug
TextInput – Dieser Builder zur Verkettung.
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-26 (UTC).
[null,null,["Zuletzt aktualisiert: 2025-07-26 (UTC)."],[[["\u003cp\u003e\u003ccode\u003eTextInput\u003c/code\u003e objects are used to collect text input within a Data Studio configuration.\u003c/p\u003e\n"],["\u003cp\u003eThese objects allow you to define the input's label (\u003ccode\u003esetName\u003c/code\u003e), placeholder text (\u003ccode\u003esetPlaceholder\u003c/code\u003e), help text (\u003ccode\u003esetHelpText\u003c/code\u003e), and more.\u003c/p\u003e\n"],["\u003cp\u003eYou can control whether users can override the input's value (\u003ccode\u003esetAllowOverride\u003c/code\u003e) and whether it dynamically affects other configuration options (\u003ccode\u003esetIsDynamic\u003c/code\u003e).\u003c/p\u003e\n"],["\u003cp\u003eEvery \u003ccode\u003eTextInput\u003c/code\u003e needs a unique identifier set using the \u003ccode\u003esetId\u003c/code\u003e method.\u003c/p\u003e\n"]]],[],null,["# Class TextInput\n\nTextInput\n\nContains text input information for the config. Its properties determine how the text input is\ndisplayed in Data Studio.\n\n```javascript\nconst cc = DataStudioApp.createCommunityConnector();\nconst config = cc.getConfig();\n\nconst info1 = config.newTextInput()\n .setId('info1')\n .setName('Search')\n .setHelpText('for example, Coldplay')\n .setAllowOverride(true)\n .setPlaceholder('Search for an artist for all songs.');\n``` \n\n### Methods\n\n| Method | Return type | Brief description |\n|---------------------------------------------------------------|----------------|---------------------------------------------------------|\n| [setAllowOverride(allowOverride)](#setAllowOverride(Boolean)) | [TextInput](#) | Enables overriding for this config entry. |\n| [setHelpText(helpText)](#setHelpText(String)) | [TextInput](#) | Sets the help text for this configuration entry. |\n| [setId(id)](#setId(String)) | [TextInput](#) | Sets the unique ID for this configuration entry. |\n| [setIsDynamic(isDynamic)](#setIsDynamic(Boolean)) | [TextInput](#) | Sets the dynamic status for this configuration entry. |\n| [setName(name)](#setName(String)) | [TextInput](#) | Sets the display name for this configuration entry. |\n| [setPlaceholder(placeholder)](#setPlaceholder(String)) | [TextInput](#) | Sets the placeholder text for this configuration entry. |\n\nDetailed documentation\n----------------------\n\n### `set``Allow``Override(allowOverride)`\n\nEnables overriding for this config entry. If set to `true`, data source creators have the\noption to enable this for report editors\n\n#### Parameters\n\n| Name | Type | Description |\n|-------------------|-----------|----------------------------------------------------------------|\n| `allow``Override` | `Boolean` | Whether or not this config entry can be overridden in reports. |\n\n#### Return\n\n\n[TextInput](#) --- This builder, for chaining.\n\n*** ** * ** ***\n\n### `set``Help``Text(helpText)`\n\nSets the help text for this configuration entry.\n\n#### Parameters\n\n| Name | Type | Description |\n|--------------|----------|----------------------|\n| `help``Text` | `String` | The helpText to set. |\n\n#### Return\n\n\n[TextInput](#) --- This builder, for chaining.\n\n*** ** * ** ***\n\n### `set``Id(id)`\n\nSets the unique ID for this configuration entry.\n\n#### Parameters\n\n| Name | Type | Description |\n|------|----------|----------------|\n| `id` | `String` | The ID to set. |\n\n#### Return\n\n\n[TextInput](#) --- This builder, for chaining.\n\n*** ** * ** ***\n\n### `set``Is``Dynamic(isDynamic)`\n\nSets the dynamic status for this configuration entry.\n\nIf a dynamic configuration entry is modified, subsequent configuration entries are cleared.\n\n#### Parameters\n\n| Name | Type | Description |\n|---------------|-----------|----------------------------|\n| `is``Dynamic` | `Boolean` | The dynamic status to set. |\n\n#### Return\n\n\n[TextInput](#) --- This builder, for chaining.\n\n*** ** * ** ***\n\n### `set``Name(name)`\n\nSets the display name for this configuration entry.\n\n#### Parameters\n\n| Name | Type | Description |\n|--------|----------|------------------|\n| `name` | `String` | The name to set. |\n\n#### Return\n\n\n[TextInput](#) --- This builder, for chaining.\n\n*** ** * ** ***\n\n### `set``Placeholder(placeholder)`\n\nSets the placeholder text for this configuration entry.\n\n#### Parameters\n\n| Name | Type | Description |\n|---------------|----------|------------------------------|\n| `placeholder` | `String` | The placeholder text to set. |\n\n#### Return\n\n\n[TextInput](#) --- This builder, for chaining."]]
