Class Field

الحقل

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

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

const field1 = fields.newDimension()
                   .setId('field1_id')
                   .setName('Field 1 ID')
                   .setDescription('The first field.')
                   .setType(cc.FieldType.YEAR_MONTH)
                   .setGroup('DATETIME');

الطُرق

الطريقة	نوع القيمة التي تم إرجاعها	وصف قصير
getAggregation()	AggregationType	تعرض AggregationType لـ Field.
getDescription()	String	تعرض وصف Field هذا.
getFormula()	String	تعرض هذه الدالة صيغة Field.
getGroup()	String	تعرض هذه السمة مجموعة Field.
getId()	String	تعرِض هذه السمة معرّف Field.
getIsReaggregatable()	Boolean	تعرِض هذه الدالة القيمة true إذا كان يمكن إعادة تجميع هذا الحقل، أو القيمة false في حال عدم إمكانية ذلك.
getName()	String	تعرِض هذه السمة اسم Field.
getType()	FieldType	تعرض FieldType لـ Field.
isDefault()	Boolean	تعرِض الدالة القيمة true إذا كان Field هو المقياس أو السمة التلقائيَّين.
isDimension()	Boolean	تعرِض هذه الدالة القيمة true إذا كان هذا الحقل سمة.
isHidden()	Boolean	تعرض هذه السمة القيمة true إذا كانت السمة Field مخفية.
isMetric()	Boolean	تعرِض هذه الدالة true إذا كان هذا الحقل مقياسًا.
setAggregation(aggregation)	Field	تضبط هذه السمة نوع التجميع الخاص بـ Field.
setDescription(description)	Field	تضبط هذه السمة وصف Field.
setFormula(formula)	Field	تضبط هذه السمة صيغة Field.
setGroup(group)	Field	تضبط هذه السمة مجموعة Field.
setId(id)	Field	يضبط هذا الإجراء رقم تعريف Field.
setIsHidden(isHidden)	Field	تضبط هذه السمة حالة الإخفاء لـ Field.
setIsReaggregatable(isReaggregatable)	Field	يضبط هذا الإجراء حالة السماح بإعادة التجميع لـ Field.
setName(name)	Field	تضبط هذه السمة اسم Field.
setType(type)	Field	تضبط هذه السمة FieldType لـ Field.

مستندات تفصيلية

getAggregation()

تعرض AggregationType لـ Field. تحدّد AggregationType طريقة دمج "مركز البيانات" للبيانات المشابهة في سمات.

الإرجاع

AggregationType: تمثّل هذه السمة aggregationType لهذا الحقل.

---

getDescription()

تعرض وصف Field هذا. الأوصاف هي توضيحات موجزة عن الغرض من الحقل.

الإرجاع

String: وصف هذا الحقل.

---

getFormula()

تعرض هذه الدالة صيغة Field. تحدّد الصيغ عملية تحويل البيانات التي ينفّذها "مركز البيانات" في وقت طلب البحث.

الإرجاع

String: صيغة هذا الحقل

---

getGroup()

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

الإرجاع

‫String: المجموعة التي ينتمي إليها هذا الحقل.

---

getId()

تعرِض هذه السمة معرّف Field. تكون المعرّفات فريدة لكل مجموعة من الحقول، ويتم استخدامها في الصيغ للإشارة إلى الحقول.

الإرجاع

String: رقم تعريف هذا الحقل

---

getIsReaggregatable()

تعرِض هذه الدالة القيمة true إذا كان يمكن إعادة تجميع هذا الحقل، أو القيمة false في حال عدم إمكانية ذلك.

الإرجاع

‫Boolean: true إذا كان يمكن إعادة تجميع هذا الحقل، false في الحالات الأخرى.

---

getName()

تعرِض هذه السمة اسم Field. تظهر الأسماء للمستخدم للتمييز بين الحقول.

الإرجاع

String: اسم هذا الحقل.

---

getType()

تعرض FieldType لـ Field.

الإرجاع

FieldType: تمثّل نوع هذا الحقل.

---

isDefault()

تعرِض الدالة القيمة true إذا كان Field هو المقياس أو السمة التلقائيَّين.

الإرجاع

Boolean: true إذا كان Field هو المقياس أو السمة التلقائيان، false في ما عدا ذلك.

---

isDimension()

تعرِض هذه الدالة القيمة true إذا كان هذا الحقل سمة.

الإرجاع

Boolean: true إذا كان هذا الحقل سمة، وتعرض false بخلاف ذلك.

---

isHidden()

تعرض هذه السمة القيمة true إذا كانت السمة Field مخفية. يمكنك استخدام الحقول المخفية في الصيغ، ولكن ليس في الرسوم البيانية. لا يمكنك إخفاء الحقول التي تحتوي على صيغ.

الإرجاع

Boolean: true إذا كان Field مخفيًا، أو false في الحالات الأخرى.

---

isMetric()

تعرِض هذه الدالة true إذا كان هذا الحقل مقياسًا.

الإرجاع

Boolean: true إذا كان هذا الحقل مقياسًا، وتعرض false بخلاف ذلك.

---

setAggregation(aggregation)

تضبط هذه السمة نوع التجميع الخاص بـ Field. تحدّد AggregationType الطريقة التي يجمع بها "مركز البيانات" البيانات المشابهة في سمات. سيؤدي ذلك إلى حدوث خطأ إذا تم استدعاؤه على مقياس.

المَعلمات

الاسم	النوع	الوصف
aggregation	AggregationType	نوع التجميع المطلوب ضبطه.

الإرجاع

‫Field: أداة إنشاء السلاسل

---

setDescription(description)

تضبط هذه السمة وصف Field. الأوصاف هي توضيحات موجزة عن الغرض من الحقل.

المَعلمات

الاسم	النوع	الوصف
description	String	تمثّل هذه السمة الوصف المطلوب ضبطه.

الإرجاع

‫Field: أداة إنشاء السلاسل

---

setFormula(formula)

تضبط هذه السمة صيغة Field. تحدّد الصيغ عملية تحويل البيانات التي ينفّذها مركز البيانات عند تنفيذ طلب البحث.

المَعلمات

الاسم	النوع	الوصف
formula	String	الصيغة المطلوب ضبطها.

الإرجاع

‫Field: أداة إنشاء السلاسل

---

setGroup(group)

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

المَعلمات

الاسم	النوع	الوصف
group	String	المجموعة المطلوب ضبطها

الإرجاع

‫Field: أداة إنشاء السلاسل

---

setId(id)

يضبط هذا الإجراء رقم تعريف Field. تكون المعرّفات فريدة لكل مجموعة من الحقول، ويتم استخدامها في الصيغ للإشارة إلى الحقول.

المَعلمات

الاسم	النوع	الوصف
id	String	المعرّف المطلوب ضبطه.

الإرجاع

‫Field: أداة إنشاء السلاسل

---

setIsHidden(isHidden)

تضبط هذه السمة حالة الإخفاء لـ Field. يمكنك استخدام الحقول المخفية في الصيغ، ولكن ليس في الرسوم البيانية. لا يمكنك إخفاء الحقول التي تحتوي على صيغ.

المَعلمات

الاسم	النوع	الوصف
isHidden	Boolean	حالة الإخفاء المطلوب ضبطها

الإرجاع

‫Field: أداة إنشاء السلاسل

---

setIsReaggregatable(isReaggregatable)

يضبط هذا الإجراء حالة السماح بإعادة التجميع لـ Field. ستؤدي محاولة ضبط نوع تجميع على حقل لا يمكن إعادة تجميعه إلى حدوث خطأ.

المَعلمات

الاسم	النوع	الوصف
isReaggregatable	Boolean	حالة إعادة التجميع المسموح بها المطلوب ضبطها.

الإرجاع

‫Field: أداة إنشاء السلاسل

---

setName(name)

تضبط هذه السمة اسم Field. تظهر الأسماء للمستخدم للتمييز بين الحقول.

المَعلمات

الاسم	النوع	الوصف
name	String	تمثّل هذه السمة الاسم المطلوب ضبطه.

الإرجاع

‫Field: أداة إنشاء السلاسل

---

setType(type)

تضبط هذه السمة FieldType لـ Field.

المَعلمات

الاسم	النوع	الوصف
type	FieldType	النوع المطلوب ضبطه.

الإرجاع

‫Field: أداة إنشاء السلاسل