Class Fields

欄位

包含社群連接器的一組 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());
  });

回攻員

Field[] — Field 物件的陣列。

---

build()

驗證這個物件，並以數據分析所需的格式傳回。

回攻員

Object[]：已驗證的欄位資料，以物件清單表示。

擲回

Error：如果無法建構有效物件。

---

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。

回攻員

Fields：新的 Fields 物件。

---

getDefaultDimension()

傳回一組欄位要使用的預設維度。建立新的圖表時，系統會自動選取預設維度。

回攻員

Field：設為預設維度的維度；如未設定預設維度，則為 null。

---

getDefaultMetric()

傳回要用於一組欄位的預設指標。建立新的視覺化圖表時，系統會自動選取預設指標。

回攻員

Field：設為預設指標的指標；如未設定預設指標，則為 null。

---

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。

回攻員

Field：具有指定 ID 的 Field，如果 Fields 物件中沒有這類欄位，則為 null。

---

newDimension()

傳回新維度 Field。

回攻員

Field：新維度 Field。

---

newMetric()

傳回新的指標 Field。

回攻員

Field：新的指標 Field。

---

setDefaultDimension(fieldId)

設定欄位組合要使用的預設維度。建立新的圖表時，系統會自動選取預設維度。

參數

名稱	類型	說明
fieldId	String	要用做預設維度的欄位 ID。這個 ID 必須出現在欄位組合中。

---

setDefaultMetric(fieldId)

設定一組欄位要使用的預設指標。建立新的視覺化圖表時，系統會自動選取預設指標。

參數

名稱	類型	說明
fieldId	String	要用做預設指標的欄位 ID。這個 ID 必須出現在欄位組合中。