Class GetDataResponse

GetDataResponse

Builder para criar uma resposta getData() para seu projeto de script.

function getFields() {...}
function getData() {
  var cc = DataStudioApp.createCommunityConnector();

  return cc.newGetDataResponse()
    .setFields(getFields())
    .addRow(['3', 'Foobar.com'])
    .addRow(['4', 'Foobaz.com'])
    .addRows([
      ['5', 'Fizzbuz.com'],
      ['6', 'Fizzbaz.com']
     ])
    .build();
}

Métodos

MétodoTipo de retornoBreve descrição
addAllRows(rows)GetDataResponseAdiciona várias linhas de dados a esse GetDataResponse.
addRow(row)GetDataResponseAdiciona uma linha de dados a esse GetDataResponse.
build()ObjectValida esse objeto e o retorna no formato exigido pelo Data Studio.
setFields(fields)GetDataResponseDefine o Fields do builder.
setFiltersApplied(filtersApplied)GetDataResponseDefine o status de aplicação dos filtros para este builder.

Documentação detalhada

addAllRows(rows)

Adiciona várias linhas de dados a esse GetDataResponse.

Parâmetros

NomeTipoDescrição
rowsString[][]As linhas de dados a serem definidas.

Retorno

GetDataResponse: este builder, para encadeamento.


addRow(row)

Adiciona uma linha de dados a esse GetDataResponse.

Parâmetros

NomeTipoDescrição
rowString[]A linha de dados a ser definida.

Retorno

GetDataResponse: este builder, para encadeamento.


build()

Valida esse objeto e o retorna no formato exigido pelo Data Studio.

Retorno

Object: o objeto GetDataResponse validado.


setFields(fields)

Define o Fields do builder.

Parâmetros

NomeTipoDescrição
fieldsFieldsOs campos a serem definidos.

Retorno

GetDataResponse: este builder, para encadeamento.


setFiltersApplied(filtersApplied)

Define o status de aplicação dos filtros para este builder. Defina como true se todos os filtros tiverem sido aplicados. Caso contrário, defina false.

Parâmetros

NomeTipoDescrição
filtersAppliedBoolean- O status dos filtros aplicados a serem definidos.

Retorno

GetDataResponse: este builder, para encadeamento.