Class Field

Contient des données liées aux champs. Ses propriétés déterminent la façon dont le champ est utilisé dans Data Studio.

const cc = DataStudioApp.createCommunityConnector();
const fields = cc.getFields();

const field1 = fields.newDimension()
                   .setId('field1_id')
                   .setName('Field 1 ID')
                   .setDescription('The first field.')
                   .setType(cc.FieldType.YEAR_MONTH)
                   .setGroup('DATETIME');

Méthodes

Méthode	Type renvoyé	Brève description
`getAggregation()`	`AggregationType`	Renvoie le `AggregationType` de cette `Field`.
`getDescription()`	`String`	Renvoie la description de cet objet `Field`.
`getFormula()`	`String`	Renvoie la formule de cet objet `Field`.
`getGroup()`	`String`	Renvoie le groupe de cet objet `Field`.
`getId()`	`String`	Renvoie l'ID de cet objet `Field`.
`getIsReaggregatable()`	`Boolean`	Renvoie `true` si ce champ peut être réagrégé, ou `false` dans le cas contraire.
`getName()`	`String`	Renvoie le nom de cet objet `Field`.
`getType()`	`FieldType`	Renvoie le `FieldType` de cette `Field`.
`isDefault()`	`Boolean`	Renvoie `true` si ce `Field` est la métrique ou la dimension par défaut.
`isDimension()`	`Boolean`	Renvoie `true` si ce champ est une dimension.
`isHidden()`	`Boolean`	Renvoie `true` si ce `Field` est masqué.
`isMetric()`	`Boolean`	Renvoie `true` si ce champ est une métrique.
`setAggregation(aggregation)`	`Field`	Définit le type d'agrégation de ce `Field`.
`setDescription(description)`	`Field`	Définit la description de ce `Field`.
`setFormula(formula)`	`Field`	Définit la formule de cette `Field`.
`setGroup(group)`	`Field`	Définit le groupe de ce `Field`.
`setId(id)`	`Field`	Définit l'ID de ce `Field`.
`setIsHidden(isHidden)`	`Field`	Définit l'état masqué de cet `Field`.
`setIsReaggregatable(isReaggregatable)`	`Field`	Définit l'état d'agrégation autorisée pour un `Field`.
`setName(name)`	`Field`	Définit le nom de cet objet `Field`.
`setType(type)`	`Field`	Définit le `FieldType` de ce `Field`.

Documentation détaillée

`getAggregation()`

Renvoie le AggregationType de cette Field. AggregationType détermine comment Data Studio combine des données similaires en dimensions.

Renvois

AggregationType : aggregationType pour ce champ.

`getDescription()`

Renvoie la description de cet objet Field. Les descriptions sont de brèves explications sur l'objectif d'un champ.

Renvois

String : description de ce champ.

`getFormula()`

Renvoie la formule de cet objet Field. Les formules définissent une transformation de données que Data Studio exécute au moment de la requête.

Renvois

String : formule de ce champ.

`getGroup()`

Renvoie le groupe de cet objet Field. Les champs collectés dans un groupe sont présentés ensemble dans l'UI Data Studio.

Renvois

String : groupe de ce champ.

`getId()`

Renvoie l'ID de cet objet Field. Les ID sont uniques pour chaque ensemble de champs et sont utilisés dans les formules pour faire référence aux champs.

Renvois

String : ID de ce champ.

`getIsReaggregatable()`

Renvoie true si ce champ peut être réagrégé, ou false dans le cas contraire.

Renvois

Boolean : true si ce champ peut être réagrégé, false dans le cas contraire.

`getName()`

Renvoie le nom de cet objet Field. Les noms sont affichés pour permettre à l'utilisateur de distinguer les champs.

Renvois

String : nom de ce champ.

`getType()`

Renvoie le FieldType de cette Field.

Renvois

FieldType : type de ce champ.

`isDefault()`

Renvoie true si ce Field est la métrique ou la dimension par défaut.

Renvois

Boolean : true si cette Field est la métrique ou la dimension par défaut, false sinon.

`isDimension()`

Renvoie true si ce champ est une dimension.

Renvois

Boolean : true si ce champ est une dimension, false dans le cas contraire.

`isHidden()`

Renvoie true si ce Field est masqué. Vous pouvez utiliser des champs masqués dans les formules, mais pas dans les graphiques. Vous ne pouvez pas masquer les champs contenant des formules.

Renvois

Boolean : true si ce Field est masqué, false sinon.

`isMetric()`

Renvoie true si ce champ est une métrique.

Renvois

Boolean : true si ce champ est une métrique, false dans le cas contraire.

`setAggregation(aggregation)`

Définit le type d'agrégation de ce Field. AggregationType détermine comment Data Studio combine des données similaires en dimensions. Cela génère une erreur si l'opération est appelée sur une métrique.