Data Studio Service

Data Studio

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

שיעורים

שםתיאור קצר
AggregationTypeמאגר ערכים שמגדיר את סוגי הצבירה שאפשר להגדיר ל-Field.
AuthTypeenum שמגדיר את סוגי האימות שאפשר להגדיר למחבר.
BigQueryConfigאובייקט תצורה למחבר BigQuery מקורי.
BigQueryParameterTypeenum שמגדיר את סוגי הפרמטרים של BigQuery שאפשר להגדיר.
Checkboxמכיל את פרטי התיבות הסימון של ההגדרה.
CommunityConnector‏CommunityConnector מאפשר לסקריפטים לגשת ל-builders ולכלי עזר כדי לעזור בפיתוח של מחברי קהילה ל-Data Studio.
Configמכיל את רשומות התצורה של מחבר.
DataStudioAppאפליקציית DataStudio מאפשרת לסקריפטים לקיים אינטראקציה עם תכונות של Data Studio שמתמקדות במפתחים.
DebugErrorשגיאה שגלומה רק לאדמינים של המחבר.
Fieldמכיל נתונים שקשורים לשדה.
FieldTypeenum שמגדיר את הסוגים שאפשר להגדיר ל-Field.
Fieldsמכיל קבוצה של Fields למחבר קהילה.
GetAuthTypeResponseה-builder יוצר תגובה מסוג getAuthType() לפרויקט הסקריפט.
GetDataResponseה-builder יוצר תגובה מסוג getData() לפרויקט הסקריפט.
GetSchemaResponseה-builder יוצר תגובה מסוג getSchema() לפרויקט הסקריפט.
Infoמכיל נתוני מידע של ההגדרה.
OptionBuilderה-builder ליצירת אפשרויות ל-SelectSingle ול-SelectMultiple.
SelectMultipleמכיל כמה פרטים נבחרים של ההגדרה.
SelectSingleמכיל מידע יחיד נבחר לגבי ההגדרה.
SetCredentialsResponseה-builder יוצר תגובה מסוג setCredentials() לפרויקט הסקריפט.
TextAreaמכיל מידע על אזור הטקסט של ההגדרה.
TextInputמכיל את פרטי הקלט של הטקסט להגדרה.
UserErrorשגיאה שמוצגת למשתמשים של המחבר.

AggregationType

מאפיינים

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

AuthType

מאפיינים

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

BigQueryConfig

Methods

שיטהסוג הערך המוחזרתיאור קצר
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 סטנדרטי או כ-SQL מדור קודם.

BigQueryParameterType

מאפיינים

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

Checkbox

Methods

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

CommunityConnector

מאפיינים

נכססוגתיאור
AggregationTypeAggregationTypeהמניין AggregationType.
AuthTypeAuthTypeהמניין AuthType.
BigQueryParameterTypeBigQueryParameterTypeהמניין BigQueryParameterType.
FieldTypeFieldTypeהמניין FieldType.

Methods

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

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() ייכלל שוב עם הגדרות המשתמש הנוכחיות.

DataStudioApp

Methods

שיטהסוג הערך המוחזרתיאור קצר
createCommunityConnector()CommunityConnectorיצירת מחבר קהילה חדש.

DebugError

Methods

שיטהסוג הערך המוחזרתיאור קצר
printJson()Stringהדפסת הייצוג של האובייקט הזה ב-JSON.
setText(text)DebugErrorהגדרת הטקסט של שגיאת ניפוי הבאגים, שמוצגת רק לאדמינים.
throwException()voidגורם להשלכת החריג הזה.

Field

Methods

שיטהסוג הערך המוחזרתיאור קצר
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שנה, חודש, יום, שעה, דקה ושנייה בפורמט YYYYMMDDHHmmss, למשל 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דקה בפורמט mm, למשל 12.
DURATIONEnumמשך זמן בשניות.
COUNTRYEnumמדינה, למשל ארצות הברית.
COUNTRY_CODEEnumקוד מדינה, כמו IL.
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מטבע מ-CAD.
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מטבע מ-EUR.
CURRENCY_GBPEnumהמטבע מ-GBP.
CURRENCY_HKDEnumמטבע מ-HKD.
CURRENCY_HRKEnumמטבע מ-HRK.
CURRENCY_HUFEnumהמטבע מ-HUF.
CURRENCY_IDREnumהמטבע מ-IDR.
CURRENCY_ILSEnumהמטבע מ-ILS.
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המטבע מ-USD.
CURRENCY_UYUEnumהמטבע מ-UYU.
CURRENCY_VEFEnumהמטבע מ-VEF.
CURRENCY_VNDEnumהמטבע מ-VND.
CURRENCY_YEREnumהמטבע מ-YER.
CURRENCY_ZAREnumהמטבע מ-ZAR.

Fields

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הגדרת מדד ברירת המחדל שישמש את קבוצת השדות.

GetAuthTypeResponse

Methods

שיטהסוג הערך המוחזרתיאור קצר
build()Objectהפונקציה מאמתת את האובייקט הזה ומחזירה אותו בפורמט הנדרש ל-Data Studio.
printJson()Stringהדפסת הייצוג של האובייקט הזה ב-JSON.
setAuthType(authType)GetAuthTypeResponseהגדרת AuthType של ה-builder.
setHelpUrl(helpUrl)GetAuthTypeResponseהגדרת כתובת ה-URL לעזרה של ה-builder.

GetDataResponse

Methods

שיטהסוג הערך המוחזרתיאור קצר
addAllRows(rows)GetDataResponseהוספת כמה שורות של נתונים ל-GetDataResponse הזה.
addRow(row)GetDataResponseהוספת שורה של נתונים ל-GetDataResponse הזה.
build()Objectהפונקציה מאמתת את האובייקט הזה ומחזירה אותו בפורמט הנדרש ל-Data Studio.
setFields(fields)GetDataResponseהגדרת Fields של ה-builder.
setFiltersApplied(filtersApplied)GetDataResponseהגדרת סטטוס המסננים שהוחלו על ה-builder הזה.

GetSchemaResponse

Methods

שיטהסוג הערך המוחזרתיאור קצר
build()Objectהפונקציה מאמתת את האובייקט הזה ומחזירה אותו בפורמט הנדרש ל-Data Studio.
printJson()Stringהדפסת הייצוג של האובייקט הזה ב-JSON.
setFields(fields)GetSchemaResponseהגדרת Fields של ה-builder.

Info

Methods

שיטהסוג הערך המוחזרתיאור קצר
setId(id)Infoהגדרת המזהה הייחודי של רשומת התצורה הזו.
setText(text)Infoהגדרת הטקסט של רשומת התצורה הזו.

OptionBuilder

Methods

שיטהסוג הערך המוחזרתיאור קצר
setLabel(label)OptionBuilderהגדרת התווית של הכלי ליצירת האפשרויות.
setValue(value)OptionBuilderהגדרת הערך של ה-builder הזה של האפשרויות.

SelectMultiple

Methods

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

SelectSingle

Methods

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

SetCredentialsResponse

Methods

שיטהסוג הערך המוחזרתיאור קצר
build()Objectהפונקציה מאמתת את האובייקט הזה ומחזירה אותו בפורמט הנדרש ל-Data Studio.
printJson()Stringהדפסת הייצוג של האובייקט הזה ב-JSON.
setIsValid(isValid)SetCredentialsResponseהגדרת הסטטוס החוקי של SetCredentialsResponse הזה.

TextArea

Methods

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

TextInput

Methods

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

UserError

Methods

שיטהסוג הערך המוחזרתיאור קצר
printJson()Stringהדפסת הייצוג של האובייקט הזה ב-JSON.
setDebugText(text)UserErrorהגדרת הטקסט של שגיאת ניפוי הבאגים, שמוצגת רק לאדמינים.
setText(text)UserErrorהגדרת הטקסט של שגיאת המשתמש.
throwException()voidגורם להשלכת החריג הזה.