Contiene datos relacionados con el campo. Sus propiedades determinan cómo se usa el campo en 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étodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
getAggregation() | AggregationType | Muestra el AggregationType de este Field . |
getDescription() | String | Muestra la descripción de este Field . |
getFormula() | String | Muestra la fórmula de este Field . |
getGroup() | String | Muestra el grupo de este Field . |
getId() | String | Muestra el ID de este Field . |
getIsReaggregatable() | Boolean | Muestra true si se puede volver a agregar este campo; de lo contrario, muestra false . |
getName() | String | Muestra el nombre de este Field . |
getType() | FieldType | Muestra el FieldType de este Field . |
isDefault() | Boolean | Muestra true si esta Field es la métrica o dimensión predeterminada. |
isDimension() | Boolean | Muestra true si este campo es una dimensión. |
isHidden() | Boolean | Muestra true si este Field está oculto. |
isMetric() | Boolean | Muestra true si este campo es una métrica. |
setAggregation(aggregation) | Field | Establece el tipo de agregación de este Field . |
setDescription(description) | Field | Establece la descripción de este Field . |
setFormula(formula) | Field | Establece la fórmula de este elemento Field . |
setGroup(group) | Field | Establece el grupo de este Field . |
setId(id) | Field | Establece el ID de este Field . |
setIsHidden(isHidden) | Field | Establece el estado oculto de este Field . |
setIsReaggregatable(isReaggregatable) | Field | Establece el estado permitido por reagregación para un objeto Field . |
setName(name) | Field | Establece el nombre de este Field . |
setType(type) | Field | Establece el FieldType de este Field . |
Documentación detallada
getAggregation()
Muestra el AggregationType
de este Field
. AggregationType
determina
cómo Data Studio combina datos similares en dimensiones.
Volver
AggregationType
: Es el aggregationType de este campo.
getDescription()
Muestra la descripción de este Field
. Las descripciones son explicaciones breves de la API de un campo
que no tiene ningún propósito específico.
Volver
String
: la descripción de este campo.
getFormula()
Muestra la fórmula de este Field
. Las fórmulas definen una transformación de datos en la que
Studio se ejecuta en el momento de la consulta.
Volver
String
: la fórmula de este campo.
getGroup()
Muestra el grupo de este Field
. Los campos recopilados en un grupo se presentan juntos.
en la IU de Data Studio.
Volver
String
: Es el grupo de este campo.
getId()
Muestra el ID de este Field
. Los IDs son únicos por conjunto de campos y se usan en fórmulas
para hacer referencia a los campos.
Volver
String
: el ID de este campo.
getIsReaggregatable()
Muestra true
si se puede volver a agregar este campo; de lo contrario, muestra false
.
Volver
Boolean
: Es true
si se puede volver a agregar este campo; de lo contrario, false
.
getName()
Muestra el nombre de este Field
. Los nombres se muestran al usuario para distinguir campos.
Volver
String
: Es el nombre de este campo.
isDefault()
isDimension()
Muestra true
si este campo es una dimensión.
Volver
Boolean
: true
si este campo es una dimensión. De lo contrario, muestra false
.
isHidden()
isMetric()
Muestra true
si este campo es una métrica.
Volver
Boolean
: true
si este campo es una métrica; De lo contrario, muestra false
.
setAggregation(aggregation)
Establece el tipo de agregación de este Field
. AggregationType
determina cómo se usan
Studio combina datos similares en dimensiones. Esto arroja un error si se lo llama en una métrica.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
aggregation | AggregationType | El tipo de agregación que se configurará. |
Volver
Field
: Este compilador, para encadenamiento,
setDescription(description)
setFormula(formula)
setGroup(group)
setId(id)
setIsHidden(isHidden)
setIsReaggregatable(isReaggregatable)
Establece el estado permitido por reagregación para un objeto Field
. Intentar establecer una agregación
escribir en un campo que no se puede volver a agregar da como resultado un error.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
isReaggregatable | Boolean | El estado permitido por reagregación que se debe establecer. |
Volver
Field
: Este compilador, para encadenamiento,