包含一組社群連接器的 Field
。這組欄位會定義
在數據分析中使用維度和指標。
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[] | 驗證這個物件,並以數據分析所需的格式傳回。 |
forIds(ids) | Fields | 傳回以 ids 中 ID 篩選至 Field 的新 Fields 物件。 |
getDefaultDimension() | Field | 傳回要用於欄位組合的預設維度。 |
getDefaultMetric() | Field | 傳回要用於一組欄位的預設指標。 |
getFieldById(fieldId) | Field | 傳回有指定 ID 的欄位;如果這個 Fields 物件中沒有與該 ID 相關的欄位,則傳回 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()); });
回攻員
build()
forIds(ids)
傳回 ids
中依 ID 篩選至 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']);
參數
名稱 | 類型 | 說明 |
---|---|---|
ids | String[] | 應保留的欄位 ID。 |
回攻員
getDefaultDimension()
getDefaultMetric()
getFieldById(fieldId)
傳回有指定 ID 的欄位;如果這個 Fields
物件中沒有與該 ID 相關的欄位,則傳回 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');
參數
名稱 | 類型 | 說明 |
---|---|---|
fieldId | String | 要取得的欄位 ID。 |
回攻員
setDefaultDimension(fieldId)
設定要用於欄位組合的預設維度。已選取預設維度 並在建立新圖表時自動套用。
參數
名稱 | 類型 | 說明 |
---|---|---|
fieldId | String | 要當做預設維度的欄位 ID。這個 ID 必須出現在 欄位組合 |
setDefaultMetric(fieldId)
設定一組欄位所用的預設指標。已選取預設指標 並在建立新圖表時自動套用。
參數
名稱 | 類型 | 說明 |
---|---|---|
fieldId | String | 要當做預設指標的欄位 ID。這個 ID 必須出現在 欄位組合。 |