این صفحه به‌وسیله ‏Cloud Translation API‏ ترجمه شده است.

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`	شناسه (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` را تنظیم می‌کند.

مستندات دقیق

`getAggregation()`

AggregationType این Field را برمی‌گرداند. AggregationType تعیین می‌کند که دیتا استودیو چگونه داده‌های مشابه را در ابعاد (dimension) ترکیب می‌کند.

بازگشت

AggregationType — نوع تجمیع برای این فیلد.

`getDescription()`

توضیحات این Field را برمی‌گرداند. توضیحات، توضیحات کوتاهی در مورد هدف یک فیلد هستند.

بازگشت

String - توضیحات مربوط به این فیلد.

`getFormula()`

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

بازگشت

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

`getGroup()`

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

بازگشت

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

`getId()`

شناسه (ID) این 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 - اگر این Field پنهان باشد، true و در غیر این صورت false برمی‌گرداند.

`isMetric()`

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

بازگشت

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

`setAggregation(aggregation)`

نوع تجمیع این Field را تنظیم می‌کند. AggregationType نحوه ترکیب داده‌های مشابه در ابعاد را تعیین می‌کند. اگر این پارامتر روی یک معیار فراخوانی شود، خطا می‌دهد.