השירות הזה מאפשר לסקריפטים לגשת למחברי קהילה של Data Studio ולשנות אותם.
מחלקות
שם | תיאור קצר |
---|---|
AggregationType | טיפוסים בני מנייה (enum) שמגדיר את סוגי הצבירה שניתן להגדיר עבור Field . |
AuthType | טיפוסים בני מנייה (enum) שמגדיר את סוגי האימות שניתן להגדיר למחבר. |
BigQueryConfig | אובייקט הגדרה למחבר BigQuery מקורי. |
BigQueryParameterType | מאפיין טיפוסים בני מנייה (enum) שמגדיר את סוגי הפרמטרים של BigQuery שאפשר להגדיר. |
Checkbox | מכיל מידע על תיבת הסימון של ההגדרה. |
CommunityConnector | CommunityConnector מאפשרת לסקריפטים לגשת לכלי בנייה ולכלים, כדי לעזור בפיתוח של מחברי קהילה ל-Data Studio. |
Config | מכילה את ערכי התצורה של מחבר. |
DataStudioApp | DataStudioApp מאפשר לסקריפטים ליצור אינטראקציה עם תכונות מוכוונות למפתחים ב-Data Studio. |
DebugError | שגיאה שרק אדמינים של המחבר יכולים לראות. |
Field | מכיל נתונים הקשורים לשדה. |
FieldType | טיפוסים בני מנייה (enum) שמגדיר את הסוגים שניתן להגדיר עבור Field . |
Fields | מכיל קבוצה של ערכי Field למחבר קהילה. |
GetAuthTypeResponse | כלי ליצירת תשובה מסוג getAuthType() לפרויקט הסקריפט. |
GetDataResponse | כלי ליצירת תשובה מסוג getData() לפרויקט הסקריפט. |
GetSchemaResponse | כלי ליצירת תשובה מסוג getSchema() לפרויקט הסקריפט. |
Info | מכיל נתוני מידע עבור התצורה. |
OptionBuilder | כלי ליצירת אפשרויות עבור SelectSingle ו-SelectMultiple . |
SelectMultiple | מכיל מידע לבחירה מרובה עבור התצורה. |
SelectSingle | מכילה מידע נבחר עבור התצורה. |
SetCredentialsResponse | כלי ליצירת תשובה מסוג setCredentials() לפרויקט הסקריפט. |
TextArea | מכיל מידע על אזור הטקסט להגדרה. |
TextInput | מכיל מידע על קלט טקסט עבור התצורה. |
UserError | מוצגת שגיאה למשתמשים של המחבר. |
AggregationType
תכונות
נכס | תיאור | התיאור |
---|---|---|
AVG | Enum | ממוצע. |
COUNT | Enum | ספירה. |
COUNT_DISTINCT | Enum | ספירה ייחודית. |
MAX | Enum | עלות מקסימלית |
MIN | Enum | מינ. |
SUM | Enum | סכום |
AUTO | Enum | אוטומטי. |
AuthType
תכונות
נכס | תיאור | התיאור |
---|---|---|
NONE | Enum | אין צורך בהרשאה. |
OAUTH2 | Enum | נדרשת הרשאת OAuth2. |
USER_PASS | Enum | נדרשים פרטי כניסה עם שם משתמש וסיסמה. |
PATH_USER_PASS | Enum | שם משתמש, נתיב וסיסמה. |
PATH_KEY | Enum | נדרשים נתיב ומפתח. |
KEY | Enum | נדרשים מפתח או אסימון API. |
USER_TOKEN | Enum | נדרשים שם משתמש ואסימון. |
BigQueryConfig
שיטות
שיטה | סוג הערך שמוחזר | תיאור קצר |
---|---|---|
addQueryParameter(name, type, value) | BigQueryConfig | הוספת פרמטר שאילתה ל-BigQueryConfig זה. |
build() | Object | הפונקציה מאמתת את האובייקט ומחזירה אותו בפורמט הנדרש ב-Data Studio. |
printJson() | String | מדפיס את ייצוג ה-JSON של האובייקט הזה. |
setAccessToken(accessToken) | BigQueryConfig | הגדרת אסימון הגישה של BigQueryConfig . |
setBillingProjectId(billingProjectId) | BigQueryConfig | מגדיר את מזהה פרויקט החיוב של BigQueryConfig זה. |
setQuery(query) | BigQueryConfig | מגדיר את שאילתת ה-SQL של BigQueryConfig . |
setUseStandardSql(useStandardSql) | BigQueryConfig | המדיניות הזו קובעת אם השאילתה תפורש כ-SQL סטנדרטי או מדור קודם. |
BigQueryParameterType
תכונות
נכס | תיאור | התיאור |
---|---|---|
STRING | Enum | מחרוזת. |
INT64 | Enum | מספר שלם ב-64 ביט. |
BOOL | Enum | בוליאני. |
FLOAT64 | Enum | מספר נקודה צפה (floating-point) של 64 סיביות. |
Checkbox
שיטות
שיטה | סוג הערך שמוחזר | תיאור קצר |
---|---|---|
setAllowOverride(allowOverride) | Checkbox | מאפשר ביטול של רשומת ההגדרה הזו. |
setHelpText(helpText) | Checkbox | מגדיר את טקסט העזרה עבור רשומת התצורה הזו. |
setId(id) | Checkbox | מגדיר את המזהה הייחודי עבור רשומת התצורה הזו. |
setIsDynamic(isDynamic) | Checkbox | מגדיר את הסטטוס הדינמי של רשומת התצורה הזו. |
setName(name) | Checkbox | מגדיר את שם התצוגה עבור רשומת התצורה הזו. |
CommunityConnector
תכונות
נכס | תיאור | התיאור |
---|---|---|
AggregationType | AggregationType | המספור AggregationType . |
AuthType | AuthType | המספור AuthType . |
BigQueryParameterType | BigQueryParameterType | המספור BigQueryParameterType . |
FieldType | FieldType | המספור FieldType . |
שיטות
שיטה | סוג הערך שמוחזר | תיאור קצר |
---|---|---|
getConfig() | Config | מחזירה אובייקט Config . |
getFields() | Fields | מחזירה אובייקט Fields . |
newAuthTypeResponse() | GetAuthTypeResponse | מחזירה אובייקט GetAuthTypeResponse חדש. |
newBigQueryConfig() | BigQueryConfig | מחזירה אובייקט BigQueryConfig חדש. |
newDebugError() | DebugError | מחזירה אובייקט DebugError חדש. |
newGetDataResponse() | GetDataResponse | מחזירה אובייקט GetDataResponse חדש. |
newGetSchemaResponse() | GetSchemaResponse | מחזירה אובייקט GetSchemaResponse חדש. |
newSetCredentialsResponse() | SetCredentialsResponse | מחזירה אובייקט SetCredentialsResponse חדש. |
newUserError() | UserError | מחזירה אובייקט UserError חדש. |
Config
שיטות
שיטה | סוג הערך שמוחזר | תיאור קצר |
---|---|---|
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() עם ההגדרות האישיות הנוכחיות של המשתמש. |
DataStudioApp
שיטות
שיטה | סוג הערך שמוחזר | תיאור קצר |
---|---|---|
createCommunityConnector() | CommunityConnector | יצירת מחבר קהילה חדש. |
DebugError
שיטות
שיטה | סוג הערך שמוחזר | תיאור קצר |
---|---|---|
printJson() | String | מדפיס את ייצוג ה-JSON של האובייקט הזה. |
setText(text) | DebugError | מגדירה את הטקסט של השגיאה של ניפוי הבאגים, שיוצג רק לאדמינים. |
throwException() | void | הפעלה של התרעה על חריגה. |
Field
שיטות
שיטה | סוג הערך שמוחזר | תיאור קצר |
---|---|---|
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 . |
FieldType
תכונות
נכס | תיאור | התיאור |
---|---|---|
YEAR | Enum | שנה בפורמט YYYY, למשל 2017. |
YEAR_QUARTER | Enum | שנה ורבעון, בפורמט YYYYQ, למשל 20171. |
YEAR_MONTH | Enum | שנה וחודש בפורמט YYYYMM, למשל 201703. |
YEAR_WEEK | Enum | שנה ושבוע בפורמט YYYYww, למשל 201707. |
YEAR_MONTH_DAY | Enum | שנה, חודש ויום בפורמט YYYYMMDD, למשל 20170317. |
YEAR_MONTH_DAY_HOUR | Enum | שנה, חודש, יום ושעה בפורמט YYYYMMDDHH, למשל 2017031703. |
YEAR_MONTH_DAY_MINUTE | Enum | שנה, חודש, יום, שעה ודקה בפורמט YYYYMMDDHHmm, למשל 201703170230. |
YEAR_MONTH_DAY_SECOND | Enum | שנה, חודש, יום, שעה, דקה ושנייה בפורמט YYYYMMDDHHmms, למשל 20170317023017. |
QUARTER | Enum | רבעון בפורמט 1, 2, 3 או 4). |
MONTH | Enum | חודש בפורמט MM, למשל 03. |
WEEK | Enum | שבוע בפורמט ww, למשל 07. |
MONTH_DAY | Enum | חודש ויום בפורמט MMDD, למשל 0317. |
DAY_OF_WEEK | Enum | מספר בטווח של [0,6] שבו 0 מייצג את יום ראשון. |
DAY | Enum | יום בפורמט DD, למשל 17. |
HOUR | Enum | שעה בפורמט של HH, למשל 13. |
MINUTE | Enum | דקות בפורמט מ"מ, למשל 12. |
DURATION | Enum | משך זמן בשניות. |
COUNTRY | Enum | מדינה כמו ארצות הברית. |
COUNTRY_CODE | Enum | קוד מדינה, כמו US. |
CONTINENT | Enum | יבשת כמו יבשת אמריקה. |
CONTINENT_CODE | Enum | קוד יבשתי כמו 019. |
SUB_CONTINENT | Enum | תת-יבשת, כמו צפון אמריקה. |
SUB_CONTINENT_CODE | Enum | קוד של תת-יבשת, כמו 003. |
REGION | Enum | אזור כמו קליפורניה. |
REGION_CODE | Enum | קוד אזור, כמו CA. |
CITY | Enum | עיר כמו מאונטן ויו. |
CITY_CODE | Enum | קוד עיר, כמו 1014044. |
METRO | Enum | מטרופולין כמו סן פרנסיסקו-אוקלנד-סן חוזה. |
METRO_CODE | Enum | קוד מטרו, כמו 200807. |
LATITUDE_LONGITUDE | Enum | צמד של קווי אורך ורוחב, כמו 51.5074, -0.1278. |
NUMBER | Enum | מספר עשרוני. |
PERCENT | Enum | האחוז העשרוני (יכול להיות מעל 1.0). |
TEXT | Enum | טקסט חופשי. |
BOOLEAN | Enum | ערך בוליאני true או false . |
URL | Enum | כתובת URL, כמו טקסט, כמו https://google.com. |
HYPERLINK | Enum | היפר-קישור. |
IMAGE | Enum | תמונה. |
IMAGE_LINK | Enum | קישור לתמונה. |
CURRENCY_AED | Enum | מטבע מ-AED. |
CURRENCY_ALL | Enum | מטבע מ-ALL. |
CURRENCY_ARS | Enum | המטבע מ-ARS |
CURRENCY_AUD | Enum | מטבע מ-AUD. |
CURRENCY_BDT | Enum | מטבע במטבע BDT. |
CURRENCY_BGN | Enum | מטבע של BGN. |
CURRENCY_BOB | Enum | מטבע מ-BOB. |
CURRENCY_BRL | Enum | מטבע מריאל ברזילאי (BRL). |
CURRENCY_CAD | Enum | המטבע דולר קנדי. |
CURRENCY_CDF | Enum | מטבע מ-CDF. |
CURRENCY_CHF | Enum | מטבע של CHF. |
CURRENCY_CLP | Enum | מטבע מ-CLP. |
CURRENCY_CNY | Enum | מטבע מ-CNY. |
CURRENCY_COP | Enum | המטבע של COP. |
CURRENCY_CRC | Enum | מטבע במטבע CRC. |
CURRENCY_CZK | Enum | מטבע CZK. |
CURRENCY_DKK | Enum | מטבע במטבע DKK. |
CURRENCY_DOP | Enum | מטבע מ-DOP. |
CURRENCY_EGP | Enum | מטבע מ-EGP. |
CURRENCY_ETB | Enum | מטבע מ-ETB. |
CURRENCY_EUR | Enum | מטבע מאירו. |
CURRENCY_GBP | Enum | המטבע החל מ-GBP. |
CURRENCY_HKD | Enum | מטבע HKD. |
CURRENCY_HRK | Enum | מטבע בקונה קרואטי (HRK). |
CURRENCY_HUF | Enum | מטבע מ-HUF. |
CURRENCY_IDR | Enum | המטבע הוא IDR. |
CURRENCY_ILS | Enum | מטבע בש"ח. |
CURRENCY_INR | Enum | מטבע ברופי הודי (INR). |
CURRENCY_IRR | Enum | מטבע של IRR. |
CURRENCY_ISK | Enum | המטבע ב-ISK. |
CURRENCY_JMD | Enum | המטבע של יפן (JMD). |
CURRENCY_JPY | Enum | מטבע מ-JPY. |
CURRENCY_KRW | Enum | המטבע בוון דרום קוריאני (KRW). |
CURRENCY_LKR | Enum | המטבע ב-LKR. |
CURRENCY_LTL | Enum | המטבע מ-LTL. |
CURRENCY_MNT | Enum | מטבע מ-MNT. |
CURRENCY_MVR | Enum | מטבע מ-MVR. |
CURRENCY_MXN | Enum | מטבע מפזו מקסיקני (MXN). |
CURRENCY_MYR | Enum | מטבע: MYR. |
CURRENCY_NGN | Enum | מטבע מ-NGN. |
CURRENCY_NOK | Enum | מטבע NOK. |
CURRENCY_NZD | Enum | מטבע מ-NZD. |
CURRENCY_PAB | Enum | המטבע מ-PAB. |
CURRENCY_PEN | Enum | מטבע מ-PEN. |
CURRENCY_PHP | Enum | מטבע מ-PHP. |
CURRENCY_PKR | Enum | המטבע ב-PKR. |
CURRENCY_PLN | Enum | מטבע מ-PLN. |
CURRENCY_RON | Enum | מטבע מ-RON. |
CURRENCY_RSD | Enum | המטבע של RSD. |
CURRENCY_RUB | Enum | מטבע ברובל רוסי (RUB). |
CURRENCY_SAR | Enum | מטבע מ-SAR. |
CURRENCY_SEK | Enum | מטבע ב-SEK. |
CURRENCY_SGD | Enum | המטבע של סינגפור (SGD) |
CURRENCY_THB | Enum | מטבע ב-THB. |
CURRENCY_TRY | Enum | מטבע מ-TRY. |
CURRENCY_TWD | Enum | מטבע מ-TWD. |
CURRENCY_TZS | Enum | מטבע מ-TZS. |
CURRENCY_UAH | Enum | המטבע במטבע UAH. |
CURRENCY_USD | Enum | מטבע מדולר ארה"ב. |
CURRENCY_UYU | Enum | מטבע מ-UYU. |
CURRENCY_VEF | Enum | מטבע מ-VEF. |
CURRENCY_VND | Enum | מטבע של VND. |
CURRENCY_YER | Enum | מטבע מ-YER. |
CURRENCY_ZAR | Enum | מטבע ZAR. |
Fields
שיטות
שיטה | סוג הערך שמוחזר | תיאור קצר |
---|---|---|
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 | מגדיר את מדד ברירת המחדל שישמש בקבוצת השדות. |
GetAuthTypeResponse
שיטות
שיטה | סוג הערך שמוחזר | תיאור קצר |
---|---|---|
build() | Object | הפונקציה מאמתת את האובייקט ומחזירה אותו בפורמט הנדרש ב-Data Studio. |
printJson() | String | מדפיס את ייצוג ה-JSON של האובייקט הזה. |
setAuthType(authType) | GetAuthTypeResponse | מגדיר את AuthType של הכלי. |
setHelpUrl(helpUrl) | GetAuthTypeResponse | מגדיר את כתובת ה-URL לעזרה של הכלי. |
GetDataResponse
שיטות
שיטה | סוג הערך שמוחזר | תיאור קצר |
---|---|---|
addAllRows(rows) | GetDataResponse | הוספה של מספר שורות נתונים לGetDataResponse . |
addRow(row) | GetDataResponse | הוספה של שורת נתונים אל GetDataResponse . |
build() | Object | הפונקציה מאמתת את האובייקט ומחזירה אותו בפורמט הנדרש ב-Data Studio. |
setFields(fields) | GetDataResponse | מגדיר את Fields של הכלי. |
setFiltersApplied(filtersApplied) | GetDataResponse | מגדיר את הסטטוס של המסננים שהוחלו על הכלי הזה. |
GetSchemaResponse
שיטות
שיטה | סוג הערך שמוחזר | תיאור קצר |
---|---|---|
build() | Object | הפונקציה מאמתת את האובייקט ומחזירה אותו בפורמט הנדרש ב-Data Studio. |
printJson() | String | מדפיס את ייצוג ה-JSON של האובייקט הזה. |
setFields(fields) | GetSchemaResponse | מגדיר את Fields של הכלי. |
Info
שיטות
שיטה | סוג הערך שמוחזר | תיאור קצר |
---|---|---|
setId(id) | Info | מגדיר את המזהה הייחודי עבור רשומת התצורה הזו. |
setText(text) | Info | מגדיר את הטקסט עבור רשומת התצורה הזו. |
OptionBuilder
שיטות
שיטה | סוג הערך שמוחזר | תיאור קצר |
---|---|---|
setLabel(label) | OptionBuilder | מגדיר את התווית של בונה האפשרויות הזה. |
setValue(value) | OptionBuilder | הגדרת הערך של הכלי הזה ליצירת אפשרויות. |
SelectMultiple
שיטות
שיטה | סוג הערך שמוחזר | תיאור קצר |
---|---|---|
addOption(optionBuilder) | SelectMultiple | הוספת אפשרות בחירה חדשה. |
setAllowOverride(allowOverride) | SelectMultiple | מאפשר ביטול של רשומת ההגדרה הזו. |
setHelpText(helpText) | SelectMultiple | מגדיר את טקסט העזרה עבור רשומת התצורה הזו. |
setId(id) | SelectMultiple | מגדיר את המזהה הייחודי עבור רשומת התצורה הזו. |
setIsDynamic(isDynamic) | SelectMultiple | מגדיר את הסטטוס הדינמי של רשומת התצורה הזו. |
setName(name) | SelectMultiple | מגדיר את שם התצוגה עבור רשומת התצורה הזו. |
SelectSingle
שיטות
שיטה | סוג הערך שמוחזר | תיאור קצר |
---|---|---|
addOption(optionBuilder) | SelectSingle | הוספת אפשרות בחירה חדשה. |
setAllowOverride(allowOverride) | SelectSingle | מאפשר ביטול של רשומת ההגדרה הזו. |
setHelpText(helpText) | SelectSingle | מגדיר את טקסט העזרה עבור רשומת התצורה הזו. |
setId(id) | SelectSingle | מגדיר את המזהה הייחודי עבור רשומת התצורה הזו. |
setIsDynamic(isDynamic) | SelectSingle | מגדיר את הסטטוס הדינמי של רשומת התצורה הזו. |
setName(name) | SelectSingle | מגדיר את שם התצוגה עבור רשומת התצורה הזו. |
SetCredentialsResponse
שיטות
שיטה | סוג הערך שמוחזר | תיאור קצר |
---|---|---|
build() | Object | הפונקציה מאמתת את האובייקט ומחזירה אותו בפורמט הנדרש ב-Data Studio. |
printJson() | String | מדפיס את ייצוג ה-JSON של האובייקט הזה. |
setIsValid(isValid) | SetCredentialsResponse | הגדרת הסטטוס החוקי של הפריט SetCredentialsResponse . |
TextArea
שיטות
שיטה | סוג הערך שמוחזר | תיאור קצר |
---|---|---|
setAllowOverride(allowOverride) | TextArea | מאפשר ביטול של רשומת ההגדרה הזו. |
setHelpText(helpText) | TextArea | מגדיר את טקסט העזרה עבור רשומת התצורה הזו. |
setId(id) | TextArea | מגדיר את המזהה הייחודי עבור רשומת התצורה הזו. |
setIsDynamic(isDynamic) | TextArea | מגדיר את הסטטוס הדינמי של רשומת התצורה הזו. |
setName(name) | TextArea | מגדיר את שם התצוגה עבור רשומת התצורה הזו. |
setPlaceholder(placeholder) | TextArea | מגדיר את הטקסט של ה-placeholder עבור רשומת התצורה הזו. |
TextInput
שיטות
שיטה | סוג הערך שמוחזר | תיאור קצר |
---|---|---|
setAllowOverride(allowOverride) | TextInput | מאפשר ביטול של רשומת ההגדרה הזו. |
setHelpText(helpText) | TextInput | מגדיר את טקסט העזרה עבור רשומת התצורה הזו. |
setId(id) | TextInput | מגדיר את המזהה הייחודי עבור רשומת התצורה הזו. |
setIsDynamic(isDynamic) | TextInput | מגדיר את הסטטוס הדינמי של רשומת התצורה הזו. |
setName(name) | TextInput | מגדיר את שם התצוגה עבור רשומת התצורה הזו. |
setPlaceholder(placeholder) | TextInput | מגדיר את הטקסט של ה-placeholder עבור רשומת התצורה הזו. |
UserError
שיטות
שיטה | סוג הערך שמוחזר | תיאור קצר |
---|---|---|
printJson() | String | מדפיס את ייצוג ה-JSON של האובייקט הזה. |
setDebugText(text) | UserError | מגדירה את הטקסט של השגיאה של ניפוי הבאגים, שיוצג רק לאדמינים. |
setText(text) | UserError | מגדיר את הטקסט של שגיאת המשתמש. |
throwException() | void | הפעלה של התרעה על חריגה. |