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: نوع التجميع لهذا الحقل.


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 هو المقياس أو السمة التلقائية.

الإرجاع

Booleantrue إذا كانت هذه السمة Field هي المقياس أو السمة التلقائية، false في غير ذلك.


isDimension()

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

الإرجاع

Boolean: true إذا كان هذا الحقل سمة، وfalse في حال عدم ذلك


isHidden()

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

الإرجاع

Boolean: true إذا كان هذا Field مخفيًا، وfalse بخلاف ذلك


isMetric()

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

الإرجاع

Boolean: true إذا كان هذا الحقل مقياسًا، وfalse في حال عدم ذلك


setAggregation(aggregation)

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

المعلَمات

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

الإرجاع

Field: هذا المُنشئ، لتسلسل العناصر.


setDescription(description)

لضبط وصف هذا Field. الأوصاف هي شرح موجز لهدف الحقل.

المعلَمات

الاسمالنوعالوصف
descriptionStringالوصف المطلوب ضبطه

الإرجاع

Field: هذا المُنشئ، لتسلسل العناصر.


setFormula(formula)

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

المعلَمات

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

الإرجاع

Field: هذا المُنشئ، لتسلسل العناصر.


setGroup(group)

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

المعلَمات

الاسمالنوعالوصف
groupStringالمجموعة المطلوب ضبطها.

الإرجاع

Field: هذا المُنشئ، لتسلسل العناصر.


setId(id)

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

المعلَمات

الاسمالنوعالوصف
idStringرقم التعريف المطلوب ضبطه.

الإرجاع

Field: هذا المُنشئ، لتسلسل العناصر.


setIsHidden(isHidden)

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

المعلَمات

الاسمالنوعالوصف
isHiddenBooleanالحالة المخفية المطلوب ضبطها

الإرجاع

Field: هذا المُنشئ، لتسلسل العناصر.


setIsReaggregatable(isReaggregatable)

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

المعلَمات

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

الإرجاع

Field: هذا المُنشئ، لتسلسل العناصر.


setName(name)

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

المعلَمات

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

الإرجاع

Field: هذا المُنشئ، لتسلسل العناصر.


setType(type)

تُستخدَم لضبط FieldType لهذا Field.

المعلَمات

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

الإرجاع

Field: هذا المُنشئ، لتسلسل العناصر.