Class Fields

फ़ील्ड

इसमें कम्यूनिटी कनेक्टर के लिए, Field का सेट होता है. फ़ील्ड के इस सेट से यह तय होता है कि Data Studio में किन डाइमेंशन और मेट्रिक का इस्तेमाल किया जा सकता है.

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

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

तरीके

तरीका	रिटर्न टाइप	संक्षिप्त विवरण
asArray()	Field[]	इस ऑब्जेक्ट के व्यू को ऐरे के तौर पर दिखाता है.
build()	Object[]	यह ऑब्जेक्ट की पुष्टि करता है और उसे Data Studio के लिए ज़रूरी फ़ॉर्मैट में दिखाता है.
forIds(ids)	Fields	यह फ़ंक्शन, Fields ऑब्जेक्ट का नया इंस्टेंस दिखाता है. इसे Fields के हिसाब से फ़िल्टर किया जाता है. साथ ही, इसमें ids में मौजूद आईडी होता है.
getDefaultDimension()	Field	फ़ील्ड के सेट के लिए इस्तेमाल किए जाने वाले डिफ़ॉल्ट डाइमेंशन को दिखाता है.
getDefaultMetric()	Field	यह फ़ील्ड के सेट के लिए इस्तेमाल की जाने वाली डिफ़ॉल्ट मेट्रिक दिखाता है.
getFieldById(fieldId)	Field	यह फ़ंक्शन, दिए गए आईडी वाला फ़ील्ड दिखाता है. अगर इस Fields ऑब्जेक्ट में उस आईडी वाला कोई फ़ील्ड नहीं है, तो यह null दिखाता है.
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()

यह ऑब्जेक्ट की पुष्टि करता है और उसे Data Studio के लिए ज़रूरी फ़ॉर्मैट में दिखाता है.

वापसी का टिकट

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)

यह फ़ंक्शन, दिए गए आईडी वाला फ़ील्ड दिखाता है. अगर इस Fields ऑब्जेक्ट में उस आईडी वाला कोई फ़ील्ड नहीं है, तो यह null दिखाता है.

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	डिफ़ॉल्ट मेट्रिक के तौर पर इस्तेमाल किए जाने वाले फ़ील्ड का आईडी. यह आईडी, फ़ील्ड के सेट में मौजूद होना चाहिए.