Class Fields

الحقول

يحتوي على مجموعة من Field لموصل منتدى. تحدد مجموعة الحقول هذه والأبعاد والمقاييس في "مركز البيانات".

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[]يتم التحقّق من صحة هذا الكائن وعرضه بالتنسيق الذي يتطلبه "مركز البيانات".
forIds(ids)Fieldsتعرض كائن Fields جديدًا تمت فلترته إلى Field مع معرّف في ids.
getDefaultDimension()Fieldتعرض السمة التلقائية التي سيتم استخدامها لمجموعة الحقول.
getDefaultMetric()Fieldتعرض المقياس التلقائي الذي سيتم استخدامه لمجموعة الحقول.
getFieldById(fieldId)Fieldعرض حقل بمعرّف محدد أو null إذا لم يكن هناك حقل يتضمن هذا المعرّف في عنصر Fields هذا.
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()

يتم التحقّق من صحة هذا الكائن وعرضه بالتنسيق الذي يتطلبه "مركز البيانات".

الإرجاع

Object[]: بيانات الحقول التي تم التحقّق من صحتها، ويتم تمثيلها كقائمة من العناصر

الرميات

Error: إذا تعذّر إنشاء عنصر صالح


forIds(ids)

تعرض كائن Fields جديدًا تمت فلترته إلى Field مع معرّف في 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']);

المعلمات

الاسمالنوعالوصف
idsString[]أرقام تعريف الحقول التي يجب الاحتفاظ بها.

الإرجاع

Fields — كائن Fields جديد.


getDefaultDimension()

تعرض السمة التلقائية التي سيتم استخدامها لمجموعة الحقول. البُعد التلقائي هو تلقائيًا عند إنشاء تصور جديد.

الإرجاع

Field — السمة التي يتم ضبطها كسمة تلقائية، أو null في حال عدم تحديد سمة تلقائية تم تعيين البعد.


getDefaultMetric()

تعرض المقياس التلقائي الذي سيتم استخدامه لمجموعة الحقول. تم اختيار المقياس التلقائي. تلقائيًا عند إنشاء تصور جديد.

الإرجاع

Field — المقياس الذي يتم ضبطه كمقياس تلقائي، أو null إذا لم يتم ضبط مقياس تلقائي تعيين.


getFieldById(fieldId)

عرض حقل بمعرّف محدد أو null إذا لم يكن هناك حقل يتضمن هذا المعرّف في عنصر Fields هذا.

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');

المعلمات

الاسمالنوعالوصف
fieldIdStringرقم تعريف الحقل المطلوب الوصول إليه.

الإرجاع

Field - السمة Field التي تتضمّن المعرّف المحدّد أو null في حال عدم تضمين هذا الحقل داخل كائن Fields هذا.


newDimension()

تعرض سمة جديدة Field.

الإرجاع

Field: سمة جديدة Field


newMetric()

تعرض مقياسًا جديدًا Field.

الإرجاع

Field — مقياس جديد Field.


setDefaultDimension(fieldId)

تضبط السمة التلقائية التي سيتم استخدامها لمجموعة الحقول. تم اختيار السمة التلقائية. تلقائيًا عند إنشاء تصور جديد.

المعلمات

الاسمالنوعالوصف
fieldIdStringرقم تعريف الحقل المراد استخدامه كسمة تلقائية. يجب أن يكون هذا المعرّف متوفّرًا في مجموعة الحقول.

setDefaultMetric(fieldId)

تضبط المقياس التلقائي الذي سيتم استخدامه لمجموعة الحقول. تم اختيار المقياس التلقائي. تلقائيًا عند إنشاء تصور جديد.

المعلمات

الاسمالنوعالوصف
fieldIdStringرقم تعريف الحقل المراد استخدامه كمقياس تلقائي. يجب أن يكون هذا المعرّف متوفّرًا في مجموعة من الحقول.