Class Fields

फ़ील्ड

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

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

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

तरीके

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

विस्तृत दस्तावेज़

asArray()

इस ऑब्जेक्ट का व्यू, कलेक्शन के तौर पर दिखाता है.

var fields = //reference to fields object.
fields.newDimension().setId('field1_id');
fields.newDimension().setId('field2_id');
fields.newDimension().setId('field3_id');

// Logging the ID of each field:
fields
  .asArray()
  .map(function(field) {
     Logger.log(field.getId());
  });

वापसी का टिकट

Field[]Field ऑब्जेक्ट का कलेक्शन.


build()

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

वापसी का टिकट

Object[] — पुष्टि किया गया फ़ील्ड डेटा, जिसे ऑब्जेक्ट की सूची के तौर पर दिखाया जाता है.

थ्रो

Error — अगर कोई मान्य ऑब्जेक्ट नहीं बनाया जा सकता.


forIds(ids)

यह फ़ंक्शन ids में एक आईडी के साथ, Field के हिसाब से फ़िल्टर किया गया Fields ऑब्जेक्ट दिखाता है.

var fields = //reference to fields object.
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.
var subsetFields = fields.forIds(['field1_id', 'field3_id']);

पैरामीटर

नामटाइपब्यौरा
idsString[]उन फ़ील्ड के आईडी जिन्हें सेव रखना है.

वापसी का टिकट

Fields — एक नया Fields ऑब्जेक्ट.


getDefaultDimension()

यह फ़ील्ड के सेट के लिए इस्तेमाल होने वाला डिफ़ॉल्ट डाइमेंशन दिखाता है. डिफ़ॉल्ट डाइमेंशन यह है नया विज़ुअलाइज़ेशन बनाए जाने पर, अपने-आप चुना जाता है.

वापसी का टिकट

Field — डिफ़ॉल्ट डाइमेंशन के तौर पर सेट किया गया डाइमेंशन या डिफ़ॉल्ट डाइमेंशन न होने पर null डाइमेंशन सेट किया गया.


getDefaultMetric()

यह फ़ील्ड के सेट के लिए इस्तेमाल की जाने वाली डिफ़ॉल्ट मेट्रिक दिखाता है. डिफ़ॉल्ट मेट्रिक चुना गया नया विज़ुअलाइज़ेशन बनने पर अपने-आप अपडेट हो जाता है.

वापसी का टिकट

Field — यह डिफ़ॉल्ट मेट्रिक के तौर पर सेट की गई मेट्रिक होती है. अगर कोई डिफ़ॉल्ट मेट्रिक नहीं है, तो null सेट.


getFieldById(fieldId)

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

var fields = //reference to fields object.
var field1 = fields.newDimension().setId('field1_id');

// byId is the same as field1.
var byId = fields.getFieldById('field1_id');

// byId2 is null.
var byId2 = fields.getFieldById('not present id');

पैरामीटर

नामटाइपब्यौरा
fieldIdStringफ़ील्ड का आईडी, जिसे आपको पाना है.

वापसी का टिकट

Field — दिए गए आईडी के साथ Field या अगर ऐसा कोई फ़ील्ड मौजूद नहीं है, तो null इस Fields ऑब्जेक्ट में.


newDimension()

नया डाइमेंशन Field दिखाता है.

वापसी का टिकट

Field — एक नया डाइमेंशन Field.


newMetric()

नई मेट्रिक Field दिखाता है.

वापसी का टिकट

Field — एक नई मेट्रिक Field.


setDefaultDimension(fieldId)

यह फ़ील्ड के सेट के लिए इस्तेमाल किया जाने वाला डिफ़ॉल्ट डाइमेंशन सेट करता है. डिफ़ॉल्ट डाइमेंशन चुना गया हो नया विज़ुअलाइज़ेशन बनने पर अपने-आप अपडेट हो जाता है.

पैरामीटर

नामटाइपब्यौरा
fieldIdStringडिफ़ॉल्ट डाइमेंशन के तौर पर इस्तेमाल करने के लिए फ़ील्ड का आईडी. यह आईडी यहां होना चाहिए फ़ील्ड का सेट.

setDefaultMetric(fieldId)

यह फ़ील्ड के सेट के लिए इस्तेमाल की जाने वाली डिफ़ॉल्ट मेट्रिक सेट करता है. डिफ़ॉल्ट मेट्रिक चुना गया नया विज़ुअलाइज़ेशन बनने पर अपने-आप अपडेट हो जाता है.

पैरामीटर

नामटाइपब्यौरा
fieldIdStringडिफ़ॉल्ट मेट्रिक के तौर पर इस्तेमाल करने के लिए फ़ील्ड का आईडी. यह आईडी फ़ील्ड का सेट.