מכיל נתונים הקשורים לשדה. המאפיינים של השדה קובעים את אופן השימוש בו ב-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');
שיטות
שיטה | סוג הערך שמוחזר | תיאור קצר |
---|---|---|
getAggregation() | AggregationType | הפונקציה מחזירה את הערך AggregationType של Field . |
getDescription() | String | הפונקציה מחזירה את התיאור של Field . |
getFormula() | String | מחזירה את הנוסחה של Field . |
getGroup() | String | מחזירה את הקבוצה של Field . |
getId() | String | הפונקציה מחזירה את המזהה של Field זה. |
getIsReaggregatable() | Boolean | הפונקציה מחזירה את הערך true אם אפשר לצבור מחדש את השדה הזה. אחרת, false . |
getName() | String | הפונקציה מחזירה את השם של Field . |
getType() | FieldType | הפונקציה מחזירה את הערך FieldType של Field . |
isDefault() | Boolean | הפונקציה מחזירה את הערך true אם הערך Field הוא המדד או המאפיין שמוגדרים כברירת מחדל. |
isDimension() | Boolean | הפונקציה מחזירה את הערך true אם השדה הזה הוא מאפיין. |
isHidden() | Boolean | הפונקציה מחזירה את הערך true אם הערך Field מוסתר. |
isMetric() | Boolean | הפונקציה מחזירה את הערך true אם השדה הזה הוא מדד. |
setAggregation(aggregation) | Field | הגדרת סוג הצבירה של Field . |
setDescription(description) | Field | מגדיר את התיאור של Field . |
setFormula(formula) | Field | מגדיר את הנוסחה של Field . |
setGroup(group) | Field | הגדרת הקבוצה של Field זה. |
setId(id) | Field | מגדיר את המזהה של Field . |
setIsHidden(isHidden) | Field | מגדיר את סטטוס ההסתרה של Field . |
setIsReaggregatable(isReaggregatable) | Field | המדיניות הזו מגדירה את סטטוס 'ניתנה לצבירה' של Field . |
setName(name) | Field | הגדרת השם של Field . |
setType(type) | Field | מגדיר את FieldType של Field . |
תיעוד מפורט
getAggregation()
הפונקציה מחזירה את הערך AggregationType
של Field
. AggregationType
קובע איך Data Studio משלב נתונים דומים למאפיינים.
החזרות
AggregationType
- סוג הצבירה של השדה הזה.
getDescription()
הפונקציה מחזירה את התיאור של Field
. התיאורים מספקים הסברים קצרים על מטרת השדה.
החזרות
String
- התיאור של השדה הזה.
getFormula()
מחזירה את הנוסחה של Field
. נוסחאות מגדירות טרנספורמציה של נתונים ש-Data Studio מפעיל בזמן השאילתה.
החזרות
String
- הנוסחה לשדה הזה.
getGroup()
מחזירה את הקבוצה של Field
. שדות שנאספים בקבוצה מוצגים יחד בממשק המשתמש של Data Studio.
החזרות
String
- הקבוצה של השדה הזה.
getId()
הפונקציה מחזירה את המזהה של Field
זה. המזהים הם ייחודיים לכל קבוצת שדות ומשמשים בנוסחאות כדי להפנות לשדות.
החזרות
String
- המזהה של השדה הזה.
getIsReaggregatable()
הפונקציה מחזירה את הערך true
אם אפשר לצבור מחדש את השדה הזה. אחרת, false
.
החזרות
Boolean
– true
אם אפשר לצבור מחדש את השדה הזה. אחרת, false
.
getName()
הפונקציה מחזירה את השם של Field
. השמות מוצגים למשתמש כדי להבדיל בין שדות.
החזרות
String
- השם של השדה הזה.
isDefault()
isDimension()
הפונקציה מחזירה את הערך true
אם השדה הזה הוא מאפיין.
החזרות
Boolean
– true
אם השדה הזה הוא מאפיין. אחרת, הפונקציה מחזירה את הערך false
.
isHidden()
isMetric()
הפונקציה מחזירה את הערך true
אם השדה הזה הוא מדד.
החזרות
Boolean
- true
אם השדה הזה הוא מדד; הפונקציה מחזירה את הערך false
אחרת.
setAggregation(aggregation)
הגדרת סוג הצבירה של Field
. AggregationType
קובע איך Data Studio משלב נתונים דומים במאפיינים. תופיע שגיאה אם היא תופעל במדד מסוים.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
aggregation | AggregationType | סוג הצבירה להגדרה. |
החזרות
Field
– הכלי הזה – לשרשורים.