Class Fields

فیلدها

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

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

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

روش ها

روش نوع برگشت شرح مختصر
asArray() Field[] نمای این شیء را به صورت آرایه برمی گرداند.
build() Object[] این شی را اعتبارسنجی می کند و آن را در قالب مورد نیاز Data Studio برمی گرداند.
forIds(ids) Fields یک شی Fields جدید فیلتر شده به Field s را با شناسه در ids برمی گرداند.
getDefaultDimension() Field بعد پیش‌فرض مورد استفاده برای مجموعه فیلدها را برمی‌گرداند.
getDefaultMetric() Field متریک پیش‌فرض مورد استفاده برای مجموعه فیلدها را برمی‌گرداند.
getFieldById(fieldId) Field فیلدی را با یک شناسه داده شده برمی‌گرداند، یا اگر فیلدی با آن شناسه در شیء Fields وجود نداشته باشد، null .
newDimension() Field یک Field بعد جدید را برمی گرداند.
newMetric() Field یک Field متریک جدید را برمی‌گرداند.
setDefaultDimension(fieldId) void بعد پیش فرض را برای استفاده برای مجموعه فیلدها تنظیم می کند.
setDefaultMetric(fieldId) void متریک پیش‌فرض را برای استفاده برای مجموعه فیلدها تنظیم می‌کند.

مستندات دقیق

asArray()

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

var fields = //reference to fields object.
fields.newDimension().setId('field1_id');
fields.newDimension().setId('field2_id');
fields.newDimension().setId('field3_id');

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

بازگشت

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

build()

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

بازگشت

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

پرتاب می کند

Error - اگر یک شی معتبر ساخته نشود.

forIds(ids)

یک شی Fields جدید فیلتر شده به Field s را با شناسه در ids برمی گرداند.

var fields = //reference to fields object.
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.
var subsetFields = fields.forIds(['field1_id', 'field3_id']);

پارامترها

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

بازگشت

Fields - یک شیء Fields جدید.

getDefaultDimension()

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

بازگشت

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

getDefaultMetric()

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

بازگشت

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

getFieldById(fieldId)

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

var fields = //reference to fields object.
var field1 = fields.newDimension().setId('field1_id');

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

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

پارامترها

نام تایپ کنید توضیحات
fieldId String شناسه فیلد برای گرفتن.

بازگشت

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

newDimension()

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

بازگشت

Field - Field بعد جدید.

newMetric()

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

بازگشت

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

setDefaultDimension(fieldId)

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

پارامترها

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

setDefaultMetric(fieldId)

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

پارامترها

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