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[] – נתוני השדה המאושרים, שמוצגים כרשימה של אובייקטים.

זריקות

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	המזהה של השדה שישמש כמדד ברירת המחדל. המזהה הזה חייב להופיע בקבוצת השדות.