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

החזרות

String - הנוסחה לשדה הזה.


getGroup()

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

החזרות

String - הקבוצה של השדה הזה.


getId()

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

החזרות

String - המזהה של השדה הזה.


getIsReaggregatable()

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

החזרות

Booleantrue אם אפשר לצבור מחדש את השדה הזה. אחרת, false.


getName()

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

החזרות

String - השם של השדה הזה.


getType()

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

החזרות

FieldType - הסוג של השדה הזה.


isDefault()

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

החזרות

Booleantrue אם Field הוא המדד או המאפיין המוגדרים כברירת מחדל. אם לא, false אחרת.


isDimension()

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

החזרות

Booleantrue אם השדה הזה הוא מאפיין. אחרת, הפונקציה מחזירה את הערך false.


isHidden()

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

החזרות

Booleantrue אם Field הזה מוסתר. אחרת, false.


isMetric()

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

החזרות

Boolean - true אם השדה הזה הוא מדד; הפונקציה מחזירה את הערך false אחרת.


setAggregation(aggregation)

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

פרמטרים

שםתיאורהתיאור
aggregationAggregationTypeסוג הצבירה להגדרה.

החזרות

Field – הכלי הזה – לשרשורים.


setDescription(description)

מגדיר את התיאור של Field. התיאורים מספקים הסברים קצרים על מטרת השדה.

פרמטרים

שםתיאורהתיאור
descriptionStringהתיאור להגדרה.

החזרות

Field – הכלי הזה – לשרשורים.


setFormula(formula)

מגדיר את הנוסחה של Field. נוסחאות מגדירות טרנספורמציה של נתונים ש-Data Studio מפעיל בזמן השאילתה.

פרמטרים

שםתיאורהתיאור
formulaStringהנוסחה להגדרה.

החזרות

Field – הכלי הזה – לשרשורים.


setGroup(group)

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

פרמטרים

שםתיאורהתיאור
groupStringהקבוצה להגדרה.

החזרות

Field – הכלי הזה – לשרשורים.


setId(id)

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

פרמטרים

שםתיאורהתיאור
idStringהמזהה שצריך להגדיר.

החזרות

Field – הכלי הזה – לשרשורים.


setIsHidden(isHidden)

מגדיר את סטטוס ההסתרה של Field. אפשר להשתמש בשדות מוסתרים בנוסחאות, אבל לא בתרשימים. לא ניתן להסתיר שדות שמכילים נוסחאות.

פרמטרים

שםתיאורהתיאור
isHiddenBooleanסטטוס ההסתרה שצריך להגדיר.

החזרות

Field – הכלי הזה – לשרשורים.


setIsReaggregatable(isReaggregatable)

המדיניות הזו מגדירה את סטטוס 'ניתנה לצבירה' של Field. ניסיון להגדיר סוג צבירה בשדה שלא ניתן לצבור מחדש יוביל לשגיאה.

פרמטרים

שםתיאורהתיאור
isReaggregatableBooleanהסטטוס המותר לצבירה.

החזרות

Field – הכלי הזה – לשרשורים.


setName(name)

הגדרת השם של Field. השמות מוצגים למשתמש כדי להבדיל בין שדות.

פרמטרים

שםתיאורהתיאור
nameStringהשם להגדרה.

החזרות

Field – הכלי הזה – לשרשורים.


setType(type)

מגדיר את FieldType של Field.

פרמטרים

שםתיאורהתיאור
typeFieldTypeהסוג שצריך להגדיר.

החזרות

Field – הכלי הזה – לשרשורים.