Class Config

Config

מכיל את רשומות ההגדרה של המחבר. ערכי ההגדרה האלה מגדירים אילו שאלות יוצגו כשמוסיפים מחבר חדש.

const cc = DataStudioApp.createCommunityConnector();
const config = cc.getConfig();

const info_entry = config.newInfo().setId('info_id').setHelpText(
    'This connector can connect to multiple data endpoints.');

Methods

שיטהסוג הערך שמוחזרתיאור קצר
build()Objectמאמת את האובייקט הזה ומחזיר אותו בפורמט שנדרש על ידי Data Studio.
newCheckbox()Checkboxמחזירה רשומה חדשה של הגדרת תיבת סימון.
newInfo()Infoמחזירה רשומה חדשה של הגדרת מידע.
newOptionBuilder()OptionBuilderמחזירה כלי חדש ליצירת אפשרויות.
newSelectMultiple()SelectMultipleמחזירה רשומה חדשה של הגדרת בחירה מרובה.
newSelectSingle()SelectSingleמחזירה רשומה חדשה של הגדרת בחירה יחידה.
newTextArea()TextAreaמחזירה רשומה חדשה של הגדרות לאזור טקסט.
newTextInput()TextInputמחזירה רשומה חדשה של הגדרת קלט טקסט.
printJson()Stringמדפיס את הייצוג של האובייקט הזה ב-JSON.
setDateRangeRequired(dateRangeRequired)Configאם true, מציינים טווח תאריכים לבקשות getData().
setIsSteppedConfig(isSteppedConfig)Configאם true, מתבצעת קריאה חוזרת של getConfig() עם הגדרת המשתמש הנוכחית.

תיעוד מפורט

build()

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

חזרה

Object – אובייקט Config שעבר אימות.


newCheckbox()

מחזירה רשומה חדשה של הגדרת תיבת סימון.

חזרה

Checkbox — רשומה חדשה של הגדרת תיבת סימון.


newInfo()

מחזירה רשומה חדשה של הגדרת מידע.

חזרה

Info – רשומה חדשה של הגדרת מידע.


newOptionBuilder()

מחזירה כלי חדש ליצירת אפשרויות.

חזרה

OptionBuilder — כלי חדש ליצירת אפשרויות.


newSelectMultiple()

מחזירה רשומה חדשה של הגדרת בחירה מרובה.

חזרה

SelectMultiple – רשומה חדשה של הגדרה לבחירת כמה אפשרויות.


newSelectSingle()

מחזירה רשומה חדשה של הגדרת בחירה יחידה.

חזרה

SelectSingle — רשומה חדשה של בחירת הגדרה יחידה.


newTextArea()

מחזירה רשומה חדשה של הגדרות לאזור טקסט.

חזרה

TextArea – רשומה חדשה של הגדרת שדה טקסט.


newTextInput()

מחזירה רשומה חדשה של הגדרת קלט טקסט.

חזרה

TextInput — רשומה חדשה של הגדרת קלט טקסט.


printJson()

מדפיס את הייצוג של האובייקט הזה ב-JSON. הפעולה הזו מיועדת לניפוי באגים בלבד.

חזרה

String


setDateRangeRequired(dateRangeRequired)

אם true, מציינים טווח תאריכים לבקשות getData().

פרמטרים

שםסוגתיאור
dateRangeRequiredBooleanהאם צריך לציין טווח תאריכים בבקשות אל getData().

חזרה

Config – ה-builder הזה, לשרשור.


setIsSteppedConfig(isSteppedConfig)

אם true, מתבצעת קריאה חוזרת של getConfig() עם הגדרת המשתמש הנוכחית.

פרמטרים

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

חזרה

Config – ה-builder הזה, לשרשור.