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

Class Fields

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

var cc = DataStudioApp.createCommunityConnector();
var fields = cc.getFields();
var types = cc.FieldType;

var field1 = fields.newDimension()
  // Set other properties as needed.
  .setId('field1_id');

שיטות

שיטה	סוג הערך שמוחזר	תיאור קצר
`asArray()`	`Field[]`	מחזירה תצוגה של האובייקט כמערך.
`build()`	`Object[]`	הפונקציה מאמתת את האובייקט ומחזירה אותו בפורמט הנדרש ב-Data Studio.
`forIds(ids)`	`Fields`	הפונקציה מחזירה אובייקט `Fields` חדש עם סינון לפי `Field` עם מזהה ב-`ids`.
`getDefaultDimension()`	`Field`	מחזירה את מאפיין ברירת המחדל שיש להשתמש בו עבור קבוצת השדות.
`getDefaultMetric()`	`Field`	מחזירה את מדד ברירת המחדל שיש להשתמש בו עבור קבוצת השדות.
`getFieldById(fieldId)`	`Field`	הפונקציה מחזירה שדה עם מזהה נתון, או `null`, אם אין שדה עם המזהה הזה באובייקט `Fields` הזה.
`newDimension()`	`Field`	מחזירה מאפיין חדש `Field`.
`newMetric()`	`Field`	מחזירה מדד חדש `Field`.
`setDefaultDimension(fieldId)`	`void`	מגדיר את מאפיין ברירת המחדל שישמש בקבוצת השדות.
`setDefaultMetric(fieldId)`	`void`	מגדיר את מדד ברירת המחדל שישמש בקבוצת השדות.

תיעוד מפורט

`asArray()`

מחזירה תצוגה של האובייקט כמערך.

var fields = //reference to fields object.
fields.newDimension().setId('field1_id');
fields.newDimension().setId('field2_id');
fields.newDimension().setId('field3_id');

// Logging the ID of each field:
fields
  .asArray()
  .map(function(field) {
     Logger.log(field.getId());
  });

החזרות

Field[] – מערך של Field אובייקטים.

`build()`

הפונקציה מאמתת את האובייקט ומחזירה אותו בפורמט הנדרש ב-Data Studio.

החזרות

Object[] – נתוני השדות שאומתו, מיוצגים כרשימת אובייקטים.

קליעות

Error – אם לא ניתן לבנות אובייקט תקין.

`forIds(ids)`

הפונקציה מחזירה אובייקט Fields חדש עם סינון לפי Field עם מזהה ב-ids.

var fields = //reference to fields object.
fields.newDimension().setId('field1_id');
fields.newDimension().setId('field2_id');
fields.newDimension().setId('field3_id');

// subsetFields is a Fields object that only contains field1 and field2.
var subsetFields = fields.forIds(['field1_id', 'field3_id']);

פרמטרים

שם	תיאור	התיאור
`ids`	`String[]`	המזהים של השדות שצריך לשמור.

החזרות

Fields - אובייקט Fields חדש.

`getDefaultDimension()`

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

החזרות

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

`getDefaultMetric()`

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

החזרות

Field – המדד שמוגדר כמדד ברירת המחדל, או null אם לא הוגדר מדד ברירת מחדל.

`getFieldById(fieldId)`

הפונקציה מחזירה שדה עם מזהה נתון, או null, אם אין שדה עם המזהה הזה באובייקט Fields הזה.

var fields = //reference to fields object.
var field1 = fields.newDimension().setId('field1_id');

// byId is the same as field1.
var byId = fields.getFieldById('field1_id');

// byId2 is null.
var byId2 = fields.getFieldById('not present id');

פרמטרים

שם	תיאור	התיאור
`fieldId`	`String`	המזהה של השדה שצריך לקבל.

החזרות

Field – Field עם המזהה הנתון, או null אם לא כלול שדה כזה באובייקט Fields הזה.

`newDimension()`

מחזירה מאפיין חדש Field.

החזרות

Field – מאפיין חדש Field.

`newMetric()`

מחזירה מדד חדש Field.

החזרות

Field – מדד חדש Field.

`setDefaultDimension(fieldId)`

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

פרמטרים

שם	תיאור	התיאור
`fieldId`	`String`	המזהה של השדה שיש להשתמש בו כמאפיין ברירת המחדל. המזהה הזה צריך להופיע בקבוצת השדות.

`setDefaultMetric(fieldId)`

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

פרמטרים

שם	תיאור	התיאור
`fieldId`	`String`	מזהה השדה שישמש כמדד ברירת המחדל. המזהה הזה צריך להופיע בקבוצת השדות.