Cette page a été traduite par l'API Cloud Translation.

Class Field

Contient des données liées au champ. Ses propriétés déterminent l'utilisation du champ 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 l'`AggregationType` de cet objet `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 l'`FieldType` de cet objet `Field`.
`isDefault()`	`Boolean`	Renvoie `true` si cette `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 cet élément `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 cette `Field`.
`setDescription(description)`	`Field`	Définit la description de cet élément `Field`.
`setFormula(formula)`	`Field`	Définit la formule de cet élément `Field`.
`setGroup(group)`	`Field`	Définit le groupe de cet élément `Field`.
`setId(id)`	`Field`	Définit l'ID de cet objet `Field`.
`setIsHidden(isHidden)`	`Field`	Définit l'état masqué de cet objet `Field`.
`setIsReaggregatable(isReaggregatable)`	`Field`	Définit l'état d'autorisation de la réagrégation 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 l'AggregationType de cet objet Field. AggregationType détermine comment Data Studio combine des données similaires en dimensions.

Renvois

AggregationType : type d'agrégation pour ce champ.

`getDescription()`

Renvoie la description de cet objet Field. Les descriptions sont de courtes explications de 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'interface utilisateur de 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 sinon.

`getName()`

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

Renvois

String : nom de ce champ.

`getType()`

Renvoie l'FieldType de cet objet Field.

Renvois

FieldType : type de ce champ.

`isDefault()`

Renvoie true si cette 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, ou false dans le cas contraire.

`isHidden()`

Renvoie true si cet élément 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 cet élément Field est masqué, sinon false.

`isMetric()`

Renvoie true si ce champ est une métrique.

Renvois

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

`setAggregation(aggregation)`

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