Class Field

الحقل

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

var cc = DataStudioApp.createCommunityConnector();
var fields = cc.getFields();
var types = cc.FieldType;

var field1 = fields.newDimension()
  .setId('field1_id')
  .setName('Field 1 ID')
  .setDescription('The first field.')
  .setType(types.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 في الحالات الأخرى.

الإرجاع

Booleantrue إذا كان من الممكن إعادة تجميع هذا الحقل، أو false إذا كان من الممكن إعادة تجميعه


getName()

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

الإرجاع

String — اسم هذا الحقل


getType()

تعرض FieldType من Field.

الإرجاع

FieldType — نوع هذا الحقل


isDefault()

تعرض true إذا كان هذا Field هو المقياس أو البُعد التلقائي.

الإرجاع

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


isDimension()

تعرض true إذا كان هذا الحقل بُعدًا.

الإرجاع

Booleantrue إذا كان هذا الحقل سمة تعرض false في الحالات الأخرى.


isHidden()

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

الإرجاع

Booleantrue إذا كانت قيمة Field هذه مخفية false في الحالات الأخرى.


isMetric()

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

الإرجاع

Booleantrue إذا كان هذا الحقل مقياسًا تعرض false في الحالات الأخرى.


setAggregation(aggregation)

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

المعلمات

الاسمالنوعالوصف
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 — أداة الإنشاء هذه، للسلاسل