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 la manière dont le champ est utilisé dans Data Studio.

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

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

Méthodes

Méthode	Type renvoyé	Brève description
`getAggregation()`	`AggregationType`	Renvoie l'`AggregationType` de ce `Field`.
`getDescription()`	`String`	Renvoie la description de ce `Field`.
`getFormula()`	`String`	Affiche la formule de ce `Field`.
`getGroup()`	`String`	Renvoie le groupe de ce `Field`.
`getId()`	`String`	Renvoie l'ID de ce `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 ce `Field`.
`isDefault()`	`Boolean`	Renvoie `true` si `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 ce `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 ce `Field`.
`setIsHidden(isHidden)`	`Field`	Définit l'état "masqué" de cet élément `Field`.
`setIsReaggregatable(isReaggregatable)`	`Field`	Définit l'état de réagrégation autorisée pour une `Field`.
`setName(name)`	`Field`	Définit le nom de cet élément `Field`.
`setType(type)`	`Field`	Définit le `FieldType` de ce `Field`.

Documentation détaillée

`getAggregation()`

Renvoie l'AggregationType de ce 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 ce Field. Les descriptions sont de brèves explications de l'état l'objectif.

Renvois

String : description de ce champ.

`getFormula()`

Affiche la formule de ce Field. Les formules définissent une transformation de données que les Studio s'exécute au moment de la requête.

Renvois

String : formule pour ce champ.

`getGroup()`

Renvoie le groupe de ce Field. Les champs collectés dans un groupe sont présentés ensemble dans l'interface utilisateur de Data Studio.

Renvois

String : groupe pour ce champ.

`getId()`

Renvoie l'ID de ce Field. Les identifiants sont uniques pour chaque ensemble de champs et sont utilisés dans les formules. pour faire référence à des 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 présentés à l'utilisateur pour distinguer les champs.

Renvois

String : nom de ce champ.

`getType()`

Renvoie l'FieldType de ce Field.

Renvois

FieldType : type de ce champ.

`isDefault()`

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

Renvois

Boolean : true si 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 renvoie 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 cette Field est masquée false dans le cas contraire.

`isMetric()`

Renvoie true si ce champ est une métrique.

Renvois

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

`setAggregation(aggregation)`

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