Class Fields

שדות

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

const cc = DataStudioApp.createCommunityConnector();
const fields = cc.getFields();

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

Methods

שיטה	סוג הערך שמוחזר	תיאור קצר
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()

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

const fields = DataStudioApp.createCommunityConnector().getFields();
fields.newDimension().setId('field1_id');
fields.newDimension().setId('field2_id');
fields.newDimension().setId('field3_id');

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

חזרה

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

---

build()

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

חזרה

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

מקפיצה את הודעות השגיאה (Throws)

‫Error – אם אי אפשר ליצור אובייקט תקין.

---

forIds(ids)

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

const fields = DataStudioApp.createCommunityConnector().getFields();
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.
const subsetFields = fields.forIds(['field1_id', 'field3_id']);

פרמטרים

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

חזרה

‫Fields – אובייקט Fields חדש.

---

getDefaultDimension()

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

חזרה

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

---

getDefaultMetric()

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

חזרה

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

---

getFieldById(fieldId)

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

const fields = DataStudioApp.createCommunityConnector().getFields();
const field1 = fields.newDimension().setId('field1_id');

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

// byId2 is null.
const 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	המזהה של השדה שבו רוצים להשתמש כמדד ברירת המחדל. המזהה הזה צריך להופיע בקבוצת השדות.