Class Fields

الحقول

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

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

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

الطُرق

الطريقة	نوع القيمة التي يتم عرضها	وصف قصير
asArray()	Field[]	لعرض هذا العنصر كمصفوفة.
build()	Object[]	تُجري هذه الدالة عملية التحقّق من صحة هذا العنصر وتُعيده بالتنسيق المطلوب في "مركز بيانات Google".
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()

لعرض هذا العنصر كمصفوفة.

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()

تُجري هذه الدالة عملية التحقّق من صحة هذا العنصر وتُعيده بالتنسيق المطلوب في "مركز بيانات Google".

الإرجاع

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

عمليات الرمي

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

---

forIds(ids)

تعرِض هذه الدالة عنصر Fields جديدًا تمّت فلترته إلى Field مع معرّف في 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)

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

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

المعلمات

الاسم	النوع	الوصف
fieldId	String	رقم تعريف الحقل المطلوب الحصول عليه

الإرجاع

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

---

newDimension()

تعرِض بُعدًا جديدًا Field.

الإرجاع

Field - سمة جديدة Field

---

newMetric()

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

الإرجاع

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

---

setDefaultDimension(fieldId)

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

المعلمات

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

---

setDefaultMetric(fieldId)

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

المعلمات

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