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

المَعلمات

الاسمTypeالوصف
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');

المَعلمات

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

استرجاع الكرة

Field: السمة Field التي تتضمّن المعرّف المحدّد، أو null إذا لم يتم تضمين هذا الحقل في عنصر Fields هذا.


newDimension()

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

استرجاع الكرة

Field - سمة جديدة Field.


newMetric()

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

استرجاع الكرة

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


setDefaultDimension(fieldId)

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

المَعلمات

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

setDefaultMetric(fieldId)

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

المَعلمات

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