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

مستندات دقیق

as Array()

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

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

for Ids(ids)

یک شی Fields جدید فیلتر شده به Field s را با شناسه در 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 جدید.

get Default Dimension()

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

بازگشت

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

get Default Metric()

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

بازگشت

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

get Field By Id(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 .

new Dimension()

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

بازگشت

Field - Field بعد جدید.

new Metric()

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

بازگشت

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

set Default Dimension(fieldId)

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

پارامترها

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

set Default Metric(fieldId)

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

پارامترها

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