Data Studio Service

Data Studio

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

کلاس ها

نام شرح مختصر
Aggregation Type یک enum که انواع تجمیع را که می توان برای یک Field تنظیم کرد، تعریف می کند.
Auth Type یک enum که انواع احراز هویت را که می توان برای یک کانکتور تنظیم کرد، تعریف می کند.
Big Query Config یک شی پیکربندی برای یک اتصال دهنده BigQuery بومی.
Big Query Parameter Type یک enum که انواع پارامتر BigQuery را که می توانید تنظیم کنید، تعریف می کند.
Checkbox حاوی اطلاعات جعبه چک برای پیکربندی است.
Community Connector Community Connector اسکریپت ها را قادر می سازد تا به سازندگان و ابزارهای کمکی دسترسی پیدا کنند تا به توسعه Connectors برای Data Studio کمک کنند.
Config شامل ورودی های پیکربندی یک کانکتور است.
Data Studio App برنامه Data Studio به اسکریپت ها اجازه می دهد تا با ویژگی های توسعه گرا برای Data Studio تعامل داشته باشند.
Debug Error خطایی که فقط برای مدیران کانکتور قابل مشاهده است.
Field حاوی داده های مربوط به زمینه است.
Field Type یک enum که انواعی را که می توان برای یک Field تنظیم کرد، تعریف می کند.
Fields شامل مجموعه ای از Field برای یک اتصال دهنده جامعه است.
Get Auth Type Response Builder برای ایجاد پاسخ get Auth Type() برای پروژه اسکریپت شما.
Get Data Response Builder برای ایجاد پاسخ get Data() برای پروژه اسکریپت شما.
Get Schema Response Builder برای ایجاد پاسخ get Schema() برای پروژه اسکریپت شما.
Info حاوی داده های اطلاعاتی برای پیکربندی است.
Option Builder سازنده ای برای ایجاد گزینه هایی برای Select Single s و Select Multiple s.
Select Multiple حاوی اطلاعات چندگانه برای پیکربندی است.
Select Single حاوی اطلاعات منتخب برای پیکربندی است.
Set Credentials Response Builder برای ایجاد پاسخ set Credentials() برای پروژه اسکریپت شما.
Text Area حاوی اطلاعات ناحیه متنی برای پیکربندی است.
Text Input حاوی اطلاعات ورودی متن برای پیکربندی است.
User Error خطایی که به کاربران کانکتور نشان داده می شود.

Aggregation Type

خواص

اموال تایپ کنید توضیحات
AVG Enum میانگین.
COUNT Enum بشمار.
COUNT_DISTINCT Enum تعداد متمایز.
MAX Enum حداکثر
MIN Enum حداقل
SUM Enum مجموع
AUTO Enum خودکار.

Auth Type

خواص

اموال تایپ کنید توضیحات
NONE Enum بدون نیاز به مجوز
OAUTH2 Enum مجوز OAuth2 مورد نیاز است.
USER_PASS Enum اطلاعات نام کاربری و رمز عبور مورد نیاز است.
PATH_USER_PASS Enum نام کاربری، مسیر و رمز عبور مورد نیاز است.
PATH_KEY Enum مسیر و کلید لازم است
KEY Enum کلید یا توکن API مورد نیاز است.
USER_TOKEN Enum نام کاربری و رمز مورد نیاز است.

Big Query Config

روش ها

روش نوع برگشت شرح مختصر
add Query Parameter(name, type, value) Big Query Config یک پارامتر پرس و جو را به این Big Query Config اضافه می کند.
build() Object این شی را اعتبارسنجی می کند و آن را در قالب مورد نیاز Data Studio برمی گرداند.
print Json() String نمایش JSON این شی را چاپ می کند.
set Access Token(accessToken) Big Query Config نشانه دسترسی این Big Query Config را تنظیم می کند.
set Billing Project Id(billingProjectId) Big Query Config شناسه پروژه صورتحساب این Big Query Config را تنظیم می کند.
set Query(query) Big Query Config پرس و جوی SQL این Big Query Config را تنظیم می کند.
set Use Standard Sql(useStandardSql) Big Query Config تعیین می کند که آیا پرس و جو به عنوان SQL استاندارد یا قدیمی تفسیر می شود.

Big Query Parameter Type

خواص

اموال تایپ کنید توضیحات
STRING Enum رشته
INT64 Enum عدد صحیح 64 بیتی
BOOL Enum بولی.
FLOAT64 Enum عدد ممیز شناور 64 بیتی.

Checkbox

روش ها

روش نوع برگشت شرح مختصر
set Allow Override(allowOverride) Checkbox نادیده گرفتن این ورودی پیکربندی را فعال می کند.
set Help Text(helpText) Checkbox متن راهنما را برای این ورودی پیکربندی تنظیم می کند.
set Id(id) Checkbox شناسه منحصر به فرد را برای این ورودی پیکربندی تنظیم می کند.
set Is Dynamic(isDynamic) Checkbox وضعیت پویا را برای این ورودی پیکربندی تنظیم می کند.
set Name(name) Checkbox نام نمایشی را برای این ورودی پیکربندی تنظیم می کند.

Community Connector

خواص

اموال تایپ کنید توضیحات
Aggregation Type Aggregation Type شمارش Aggregation Type
Auth Type Auth Type شمارش Auth Type .
Big Query Parameter Type Big Query Parameter Type شمارش Big Query Parameter Type .
Field Type Field Type شمارش Field Type .

روش ها

روش نوع برگشت شرح مختصر
get Config() Config یک شی Config را برمی گرداند.
get Fields() Fields یک شی Fields را برمی گرداند.
new Auth Type Response() Get Auth Type Response یک شی جدید Get Auth Type Response را برمی گرداند.
new Big Query Config() Big Query Config یک شی Big Query Config را برمی گرداند.
new Debug Error() Debug Error یک شی جدید Debug Error را برمی گرداند.
new Get Data Response() Get Data Response یک شی جدید Get Data Response برمی گرداند.
new Get Schema Response() Get Schema Response یک شی جدید Get Schema Response را برمی گرداند.
new Set Credentials Response() Set Credentials Response یک شیء جدید Set Credentials Response را برمی گرداند.
new User Error() User Error یک شیء User Error جدید را برمی گرداند.

Config

روش ها

روش نوع برگشت شرح مختصر
build() Object این شی را اعتبارسنجی می کند و آن را در قالب مورد نیاز Data Studio برمی گرداند.
new Checkbox() Checkbox ورودی پیکربندی چک باکس جدید را برمی گرداند.
new Info() Info ورودی پیکربندی اطلاعات جدید را برمی‌گرداند.
new Option Builder() Option Builder سازنده گزینه های جدید را برمی گرداند.
new Select Multiple() Select Multiple یک ورودی پیکربندی چندگانه انتخابی جدید را برمی‌گرداند.
new Select Single() Select Single یک ورودی پیکربندی انتخابی جدید را برمی‌گرداند.
new Text Area() Text Area ورودی پیکربندی ناحیه متنی جدید را برمی‌گرداند.
new Text Input() Text Input ورودی پیکربندی ورودی متن جدید را برمی‌گرداند.
print Json() String نمایش JSON این شی را چاپ می کند.
set Date Range Required(dateRangeRequired) Config اگر true ، یک محدوده تاریخ برای درخواست‌های getData() ارائه می‌شود.
set Is Stepped Config(isSteppedConfig) Config اگر true ، get Config() دوباره با پیکربندی کاربر فعلی فراخوانی می شود.

Data Studio App

روش ها

روش نوع برگشت شرح مختصر
create Community Connector() Community Connector یک رابط انجمن جدید ایجاد می کند.

Debug Error

روش ها

روش نوع برگشت شرح مختصر
print Json() String نمایش JSON این شی را چاپ می کند.
set Text(text) Debug Error متن خطای اشکال زدایی را تنظیم می کند که فقط به مدیران نشان داده می شود.
throw Exception() void این استثنا را برای پرتاب کردن راه اندازی می کند.

Field

روش ها

روش نوع برگشت شرح مختصر
get Aggregation() Aggregation Type Aggregation Type این Field را برمی گرداند.
get Description() String شرح این Field را برمی گرداند.
get Formula() String فرمول این Field را برمی گرداند.
get Group() String گروه این Field را برمی گرداند.
get Id() String شناسه این Field را برمی گرداند.
get Is Reaggregatable() Boolean اگر بتوان این فیلد را دوباره جمع کرد، true را برمی‌گرداند، در غیر این صورت false .
get Name() String نام این Field را برمی گرداند.
get Type() Field Type Field Type این Field را برمی گرداند.
is Default() Boolean اگر این Field متریک یا بعد پیش‌فرض باشد، true برمی‌گرداند.
is Dimension() Boolean اگر این فیلد یک بعد باشد true برمی‌گرداند.
is Hidden() Boolean اگر این Field مخفی باشد true برمی‌گرداند.
is Metric() Boolean اگر این فیلد یک متریک باشد، true برمی‌گردد.
set Aggregation(aggregation) Field نوع تجمع این Field را تنظیم می کند.
set Description(description) Field توضیحات این Field را تنظیم می کند.
set Formula(formula) Field فرمول این Field را تنظیم می کند.
set Group(group) Field گروه این Field را تنظیم می کند.
set Id(id) Field شناسه این Field را تنظیم می کند.
set Is Hidden(isHidden) Field وضعیت مخفی این Field را تنظیم می کند.
set Is Reaggregatable(isReaggregatable) Field وضعیت مجاز تجمع مجدد را برای یک Field تنظیم می کند.
set Name(name) Field نام این Field را تنظیم می کند.
set Type(type) Field Field Type این Field را تنظیم می کند.

Field Type

خواص

اموال تایپ کنید توضیحات
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

روش ها

روش نوع برگشت شرح مختصر
as Array() Field[] نمای این شیء را به صورت آرایه برمی گرداند.
build() Object[] این شی را اعتبارسنجی می کند و آن را در قالب مورد نیاز Data Studio برمی گرداند.
for Ids(ids) Fields یک شی Fields جدید فیلتر شده به Field s را با شناسه در ids برمی گرداند.
get Default Dimension() Field بعد پیش‌فرض مورد استفاده برای مجموعه فیلدها را برمی‌گرداند.
get Default Metric() Field متریک پیش‌فرض مورد استفاده برای مجموعه فیلدها را برمی‌گرداند.
get Field By Id(fieldId) Field فیلدی را با یک شناسه داده شده برمی‌گرداند، یا اگر فیلدی با آن شناسه در شیء Fields وجود نداشته باشد null .
new Dimension() Field یک Field بعد جدید را برمی گرداند.
new Metric() Field یک Field متریک جدید را برمی‌گرداند.
set Default Dimension(fieldId) void بعد پیش فرض را برای استفاده برای مجموعه فیلدها تنظیم می کند.
set Default Metric(fieldId) void متریک پیش‌فرض را برای استفاده برای مجموعه فیلدها تنظیم می‌کند.

Get Auth Type Response

روش ها

روش نوع برگشت شرح مختصر
build() Object این شی را اعتبارسنجی می کند و آن را در قالب مورد نیاز Data Studio برمی گرداند.
print Json() String نمایش JSON این شی را چاپ می کند.
set Auth Type(authType) Get Auth Type Response Auth Type سازنده را تنظیم می کند.
set Help Url(helpUrl) Get Auth Type Response URL راهنمای سازنده را تنظیم می کند.

Get Data Response

روش ها

روش نوع برگشت شرح مختصر
add All Rows(rows) Get Data Response چندین ردیف داده را به این Get Data Response اضافه می کند.
add Row(row) Get Data Response یک ردیف از داده ها را به این Get Data Response اضافه می کند.
build() Object این شی را اعتبارسنجی می کند و آن را در قالب مورد نیاز Data Studio برمی گرداند.
set Fields(fields) Get Data Response Fields سازنده را تنظیم می کند.
set Filters Applied(filtersApplied) Get Data Response وضعیت اعمال فیلترها را برای این سازنده تنظیم می کند.

Get Schema Response

روش ها

روش نوع برگشت شرح مختصر
build() Object این شی را اعتبارسنجی می کند و آن را در قالب مورد نیاز Data Studio برمی گرداند.
print Json() String نمایش JSON این شی را چاپ می کند.
set Fields(fields) Get Schema Response Fields سازنده را تنظیم می کند.

Info

روش ها

روش نوع برگشت شرح مختصر
set Id(id) Info شناسه منحصر به فرد را برای این ورودی پیکربندی تنظیم می کند.
set Text(text) Info متن را برای این ورودی پیکربندی تنظیم می کند.

Option Builder

روش ها

روش نوع برگشت شرح مختصر
set Label(label) Option Builder برچسب این گزینه ساز را تنظیم می کند.
set Value(value) Option Builder مقدار این گزینه ساز را تعیین می کند.

Select Multiple

روش ها

روش نوع برگشت شرح مختصر
add Option(optionBuilder) Select Multiple یک گزینه انتخاب جدید اضافه می کند.
set Allow Override(allowOverride) Select Multiple نادیده گرفتن این ورودی پیکربندی را فعال می کند.
set Help Text(helpText) Select Multiple متن راهنما را برای این ورودی پیکربندی تنظیم می کند.
set Id(id) Select Multiple شناسه منحصر به فرد را برای این ورودی پیکربندی تنظیم می کند.
set Is Dynamic(isDynamic) Select Multiple وضعیت پویا را برای این ورودی پیکربندی تنظیم می کند.
set Name(name) Select Multiple نام نمایشی را برای این ورودی پیکربندی تنظیم می کند.

Select Single

روش ها

روش نوع برگشت شرح مختصر
add Option(optionBuilder) Select Single یک گزینه انتخاب جدید اضافه می کند.
set Allow Override(allowOverride) Select Single نادیده گرفتن این ورودی پیکربندی را فعال می کند.
set Help Text(helpText) Select Single متن راهنما را برای این ورودی پیکربندی تنظیم می کند.
set Id(id) Select Single شناسه منحصر به فرد را برای این ورودی پیکربندی تنظیم می کند.
set Is Dynamic(isDynamic) Select Single وضعیت پویا را برای این ورودی پیکربندی تنظیم می کند.
set Name(name) Select Single نام نمایشی را برای این ورودی پیکربندی تنظیم می کند.

Set Credentials Response

روش ها

روش نوع برگشت شرح مختصر
build() Object این شی را اعتبارسنجی می کند و آن را در قالب مورد نیاز Data Studio برمی گرداند.
print Json() String نمایش JSON این شی را چاپ می کند.
set Is Valid(isValid) Set Credentials Response وضعیت معتبر این Set Credentials Response را تنظیم می کند.

Text Area

روش ها

روش نوع برگشت شرح مختصر
set Allow Override(allowOverride) Text Area نادیده گرفتن این ورودی پیکربندی را فعال می کند.
set Help Text(helpText) Text Area متن راهنما را برای این ورودی پیکربندی تنظیم می کند.
set Id(id) Text Area شناسه منحصر به فرد را برای این ورودی پیکربندی تنظیم می کند.
set Is Dynamic(isDynamic) Text Area وضعیت پویا را برای این ورودی پیکربندی تنظیم می کند.
set Name(name) Text Area نام نمایشی را برای این ورودی پیکربندی تنظیم می کند.
set Placeholder(placeholder) Text Area متن مکان‌دار را برای این ورودی پیکربندی تنظیم می‌کند.

Text Input

روش ها

روش نوع برگشت شرح مختصر
set Allow Override(allowOverride) Text Input نادیده گرفتن این ورودی پیکربندی را فعال می کند.
set Help Text(helpText) Text Input متن راهنما را برای این ورودی پیکربندی تنظیم می کند.
set Id(id) Text Input شناسه منحصر به فرد را برای این ورودی پیکربندی تنظیم می کند.
set Is Dynamic(isDynamic) Text Input وضعیت پویا را برای این ورودی پیکربندی تنظیم می کند.
set Name(name) Text Input نام نمایشی را برای این ورودی پیکربندی تنظیم می کند.
set Placeholder(placeholder) Text Input متن مکان‌دار را برای این ورودی پیکربندی تنظیم می‌کند.

User Error

روش ها

روش نوع برگشت شرح مختصر
print Json() String نمایش JSON این شی را چاپ می کند.
set Debug Text(text) User Error متن خطای اشکال زدایی را تنظیم می کند که فقط به مدیران نشان داده می شود.
set Text(text) User Error متن خطای کاربر را تنظیم می کند.
throw Exception() void این استثنا را برای پرتاب کردن راه اندازی می کند.