Contient des données liées aux champs. 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 le AggregationType de ce Field . |
getDescription() | String | Renvoie la description de ce Field . |
getFormula() | String | Renvoie la formule de ce Field . |
getGroup() | String | Renvoie le groupe de ce Field . |
getId() | String | Renvoie l'ID de ce Field . |
getIsReaggregatable() | Boolean | Renvoie la valeur true si ce champ peut être réagrégé, et la valeur false dans le cas contraire. |
getName() | String | Renvoie le nom de cet objet Field . |
getType() | FieldType | Renvoie le FieldType de ce Field . |
isDefault() | Boolean | Renvoie true si Field est la métrique ou la dimension par défaut. |
isDimension() | Boolean | Renvoie la valeur true si ce champ est une dimension. |
isHidden() | Boolean | Renvoie la valeur 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 cet élément 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 ce Field . |
setId(id) | Field | Définit l'ID de cet élément Field . |
setIsHidden(isHidden) | Field | Définit l'état masqué de ce Field . |
setIsReaggregatable(isReaggregatable) | Field | Définit l'état d'autorisation de réagrégation pour une Field . |
setName(name) | Field | Définit le nom de ce Field . |
setType(type) | Field | Définit l'élément FieldType de cet élément Field . |
Documentation détaillée
getAggregation()
Renvoie le AggregationType
de ce Field
. AggregationType
détermine la manière dont 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'objectif d'un champ.
Renvois
String
: description de ce champ.
getFormula()
Renvoie la formule de ce 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 ce Field
. Les champs rassemblés au sein d'un groupe sont présentés dans l'interface utilisateur de Data Studio.
Renvois
String
: groupe associé à ce champ.
getId()
Renvoie l'ID de ce Field
. Les ID 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 la valeur true
si ce champ peut être réagrégé, et la valeur 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.
isDefault()
isDimension()
Renvoie la valeur true
si ce champ est une dimension.
Renvois
Boolean
: true
si ce champ est une dimension ; renvoie false
dans les autres cas.
isHidden()
isMetric()
Renvoie true
si ce champ est une métrique.
Renvois
Boolean
: true
si ce champ est une métrique. Sinon, renvoie false
.
setAggregation(aggregation)
Définit le type d'agrégation de cet élément Field
. AggregationType
détermine la manière dont Data Studio combine des données similaires en dimensions. Cela génère une erreur en cas d'appel sur une métrique.
Paramètres
Nom | Type | Description |
---|---|---|
aggregation | AggregationType | Type d'agrégation à définir. |
Renvois
Field
: compilateur pour le chaînage.
setDescription(description)
setFormula(formula)
setGroup(group)
setId(id)
setIsHidden(isHidden)
setIsReaggregatable(isReaggregatable)
Définit l'état d'autorisation de réagrégation pour une Field
. Toute tentative de définition d'un type d'agrégation sur un champ qui ne peut pas être réagrégé entraîne une erreur.
Paramètres
Nom | Type | Description |
---|---|---|
isReaggregatable | Boolean | État d'autorisation de réagrégation à définir. |
Renvois
Field
: compilateur pour le chaînage.