Class Fields

فیلدها

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

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

const field1 = fields
                   .newDimension()
                   // Set other properties as needed.
                   .setId('field1_id');

روش‌ها

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

مستندات دقیق

asArray()

نمایی از این شیء را به صورت یک آرایه برمی‌گرداند.

const fields = DataStudioApp.createCommunityConnector().getFields();
fields.newDimension().setId('field1_id');
fields.newDimension().setId('field2_id');
fields.newDimension().setId('field3_id');

// Logging the ID of each field:
fields.asArray().map((field) => {
  Logger.log(field.getId());
});

بازگشت

Field[] — آرایه‌ای از اشیاء Field .

build()

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

بازگشت

Object[] — داده‌های فیلد اعتبارسنجی‌شده، که به صورت فهرستی از اشیاء نمایش داده می‌شوند.

پرتاب‌ها

Error — اگر یک شیء معتبر قابل ساخت نباشد.

forIds(ids)

یک شیء جدید Fields را که به Field فیلتر شده و دارای شناسه (ID) در ids است، برمی‌گرداند.

const fields = DataStudioApp.createCommunityConnector().getFields();
fields.newDimension().setId('field1_id');
fields.newDimension().setId('field2_id');
fields.newDimension().setId('field3_id');

// subsetFields is a Fields object that only contains field1 and field2.
const subsetFields = fields.forIds(['field1_id', 'field3_id']);

پارامترها

نام نوع توضیحات
ids String[] شناسه‌های فیلدهایی که باید نگه داشته شوند.

بازگشت

Fields - یک شیء جدید از نوع Fields .

getDefaultDimension()

بُعد پیش‌فرض مورد استفاده برای مجموعه فیلدها را برمی‌گرداند. بُعد پیش‌فرض هنگام ایجاد یک تجسم جدید، به‌طور خودکار انتخاب می‌شود.

بازگشت

Field - بُعدی که به عنوان بُعد پیش‌فرض تنظیم شده است، یا اگر بُعد پیش‌فرضی تنظیم نشده باشد null .

getDefaultMetric()

معیار پیش‌فرض مورد استفاده برای مجموعه فیلدها را برمی‌گرداند. معیار پیش‌فرض هنگام ایجاد یک تجسم جدید به طور خودکار انتخاب می‌شود.

بازگشت

Field — معیاری که به عنوان معیار پیش‌فرض تنظیم شده است، یا اگر هیچ معیار پیش‌فرضی تنظیم نشده باشد null .

getFieldById(fieldId)

فیلدی با شناسه‌ی داده شده را برمی‌گرداند، یا اگر هیچ فیلدی با آن شناسه در این شیء Fields وجود نداشته باشد null برمی‌گرداند.

const fields = DataStudioApp.createCommunityConnector().getFields();
const field1 = fields.newDimension().setId('field1_id');

// byId is the same as field1.
const byId = fields.getFieldById('field1_id');

// byId2 is null.
const byId2 = fields.getFieldById('not present id');

پارامترها

نام نوع توضیحات
field Id String شناسه‌ی فیلدی که باید دریافت شود.

بازگشت

Field - Field با شناسه‌ی داده شده، یا اگر چنین فیلدی در این شیء Fields وجود نداشته باشد، null .

newDimension()

یک Field با ابعاد جدید برمی‌گرداند.

بازگشت

Field — Field با ابعاد جدید.

newMetric()

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

بازگشت

Field — یک Field متریک جدید.

setDefaultDimension(fieldId)

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

پارامترها

نام نوع توضیحات
field Id String شناسه فیلدی که به عنوان بعد پیش‌فرض استفاده می‌شود. این شناسه باید در مجموعه فیلدها موجود باشد.

setDefaultMetric(fieldId)

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

پارامترها

نام نوع توضیحات
field Id String شناسه فیلدی که به عنوان معیار پیش‌فرض استفاده می‌شود. این شناسه باید در مجموعه فیلدها موجود باشد.