Data Studio Service

Data Studio

این سرویس به اسکریپت ها اجازه می دهد تا به اتصال دهنده های انجمن Data Studio دسترسی داشته باشند و آنها را تغییر دهند.

کلاس ها

نام توضیح مختصر
AggregationType یک enum که انواع تجمیع را که می توان برای یک Field تنظیم کرد، تعریف می کند.
AuthType یک enum که انواع احراز هویت را که می توان برای یک کانکتور تنظیم کرد، تعریف می کند.
BigQueryConfig یک شی پیکربندی برای یک اتصال دهنده BigQuery بومی.
BigQueryParameterType یک enum که انواع پارامتر BigQuery را که می توانید تنظیم کنید، تعریف می کند.
Checkbox حاوی اطلاعات جعبه چک برای پیکربندی است.
CommunityConnector CommunityConnector اسکریپت ها را قادر می سازد تا به سازندگان و ابزارهای کمکی دسترسی پیدا کنند تا به توسعه Connectors برای Data Studio کمک کنند.
Config شامل ورودی های پیکربندی یک کانکتور است.
DataStudioApp DataStudioApp به اسکریپت ها اجازه می دهد تا با ویژگی های توسعه گرا برای Data Studio تعامل داشته باشند.
DebugError خطایی که فقط برای مدیران کانکتور قابل مشاهده است.
Field حاوی داده های مربوط به میدان است.
FieldType یک enum که انواعی را که می توان برای یک Field تنظیم کرد، تعریف می کند.
Fields شامل مجموعه ای از Field برای یک اتصال دهنده جامعه است.
GetAuthTypeResponse سازنده برای ایجاد پاسخ getAuthType() برای پروژه اسکریپت شما.
GetDataResponse Builder برای ایجاد پاسخ getData() برای پروژه اسکریپت شما.
GetSchemaResponse سازنده برای ایجاد پاسخ getSchema() برای پروژه اسکریپت شما.
Info حاوی اطلاعات اطلاعاتی برای پیکربندی است.
OptionBuilder سازنده ای برای ایجاد گزینه هایی برای SelectSingle s و SelectMultiple s.
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 یک پارامتر query به این 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 عدد ممیز شناور 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 اگر این Field متریک یا بعد پیش‌فرض باشد، مقدار true برمی‌گرداند.
isDimension() Boolean اگر این فیلد یک بعد باشد، true برمی‌گرداند.
isHidden() Boolean اگر این Field مخفی باشد، true برمی‌گرداند.
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 سال، ماه، روز، ساعت، دقیقه و ثانیه در قالب YYYYMMDDHHmmss مانند 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 کد کشوری مانند ایالات متحده
CONTINENT Enum قاره ای مانند قاره آمریکا.
CONTINENT_CODE Enum کد قاره ای مانند 019.
SUB_CONTINENT Enum شبه قاره ای مانند آمریکای شمالی.
SUB_CONTINENT_CODE Enum کد زیر قاره ای مانند 003.
REGION Enum منطقه ای مانند کالیفرنیا.
REGION_CODE Enum کد منطقه ای مانند CA.
CITY Enum شهری مانند Mountain View.
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 ارز از CAD.
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 ارز از ILS.
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 ارز از روبل.
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 ارز از USD.
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 s را با شناسه در ids برمی گرداند.
getDefaultDimension() Field بعد پیش‌فرض مورد استفاده برای مجموعه فیلدها را برمی‌گرداند.
getDefaultMetric() Field متریک پیش‌فرض مورد استفاده برای مجموعه فیلدها را برمی‌گرداند.
getFieldById(fieldId) Field فیلدی را با یک شناسه داده شده برمی‌گرداند، یا اگر فیلدی با آن شناسه در شیء Fields وجود نداشته باشد، null .
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 متن مکان‌دار را برای این ورودی پیکربندی تنظیم می‌کند.

TextInput

مواد و روش ها

روش نوع برگشت توضیح مختصر
setAllowOverride(allowOverride) TextInput نادیده گرفتن این ورودی پیکربندی را فعال می کند.
setHelpText(helpText) TextInput متن راهنما را برای این ورودی پیکربندی تنظیم می کند.
setId(id) TextInput شناسه منحصر به فرد را برای این ورودی پیکربندی تنظیم می کند.
setIsDynamic(isDynamic) TextInput وضعیت پویا را برای این ورودی پیکربندی تنظیم می کند.
setName(name) TextInput نام نمایشی را برای این ورودی پیکربندی تنظیم می کند.
setPlaceholder(placeholder) TextInput متن مکان‌دار را برای این ورودی پیکربندی تنظیم می‌کند.

UserError

مواد و روش ها

روش نوع برگشت توضیح مختصر
printJson() String نمایش JSON این شی را چاپ می کند.
setDebugText(text) UserError متن خطای اشکال زدایی را تنظیم می کند که فقط به مدیران نشان داده می شود.
setText(text) UserError متن خطای کاربر را تنظیم می کند.
throwException() void این استثنا را برای پرتاب کردن راه اندازی می کند.