Class Fields

Fields

Contient un ensemble de Field pour un connecteur de communauté. Cet ensemble de champs définit des dimensions et des métriques dans Data Studio.

var cc = DataStudioApp.createCommunityConnector();
var fields = cc.getFields();
var types = cc.FieldType;

var field1 = fields.newDimension()
  // Set other properties as needed.
  .setId('field1_id');

Méthodes

Méthode	Type renvoyé	Brève description
asArray()	Field[]	Affiche une vue de cet objet sous forme de tableau.
build()	Object[]	Valide cet objet et le renvoie au format requis par Data Studio.
forIds(ids)	Fields	Renvoie un nouvel objet Fields filtré sur les éléments Field avec un ID dans ids.
getDefaultDimension()	Field	Renvoie la dimension par défaut à utiliser pour l'ensemble de champs.
getDefaultMetric()	Field	Renvoie la métrique par défaut à utiliser pour l'ensemble de champs.
getFieldById(fieldId)	Field	Renvoie un champ avec un ID donné ou null si aucun champ avec cet ID ne se trouve dans cet objet Fields.
newDimension()	Field	Renvoie une nouvelle dimension Field.
newMetric()	Field	Renvoie une nouvelle métrique Field.
setDefaultDimension(fieldId)	void	Définit la dimension par défaut à utiliser pour l'ensemble de champs.
setDefaultMetric(fieldId)	void	Définit la métrique par défaut à utiliser pour l'ensemble de champs.

Documentation détaillée

asArray()

Affiche une vue de cet objet sous forme de tableau.

var fields = //reference to fields object.
fields.newDimension().setId('field1_id');
fields.newDimension().setId('field2_id');
fields.newDimension().setId('field3_id');

// Logging the ID of each field:
fields
  .asArray()
  .map(function(field) {
     Logger.log(field.getId());
  });

Renvois

Field[] : tableau d'objets Field.

---

build()

Valide cet objet et le renvoie au format requis par Data Studio.

Renvois

Object[] : données de champ validées, représentées par une liste d'objets.

Génère

Error : si un objet valide ne peut pas être construit.

---

forIds(ids)

Renvoie un nouvel objet Fields filtré sur les éléments Field avec un ID dans ids.

var fields = //reference to fields object.
fields.newDimension().setId('field1_id');
fields.newDimension().setId('field2_id');
fields.newDimension().setId('field3_id');

// subsetFields is a Fields object that only contains field1 and field2.
var subsetFields = fields.forIds(['field1_id', 'field3_id']);

Paramètres

Nom	Type	Description
ids	String[]	Identifiants des champs à conserver.

Renvois

Fields : nouvel objet Fields.

---

getDefaultDimension()

Renvoie la dimension par défaut à utiliser pour l'ensemble de champs. La dimension par défaut est automatiquement lorsqu'une nouvelle visualisation est créée.

Renvois

Field : dimension définie comme dimension par défaut, ou null en l'absence de dimension par défaut a été définie.

---

getDefaultMetric()

Renvoie la métrique par défaut à utiliser pour l'ensemble de champs. La métrique par défaut est sélectionnée automatiquement lorsqu'une nouvelle visualisation est créée.

Renvois

Field : métrique définie comme métrique par défaut, ou null si aucune métrique par défaut n'a été défini.

---

getFieldById(fieldId)

Renvoie un champ avec un ID donné ou null si aucun champ avec cet ID ne se trouve dans cet objet Fields.

var fields = //reference to fields object.
var field1 = fields.newDimension().setId('field1_id');

// byId is the same as field1.
var byId = fields.getFieldById('field1_id');

// byId2 is null.
var byId2 = fields.getFieldById('not present id');

Paramètres

Nom	Type	Description
fieldId	String	Identifiant du champ à récupérer.

Renvois

Field : Field avec l'ID donné ou null si aucun champ de ce type n'est contenu dans cet objet Fields.

---

newDimension()

Renvoie une nouvelle dimension Field.

Renvois

Field : nouvelle dimension Field.

---

newMetric()

Renvoie une nouvelle métrique Field.

Renvois

Field : nouvelle métrique Field.

---

setDefaultDimension(fieldId)

Définit la dimension par défaut à utiliser pour l'ensemble de champs. La dimension par défaut est sélectionnée automatiquement lorsqu'une nouvelle visualisation est créée.

Paramètres

Nom	Type	Description
fieldId	String	ID du champ à utiliser comme dimension par défaut. Cet identifiant doit être présent dans l'ensemble des champs.

---

setDefaultMetric(fieldId)

Définit la métrique par défaut à utiliser pour l'ensemble de champs. La métrique par défaut est sélectionnée automatiquement lorsqu'une nouvelle visualisation est créée.

Paramètres

Nom	Type	Description
fieldId	String	ID du champ à utiliser comme métrique par défaut. Cet identifiant doit être présent dans le champ ensemble de champs.