Class Config

پیکربندی

شامل ورودی‌های پیکربندی برای یک کانکتور است. این ورودی‌های پیکربندی مشخص می‌کنند که هنگام افزودن یک کانکتور جدید چه سوالاتی پرسیده شود.

const cc = DataStudioApp.createCommunityConnector();
const config = cc.getConfig();

const info_entry = config.newInfo().setId('info_id').setHelpText(
    'This connector can connect to multiple data endpoints.');

روش‌ها

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

مستندات دقیق

build()

این شیء را اعتبارسنجی می‌کند و آن را در قالبی که توسط Data Studio مورد نیاز است، برمی‌گرداند.

بازگشت

Object — شیء Config اعتبارسنجی‌شده.

newCheckbox()

یک ورودی پیکربندی جدید برای چک‌باکس برمی‌گرداند.

بازگشت

Checkbox — یک ورودی جدید برای پیکربندی کادر انتخاب.

newInfo()

یک ورودی پیکربندی اطلاعات جدید را برمی‌گرداند.

بازگشت

Info — یک ورودی پیکربندی اطلاعات جدید.

newOptionBuilder()

یک سازنده‌ی گزینه‌های جدید برمی‌گرداند.

بازگشت

OptionBuilder — یک سازنده‌ی آپشن جدید.

newSelectMultiple()

یک ورودی پیکربندی چندگانه‌ی جدید را برمی‌گرداند.

بازگشت

SelectMultiple — یک ورودی جدید برای پیکربندی select multiple.

newSelectSingle()

یک ورودی پیکربندی تکیِ انتخاب‌شده‌ی جدید را برمی‌گرداند.

بازگشت

SelectSingle — یک ورودی پیکربندی تک انتخابی جدید.

newTextArea()

یک ورودی پیکربندی ناحیه متنی جدید را برمی‌گرداند.

بازگشت

TextArea — یک ورودی پیکربندی ناحیه متنی جدید.

newTextInput()

یک ورودی پیکربندی ورودی متن جدید را برمی‌گرداند.

بازگشت

TextInput — یک ورودی پیکربندی ورودی متن جدید.

printJson()

نمایش JSON این شیء را چاپ می‌کند. این فقط برای اشکال‌زدایی است.

بازگشت

String

setDateRangeRequired(dateRangeRequired)

اگر true ، یک محدوده تاریخ برای درخواست‌های getData() ارائه می‌شود.

پارامترها

نام نوع توضیحات
date Range Required Boolean اینکه آیا برای get Data() باید محدوده تاریخ ارائه شود یا خیر.

بازگشت

Config — این سازنده، برای زنجیره‌سازی.

setIsSteppedConfig(isSteppedConfig)

اگر true ، getConfig() دوباره با پیکربندی کاربر فعلی فراخوانی می‌شود.

پارامترها

نام نوع توضیحات
is Stepped Config Boolean وضعیت پیکربندی مرحله‌ای که باید تنظیم شود.

بازگشت

Config — این سازنده، برای زنجیره‌سازی.