דף זה תורגם על ידי Cloud Translation API.

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 – ה-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 משלבת נתונים דומים למאפיינים. אם קוראים לפונקציה הזו לגבי מדד, תופיע שגיאה.