Class GetDataResponse
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
GetDataResponse
Compilateur permettant de créer une réponse getData() pour votre projet de script.
function getFields() {
//...
}
function getData() {
const cc = DataStudioApp.createCommunityConnector();
return cc.newGetDataResponse()
.setFields(getFields())
.addRow(['3', 'Foobar.com'])
.addRow(['4', 'Foobaz.com'])
.addRows([
['5', 'Fizzbuz.com'],
['6', 'Fizzbaz.com'],
])
.build();
}
Documentation détaillée
addAllRows(rows)
Ajoute plusieurs lignes de données à cette GetDataResponse.
Paramètres
| Nom | Type | Description |
rows | String[][] | Lignes de données à définir. |
Renvois
GetDataResponse : ce générateur, pour le chaînage.
addRow(row)
Ajoute une ligne de données à cet élément GetDataResponse.
Paramètres
| Nom | Type | Description |
row | String[] | Ligne de données à définir. |
Renvois
GetDataResponse : ce générateur, pour le chaînage.
build()
Valide cet objet et le renvoie au format requis par Data Studio.
Renvois
Object : objet GetDataResponse validé.
setFields(fields)
Définit le Fields du compilateur.
Paramètres
| Nom | Type | Description |
fields | Fields | Champs à définir. |
Renvois
GetDataResponse : ce générateur, pour le chaînage.
setFiltersApplied(filtersApplied)
Définit l'état des filtres appliqués pour cet outil de création. Définissez-le sur true si tous les filtres ont bien été appliqués, sinon sur false.
Paramètres
| Nom | Type | Description |
filtersApplied | Boolean | - État des filtres appliqués à définir. |
Renvois
GetDataResponse : ce générateur, pour le chaînage.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/26 (UTC).
[null,null,["Dernière mise à jour le 2025/07/26 (UTC)."],[[["\u003cp\u003e\u003ccode\u003eGetDataResponse\u003c/code\u003e helps structure the data your script returns to Data Studio for visualization.\u003c/p\u003e\n"],["\u003cp\u003eIt provides methods like \u003ccode\u003eaddRow\u003c/code\u003e, \u003ccode\u003eaddAllRows\u003c/code\u003e, and \u003ccode\u003esetFields\u003c/code\u003e to define the data structure and content.\u003c/p\u003e\n"],["\u003cp\u003eUse \u003ccode\u003ebuild()\u003c/code\u003e to finalize and send the data to Data Studio in the correct format.\u003c/p\u003e\n"],["\u003cp\u003eYou can signal if Data Studio filters were applied using \u003ccode\u003esetFiltersApplied\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# Class GetDataResponse\n\nGetDataResponse\n\nBuilder to create a `get``Data()` response for your script project.\n\n```javascript\nfunction getFields() {\n //...\n}\n\nfunction getData() {\n const cc = DataStudioApp.createCommunityConnector();\n\n return cc.newGetDataResponse()\n .setFields(getFields())\n .addRow(['3', 'Foobar.com'])\n .addRow(['4', 'Foobaz.com'])\n .addRows([\n ['5', 'Fizzbuz.com'],\n ['6', 'Fizzbaz.com'],\n ])\n .build();\n}\n``` \n\n### Methods\n\n| Method | Return type | Brief description |\n|------------------------------------------------------------------|----------------------|------------------------------------------------------------------------------|\n| [addAllRows(rows)](#addAllRows(String)) | [GetDataResponse](#) | Adds multiple rows of data to this [GetDataResponse](#). |\n| [addRow(row)](#addRow(String)) | [GetDataResponse](#) | Adds a row of data to this [GetDataResponse](#). |\n| [build()](#build()) | `Object` | Validates this object and returns it in the format needed by Data Studio. |\n| [setFields(fields)](#setFields(Fields)) | [GetDataResponse](#) | Sets the [Fields](/apps-script/reference/data-studio/fields) of the builder. |\n| [setFiltersApplied(filtersApplied)](#setFiltersApplied(Boolean)) | [GetDataResponse](#) | Sets the filters applied status for this builder. |\n\nDetailed documentation\n----------------------\n\n### `add``All``Rows(rows)`\n\nAdds multiple rows of data to this [GetDataResponse](#).\n\n#### Parameters\n\n| Name | Type | Description |\n|--------|--------------|--------------------------|\n| `rows` | `String[][]` | The rows of data to set. |\n\n#### Return\n\n\n[GetDataResponse](#) --- This builder, for chaining.\n\n*** ** * ** ***\n\n### `add``Row(row)`\n\nAdds a row of data to this [GetDataResponse](#).\n\n#### Parameters\n\n| Name | Type | Description |\n|-------|------------|-------------------------|\n| `row` | `String[]` | The row of data to set. |\n\n#### Return\n\n\n[GetDataResponse](#) --- This builder, for chaining.\n\n*** ** * ** ***\n\n### `build()`\n\nValidates this object and returns it in the format needed by Data Studio.\n\n#### Return\n\n\n`Object` --- The validated [GetDataResponse](#) object.\n\n*** ** * ** ***\n\n### `set``Fields(fields)`\n\nSets the [Fields](/apps-script/reference/data-studio/fields) of the builder.\n\n#### Parameters\n\n| Name | Type | Description |\n|----------|-----------------------------------------------------|--------------------|\n| `fields` | [Fields](/apps-script/reference/data-studio/fields) | The fields to set. |\n\n#### Return\n\n\n[GetDataResponse](#) --- This builder, for chaining.\n\n*** ** * ** ***\n\n### `set``Filters``Applied(filtersApplied)`\n\nSets the filters applied status for this builder. Set to `true` if all filters were\nsuccessfully applied, `false` otherwise.\n\n#### Parameters\n\n| Name | Type | Description |\n|--------------------|-----------|--------------------------------------|\n| `filters``Applied` | `Boolean` | - The filters applied status to set. |\n\n#### Return\n\n\n[GetDataResponse](#) --- This builder, for chaining."]]
