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

Class Field

מכיל נתונים שקשורים לשדות. המאפיינים שלו קובעים את אופן השימוש בשדה ב-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. הנוסחאות מגדירות טרנספורמציה של נתונים 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 המערכת של Studio משלבת נתונים דומים למאפיינים. הפעולה הזו גורמת לשגיאה אם נשלחת קריאה למדד.