Data Studio Service

Data Studio

השירות הזה מאפשר לסקריפטים לגשת למחברי קהילה של Data Studio ולשנות אותם.

מחלקות

שםתיאור קצר
AggregationTypeטיפוסים בני מנייה (enum) שמגדיר את סוגי הצבירה שניתן להגדיר עבור Field.
AuthTypeטיפוסים בני מנייה (enum) שמגדיר את סוגי האימות שניתן להגדיר למחבר.
BigQueryConfigאובייקט הגדרה למחבר BigQuery מקורי.
BigQueryParameterTypeמאפיין טיפוסים בני מנייה (enum) שמגדיר את סוגי הפרמטרים של BigQuery שאפשר להגדיר.
Checkboxמכיל מידע על תיבת הסימון של ההגדרה.
CommunityConnectorCommunityConnector מאפשרת לסקריפטים לגשת לכלי בנייה ולכלים, כדי לעזור בפיתוח של מחברי קהילה ל-Data Studio.
Configמכילה את ערכי התצורה של מחבר.
DataStudioAppDataStudioApp מאפשר לסקריפטים ליצור אינטראקציה עם תכונות מוכוונות למפתחים ב-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

תכונות

נכסתיאורהתיאור
AVGEnumממוצע.
COUNTEnumספירה.
COUNT_DISTINCTEnumספירה ייחודית.
MAXEnumעלות מקסימלית
MINEnumמינ.
SUMEnumסכום
AUTOEnumאוטומטי.

AuthType

תכונות

נכסתיאורהתיאור
NONEEnumאין צורך בהרשאה.
OAUTH2Enumנדרשת הרשאת OAuth2.
USER_PASSEnumנדרשים פרטי כניסה עם שם משתמש וסיסמה.
PATH_USER_PASSEnumשם משתמש, נתיב וסיסמה.
PATH_KEYEnumנדרשים נתיב ומפתח.
KEYEnumנדרשים מפתח או אסימון API.
USER_TOKENEnumנדרשים שם משתמש ואסימון.

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

תכונות

נכסתיאורהתיאור
STRINGEnumמחרוזת.
INT64Enumמספר שלם ב-64 ביט.
BOOLEnumבוליאני.
FLOAT64Enumמספר נקודה צפה (floating-point) של 64 סיביות.

Checkbox

שיטות

שיטהסוג הערך שמוחזרתיאור קצר
setAllowOverride(allowOverride)Checkboxמאפשר ביטול של רשומת ההגדרה הזו.
setHelpText(helpText)Checkboxמגדיר את טקסט העזרה עבור רשומת התצורה הזו.
setId(id)Checkboxמגדיר את המזהה הייחודי עבור רשומת התצורה הזו.
setIsDynamic(isDynamic)Checkboxמגדיר את הסטטוס הדינמי של רשומת התצורה הזו.
setName(name)Checkboxמגדיר את שם התצוגה עבור רשומת התצורה הזו.

CommunityConnector

תכונות

נכסתיאורהתיאור
AggregationTypeAggregationTypeהמספור AggregationType.
AuthTypeAuthTypeהמספור AuthType.
BigQueryParameterTypeBigQueryParameterTypeהמספור BigQueryParameterType.
FieldTypeFieldTypeהמספור 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

תכונות

נכסתיאורהתיאור
YEAREnumשנה בפורמט YYYY, למשל 2017.
YEAR_QUARTEREnumשנה ורבעון, בפורמט YYYYQ, למשל 20171.
YEAR_MONTHEnumשנה וחודש בפורמט YYYYMM, למשל 201703.
YEAR_WEEKEnumשנה ושבוע בפורמט YYYYww, למשל 201707.
YEAR_MONTH_DAYEnumשנה, חודש ויום בפורמט YYYYMMDD, למשל 20170317.
YEAR_MONTH_DAY_HOUREnumשנה, חודש, יום ושעה בפורמט YYYYMMDDHH, למשל 2017031703.
YEAR_MONTH_DAY_MINUTEEnumשנה, חודש, יום, שעה ודקה בפורמט YYYYMMDDHHmm, למשל 201703170230.
YEAR_MONTH_DAY_SECONDEnumשנה, חודש, יום, שעה, דקה ושנייה בפורמט YYYYMMDDHHmms, למשל 20170317023017.
QUARTEREnumרבעון בפורמט 1, 2, 3 או 4).
MONTHEnumחודש בפורמט MM, למשל 03.
WEEKEnumשבוע בפורמט ww, למשל 07.
MONTH_DAYEnumחודש ויום בפורמט MMDD, למשל 0317.
DAY_OF_WEEKEnumמספר בטווח של [0,6] שבו 0 מייצג את יום ראשון.
DAYEnumיום בפורמט DD, למשל 17.
HOUREnumשעה בפורמט של HH, למשל 13.
MINUTEEnumדקות בפורמט מ"מ, למשל 12.
DURATIONEnumמשך זמן בשניות.
COUNTRYEnumמדינה כמו ארצות הברית.
COUNTRY_CODEEnumקוד מדינה, כמו US.
CONTINENTEnumיבשת כמו יבשת אמריקה.
CONTINENT_CODEEnumקוד יבשתי כמו 019.
SUB_CONTINENTEnumתת-יבשת, כמו צפון אמריקה.
SUB_CONTINENT_CODEEnumקוד של תת-יבשת, כמו 003.
REGIONEnumאזור כמו קליפורניה.
REGION_CODEEnumקוד אזור, כמו CA.
CITYEnumעיר כמו מאונטן ויו.
CITY_CODEEnumקוד עיר, כמו 1014044.
METROEnumמטרופולין כמו סן פרנסיסקו-אוקלנד-סן חוזה.
METRO_CODEEnumקוד מטרו, כמו 200807.
LATITUDE_LONGITUDEEnumצמד של קווי אורך ורוחב, כמו 51.5074, -0.1278.
NUMBEREnumמספר עשרוני.
PERCENTEnumהאחוז העשרוני (יכול להיות מעל 1.0).
TEXTEnumטקסט חופשי.
BOOLEANEnumערך בוליאני true או false.
URLEnumכתובת URL, כמו טקסט, כמו https://google.com.
HYPERLINKEnumהיפר-קישור.
IMAGEEnumתמונה.
IMAGE_LINKEnumקישור לתמונה.
CURRENCY_AEDEnumמטבע מ-AED.
CURRENCY_ALLEnumמטבע מ-ALL.
CURRENCY_ARSEnumהמטבע מ-ARS
CURRENCY_AUDEnumמטבע מ-AUD.
CURRENCY_BDTEnumמטבע במטבע BDT.
CURRENCY_BGNEnumמטבע של BGN.
CURRENCY_BOBEnumמטבע מ-BOB.
CURRENCY_BRLEnumמטבע מריאל ברזילאי (BRL).
CURRENCY_CADEnumהמטבע דולר קנדי.
CURRENCY_CDFEnumמטבע מ-CDF.
CURRENCY_CHFEnumמטבע של CHF.
CURRENCY_CLPEnumמטבע מ-CLP.
CURRENCY_CNYEnumמטבע מ-CNY.
CURRENCY_COPEnumהמטבע של COP.
CURRENCY_CRCEnumמטבע במטבע CRC.
CURRENCY_CZKEnumמטבע CZK.
CURRENCY_DKKEnumמטבע במטבע DKK.
CURRENCY_DOPEnumמטבע מ-DOP.
CURRENCY_EGPEnumמטבע מ-EGP.
CURRENCY_ETBEnumמטבע מ-ETB.
CURRENCY_EUREnumמטבע מאירו.
CURRENCY_GBPEnumהמטבע החל מ-GBP.
CURRENCY_HKDEnumמטבע HKD.
CURRENCY_HRKEnumמטבע בקונה קרואטי (HRK).
CURRENCY_HUFEnumמטבע מ-HUF.
CURRENCY_IDREnumהמטבע הוא IDR.
CURRENCY_ILSEnumמטבע בש"ח.
CURRENCY_INREnumמטבע ברופי הודי (INR).
CURRENCY_IRREnumמטבע של IRR.
CURRENCY_ISKEnumהמטבע ב-ISK.
CURRENCY_JMDEnumהמטבע של יפן (JMD).
CURRENCY_JPYEnumמטבע מ-JPY.
CURRENCY_KRWEnumהמטבע בוון דרום קוריאני (KRW).
CURRENCY_LKREnumהמטבע ב-LKR.
CURRENCY_LTLEnumהמטבע מ-LTL.
CURRENCY_MNTEnumמטבע מ-MNT.
CURRENCY_MVREnumמטבע מ-MVR.
CURRENCY_MXNEnumמטבע מפזו מקסיקני (MXN).
CURRENCY_MYREnumמטבע: MYR.
CURRENCY_NGNEnumמטבע מ-NGN.
CURRENCY_NOKEnumמטבע NOK.
CURRENCY_NZDEnumמטבע מ-NZD.
CURRENCY_PABEnumהמטבע מ-PAB.
CURRENCY_PENEnumמטבע מ-PEN.
CURRENCY_PHPEnumמטבע מ-PHP.
CURRENCY_PKREnumהמטבע ב-PKR.
CURRENCY_PLNEnumמטבע מ-PLN.
CURRENCY_RONEnumמטבע מ-RON.
CURRENCY_RSDEnumהמטבע של RSD.
CURRENCY_RUBEnumמטבע ברובל רוסי (RUB).
CURRENCY_SAREnumמטבע מ-SAR.
CURRENCY_SEKEnumמטבע ב-SEK.
CURRENCY_SGDEnumהמטבע של סינגפור (SGD)
CURRENCY_THBEnumמטבע ב-THB.
CURRENCY_TRYEnumמטבע מ-TRY.
CURRENCY_TWDEnumמטבע מ-TWD.
CURRENCY_TZSEnumמטבע מ-TZS.
CURRENCY_UAHEnumהמטבע במטבע UAH.
CURRENCY_USDEnumמטבע מדולר ארה"ב.
CURRENCY_UYUEnumמטבע מ-UYU.
CURRENCY_VEFEnumמטבע מ-VEF.
CURRENCY_VNDEnumמטבע של VND.
CURRENCY_YEREnumמטבע מ-YER.
CURRENCY_ZAREnumמטבע 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הפעלה של התרעה על חריגה.