Data Studio Service

استودیو داده

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

کلاس‌ها

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

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

روش‌ها

روش نوع بازگشتی شرح مختصر
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 استاندارد یا قدیمی تفسیر می‌شود.

BigQueryParameterType

خواص

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

Checkbox

روش‌ها

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

CommunityConnector

خواص

ملک نوع توضیحات
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() دوباره با پیکربندی کاربر فعلی فراخوانی می‌شود.

DataStudioApp

روش‌ها

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

DebugError

روش‌ها

روش نوع بازگشتی شرح مختصر
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 شناسه (ID) این 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 اگر این فیلد یک معیار (metric) باشد، 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 شناسه (ID) این 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 را تنظیم می‌کند.

FieldType

خواص

ملک نوع توضیحات
YEAR Enum سال با فرمت YYYY مانند ۲۰۱۷.
YEAR_QUARTER Enum سال و فصل با قالب YYYYQ مانند ۲۰۱۷۱.
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 (یک چهارم به شکل ۱، ۲، ۳ یا ۴).
MONTH Enum ماه با فرمت MM مانند 03.
WEEK Enum هفته در قالب ww مانند 07.
MONTH_DAY Enum ماه و روز در قالب MMDD مانند 0317.
DAY_OF_WEEK Enum عددی در بازه [0،6] که 0 نشان دهنده یکشنبه است.
DAY Enum روز در قالب DD مانند ۱۷.
HOUR Enum ساعت در قالب HH مانند ۱۳.
MINUTE Enum دقیقه در قالب میلی‌متر مانند ۱۲.
DURATION Enum مدت زمانی بر حسب ثانیه.
COUNTRY Enum کشوری مانند ایالات متحده.
COUNTRY_CODE Enum کد کشوری مانند ایالات متحده.
CONTINENT Enum قاره‌ای مانند آمریکا.
CONTINENT_CODE Enum یک کد قاره‌ای مانند ۰۱۹.
SUB_CONTINENT Enum یک شبه قاره مانند آمریکای شمالی.
SUB_CONTINENT_CODE Enum یک کد شبه قاره مانند ۰۰۳.
REGION Enum منطقه‌ای مانند کالیفرنیا.
REGION_CODE Enum یک کد منطقه‌ای مانند CA.
CITY Enum شهری مانند مانتین ویو.
CITY_CODE Enum یک کد شهری مانند ۱۰۱۴۰۴۴.
METRO Enum یک مترو مانند سانفرانسیسکو-اوکلند-سن خوزه، کالیفرنیا.
METRO_CODE Enum یک کد مترو مانند ۲۰۰۸۰۷.
LATITUDE_LONGITUDE Enum یک جفت طول جغرافیایی مانند ۵۱.۵۰۷۴، -۰.۱۲۷۸.
NUMBER Enum یک عدد اعشاری.
PERCENT Enum درصد اعشاری (می‌تواند بیشتر از ۱.۰ باشد).
TEXT Enum متن آزاد.
BOOLEAN Enum یک مقدار بولی true یا false .
URL Enum یک URL به صورت متن مانند https://google.com.
HYPERLINK Enum یک هایپرلینک.
IMAGE Enum یک تصویر.
IMAGE_LINK Enum یک لینک تصویری.
CURRENCY_AED Enum واحد پول از درهم امارات.
CURRENCY_ALL Enum ارز از ALL.
CURRENCY_ARS Enum ارز از ARS.
CURRENCY_AUD Enum واحد پول از دلار استرالیا.
CURRENCY_BDT Enum واحد پول از BDT.
CURRENCY_BGN Enum واحد پول از BGN.
CURRENCY_BOB Enum ارز از BOB.
CURRENCY_BRL Enum واحد پول از رئال برزیل.
CURRENCY_CAD Enum ارز از CAD.
CURRENCY_CDF Enum ارز از CDF.
CURRENCY_CHF Enum ارز از CHF.
CURRENCY_CLP Enum ارز از CLP.
CURRENCY_CNY Enum واحد پول از یوان چین.
CURRENCY_COP Enum ارز از COP.
CURRENCY_CRC Enum ارز از CRC.
CURRENCY_CZK Enum واحد پول از CZK.
CURRENCY_DKK Enum واحد پول از کرون دانمارک.
CURRENCY_DOP Enum ارز از DOP.
CURRENCY_EGP Enum ارز از EGP.
CURRENCY_ETB Enum ارز از ETB.
CURRENCY_EUR Enum ارز از یورو.
CURRENCY_GBP Enum ارز از پوند انگلیس.
CURRENCY_HKD Enum ارز از HKD.
CURRENCY_HRK Enum ارز از HRK.
CURRENCY_HUF Enum ارز از HUF.
CURRENCY_IDR Enum ارز از IDR.
CURRENCY_ILS Enum ارز از ILS.
CURRENCY_INR Enum ارز از روپیه هند.
CURRENCY_IRR Enum ارز از ریال ایران.
CURRENCY_ISK Enum واحد پول از ISK.
CURRENCY_JMD Enum ارز از JMD.
CURRENCY_JPY Enum واحد پول از ین ژاپن.
CURRENCY_KRW Enum واحد پول از وون کره جنوبی.
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 واحد پول از دلار نیوزیلند.
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 واحد پول از کرون سوئد.
CURRENCY_SGD Enum واحد پول از SGD.
CURRENCY_THB Enum ارز از THB.
CURRENCY_TRY Enum واحد پول از لیر ترکیه.
CURRENCY_TWD Enum ارز از TWD.
CURRENCY_TZS Enum ارز از TZS.
CURRENCY_UAH Enum ارز از گریونا.
CURRENCY_USD Enum ارز از دلار آمریکا.
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 فیلتر شده و دارای شناسه (ID) در 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 معیار پیش‌فرض مورد استفاده برای مجموعه فیلدها را تنظیم می‌کند.

GetAuthTypeResponse

روش‌ها

روش نوع بازگشتی شرح مختصر
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 آدرس اینترنتی راهنمای سازنده را تنظیم می‌کند.

GetDataResponse

روش‌ها

روش نوع بازگشتی شرح مختصر
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 وضعیت فیلترهای اعمال شده برای این سازنده را تنظیم می‌کند.

GetSchemaResponse

روش‌ها

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

Info

روش‌ها

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

OptionBuilder

روش‌ها

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

SelectMultiple

روش‌ها

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

SelectSingle

روش‌ها

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

SetCredentialsResponse

روش‌ها

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

TextArea

روش‌ها

روش نوع بازگشتی شرح مختصر
set Allow Override(allowOverride) Text Area لغو (override) را برای این ورودی پیکربندی فعال می‌کند.
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 متن جایگزین را برای این ورودی پیکربندی تنظیم می‌کند.

TextInput

روش‌ها

روش نوع بازگشتی شرح مختصر
set Allow Override(allowOverride) Text Input لغو (override) را برای این ورودی پیکربندی فعال می‌کند.
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 متن جایگزین را برای این ورودی پیکربندی تنظیم می‌کند.

UserError

روش‌ها

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