Class Field

מכיל נתונים שקשורים לשדה. המאפיינים שלו קובעים איך השדה ישמש ב-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');

Methods

שיטה	סוג הערך שמוחזר	תיאור קצר
`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 – השם של השדה הזה.

`getType()`

הפונקציה מחזירה את ה-FieldType של ה-Field הזה.

חזרה

‫FieldType – הסוג של השדה הזה.

`isDefault()`

הפונקציה מחזירה true אם Field הוא מדד או מאפיין ברירת המחדל.

חזרה

‫Boolean — true אם Field הוא מדד או מאפיין ברירת המחדל; false אחרת.

`isDimension()`

מחזירה true אם השדה הזה הוא מאפיין.

חזרה

‫Boolean – true אם השדה הזה הוא מאפיין; מחזירה false אחרת.

`isHidden()`

הפונקציה מחזירה את הערך true אם Field מוסתר. אפשר להשתמש בשדות מוסתרים בנוסחאות, אבל לא בתרשימים. אי אפשר להסתיר שדות שמכילים נוסחאות.

חזרה

‫Boolean — true אם Field מוסתר, false אחרת.

`isMetric()`

הפונקציה מחזירה true אם השדה הזה הוא מדד.

חזרה

‫Boolean — true אם השדה הזה הוא מדד; מחזירה false אחרת.

`setAggregation(aggregation)`

מגדיר את סוג הצבירה של Field. AggregationType קובע איך Data Studio משלב נתונים דומים במאפיינים. אם מפעילים את הפונקציה הזו על מדד, מוצגת שגיאה.