Class GetDataResponse
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
GetDataResponse
Builder para criar uma resposta getData()
para o projeto do 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();
}
Documentação detalhada
addAllRows(rows)
Adiciona várias linhas de dados a este GetDataResponse
.
Parâmetros
Nome | Tipo | Descrição |
rows | String[][] | As linhas de dados a serem definidas. |
Retornar
GetDataResponse
: este builder, para encadeamento.
addRow(row)
Adiciona uma linha de dados a GetDataResponse
.
Parâmetros
Nome | Tipo | Descrição |
row | String[] | A linha de dados a ser definida. |
Retornar
GetDataResponse
: este builder, para encadeamento.
build()
Valida e retorna o objeto no formato necessário para o Data Studio.
Retornar
Object
: o objeto GetDataResponse
validado.
setFields(fields)
Define o Fields
do builder.
Parâmetros
Nome | Tipo | Descrição |
fields | Fields | Os campos a serem definidos. |
Retornar
GetDataResponse
: este builder, para encadeamento.
setFiltersApplied(filtersApplied)
Define o status dos filtros aplicados para esse criador. Defina como true
se todos os filtros foram
aplicados. Caso contrário, defina como false
.
Parâmetros
Nome | Tipo | Descrição |
filtersApplied | Boolean | - O status dos filtros aplicados para definir. |
Retornar
GetDataResponse
: este builder, para encadeamento.
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-07-26 UTC.
[null,null,["Última atualização 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."]]