Class GetDataResponse

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();
}

Méthodes

MéthodeType renvoyéBrève description
addAllRows(rows)GetDataResponseAjoute plusieurs lignes de données à cette GetDataResponse.
addRow(row)GetDataResponseAjoute une ligne de données à ce GetDataResponse.
build()ObjectValide cet objet et le renvoie au format requis par Data Studio.
setFields(fields)GetDataResponseDéfinit les Fields du compilateur.
setFiltersApplied(filtersApplied)GetDataResponseDéfinit l'état des filtres appliqués pour ce compilateur.

Documentation détaillée

addAllRows(rows)

Ajoute plusieurs lignes de données à cette GetDataResponse.

Paramètres

NomTypeDescription
rowsString[][]Lignes de données à définir.

Renvois

GetDataResponse : ce compilateur, pour le chaînage.


addRow(row)

Ajoute une ligne de données à cette GetDataResponse.

Paramètres

NomTypeDescription
rowString[]Ligne de données à définir.

Renvois

GetDataResponse : ce compilateur, 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 les Fields du compilateur.

Paramètres

NomTypeDescription
fieldsFieldsChamps à définir.

Renvois

GetDataResponse : ce compilateur, pour le chaînage.


setFiltersApplied(filtersApplied)

Définit l'état des filtres appliqués pour ce compilateur. Définissez la valeur sur true si tous les filtres ont été appliqués, et sur false dans le cas contraire.

Paramètres

NomTypeDescription
filtersAppliedBoolean- État des filtres appliqués à définir.

Renvois

GetDataResponse : ce compilateur, pour le chaînage.