Data Studio Service

Data Studio

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

שיעורים

שםתיאור קצר
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מכיל קבוצה של 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ספירה של ערכים ייחודיים.
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קוד מדינה כמו 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המטבע הוא דולר אוסטרלי.
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המטבע הוא יואן סיני.
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המטבע הוא ליש"ט.
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המטבע הוא ין יפני.
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

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הגדרת הערך של כלי ליצירת אפשרויות.

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הפונקציה הזו גורמת להפעלת החריגה.