Class Field

میدان

حاوی داده های مربوط به زمینه است. ویژگی های آن تعیین می کند که چگونه از فیلد در Data Studio استفاده می شود.

const cc = DataStudioApp.createCommunityConnector();
const fields = cc.getFields();

const field1 = fields.newDimension()
                   .setId('field1_id')
                   .setName('Field 1 ID')
                   .setDescription('The first field.')
                   .setType(cc.FieldType.YEAR_MONTH)
                   .setGroup('DATETIME');

روش ها

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

مستندات دقیق

get Aggregation()

Aggregation Type این Field را برمی گرداند. Aggregation Type تعیین می کند که Data Studio چگونه داده های مشابه را در ابعاد ترکیب می کند.

بازگشت

Aggregation Type - AggregationType برای این فیلد.


get Description()

شرح این Field را برمی گرداند. توضیحات توضیحات کوتاهی از هدف یک رشته هستند.

بازگشت

String - توضیحات این فیلد.


get Formula()

فرمول این Field را برمی گرداند. فرمول ها یک تبدیل داده را تعریف می کنند که Data Studio در زمان پرس و جو اجرا می کند.

بازگشت

String - فرمول این فیلد.


get Group()

گروه این Field را برمی گرداند. فیلدهای جمع آوری شده در یک گروه با هم در رابط کاربری Data Studio ارائه می شوند.

بازگشت

String - گروه این فیلد.


get Id()

شناسه این Field را برمی گرداند. شناسه ها در هر مجموعه ای از فیلدها منحصر به فرد هستند و در فرمول ها برای ارجاع به فیلدها استفاده می شوند.

بازگشت

String - شناسه این فیلد.


get Is Reaggregatable()

اگر بتوان این فیلد را دوباره جمع کرد، true را برمی‌گرداند، در غیر این صورت false .

بازگشت

Boolean - true اگر بتوان این فیلد را دوباره جمع کرد، در غیر این صورت false .


get Name()

نام این Field را برمی گرداند. نام ها برای تشخیص فیلدها به کاربر نشان داده می شود.

بازگشت

String - نام این فیلد.


get Type()

Field Type این Field را برمی گرداند.

بازگشت

Field Type - نوع این فیلد.


is Default()

اگر این Field متریک یا بعد پیش‌فرض باشد، true برمی‌گرداند.

بازگشت

Boolean - اگر این Field متریک یا بعد پیش‌فرض باشد true . false در غیر این صورت


is Dimension()

اگر این فیلد یک بعد باشد true برمی‌گرداند.

بازگشت

Boolean - اگر این فیلد یک بعد باشد true . در غیر این صورت false برمی گرداند.


is Hidden()

اگر این Field مخفی باشد true برمی‌گرداند. می توانید از فیلدهای پنهان در فرمول ها استفاده کنید، اما در نمودارها نه. شما نمی توانید فیلدهای حاوی فرمول را پنهان کنید.

بازگشت

Boolean - true اگر این Field پنهان باشد. false در غیر این صورت


is Metric()

اگر این فیلد یک متریک باشد، true برمی‌گردد.

بازگشت

Boolean - اگر این فیلد یک متریک باشد true . در غیر این صورت false برمی گرداند.


set Aggregation(aggregation)

نوع تجمع این Field را تنظیم می کند. Aggregation Type تعیین می کند که Data Studio چگونه داده های مشابه را در ابعاد ترکیب می کند. در صورت فراخوانی یک متریک، این یک خطا ایجاد می کند.

پارامترها

نام تایپ کنید توضیحات
aggregation Aggregation Type نوع تجمع برای تنظیم.

بازگشت

Field - این سازنده، برای زنجیر زدن.


set Description(description)

توضیحات این Field را تنظیم می کند. توضیحات توضیحات کوتاهی از هدف یک رشته هستند.

پارامترها

نام تایپ کنید توضیحات
description String توضیحات برای تنظیم

بازگشت

Field - این سازنده، برای زنجیر زدن.


set Formula(formula)

فرمول این Field را تنظیم می کند. فرمول ها یک تبدیل داده را تعریف می کنند که Data Studio در زمان پرس و جو اجرا می کند.

پارامترها

نام تایپ کنید توضیحات
formula String فرمول برای تنظیم.

بازگشت

Field - این سازنده، برای زنجیر زدن.


set Group(group)

گروه این Field را تنظیم می کند. فیلدهای جمع آوری شده در یک گروه با هم در رابط کاربری Data Studio ارائه می شوند.

پارامترها

نام تایپ کنید توضیحات
group String گروهی که قرار است تنظیم شود.

بازگشت

Field - این سازنده، برای زنجیر زدن.


set Id(id)

شناسه این Field را تنظیم می کند. شناسه ها در هر مجموعه ای از فیلدها منحصر به فرد هستند و در فرمول ها برای ارجاع به فیلدها استفاده می شوند.

پارامترها

نام تایپ کنید توضیحات
id String شناسه برای تنظیم.

بازگشت

Field - این سازنده، برای زنجیر زدن.


set Is Hidden(isHidden)

وضعیت مخفی این Field را تنظیم می کند. می توانید از فیلدهای پنهان در فرمول ها استفاده کنید، اما در نمودارها نه. شما نمی توانید فیلدهای حاوی فرمول را پنهان کنید.

پارامترها

نام تایپ کنید توضیحات
is Hidden Boolean وضعیت پنهان برای تنظیم.

بازگشت

Field - این سازنده، برای زنجیر زدن.


set Is Reaggregatable(isReaggregatable)

وضعیت مجاز تجمع مجدد را برای یک Field تنظیم می کند. تلاش برای تنظیم یک نوع تجمع در فیلدی که قابل جمع‌بندی مجدد نیست، منجر به خطا می‌شود.

پارامترها

نام تایپ کنید توضیحات
is Reaggregatable Boolean وضعیت مجاز تجمع مجدد برای تنظیم.

بازگشت

Field - این سازنده، برای زنجیر زدن.


set Name(name)

نام این Field را تنظیم می کند. نام ها برای تشخیص فیلدها به کاربر نشان داده می شود.

پارامترها

نام تایپ کنید توضیحات
name String نام برای تنظیم.

بازگشت

Field - این سازنده، برای زنجیر زدن.


set Type(type)

Field Type این Field را تنظیم می کند.

پارامترها

نام تایپ کنید توضیحات
type Field Type نوع تنظیم

بازگشت

Field - این سازنده، برای زنجیر زدن.