Class Field

میدان

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

var cc = DataStudioApp.createCommunityConnector();
var fields = cc.getFields();
var types = cc.FieldType;

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

روش ها

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

مستندات دقیق

getAggregation()

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

بازگشت

AggregationType - aggregationType برای این فیلد.

getDescription()

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

بازگشت

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

getFormula()

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

بازگشت

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

getGroup()

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

بازگشت

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

getId()

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

بازگشت

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

getIsReaggregatable()

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

بازگشت

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

getName()

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

بازگشت

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

getType()

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

بازگشت

FieldType - نوع این فیلد.

isDefault()

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

بازگشت

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

isDimension()

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

بازگشت

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

isHidden()

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

بازگشت

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

isMetric()

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

بازگشت

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

setAggregation(aggregation)

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

پارامترها

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

بازگشت

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

setDescription(description)

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

پارامترها

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

بازگشت

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

setFormula(formula)

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

پارامترها

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

بازگشت

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

setGroup(group)

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

پارامترها

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

بازگشت

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

setId(id)

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

پارامترها

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

بازگشت

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

setIsHidden(isHidden)

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

پارامترها

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

بازگشت

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

setIsReaggregatable(isReaggregatable)

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

پارامترها

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

بازگشت

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

setName(name)

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

پارامترها

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

بازگشت

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

setType(type)

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

پارامترها

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

بازگشت

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