Class Fields

欄位

包含社群連接器的一組 Field。這組欄位會定義可在 Google 數據分析中使用的維度和指標。

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

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

方法

方法	傳回類型	簡短說明
asArray()	Field[]	以陣列形式傳回這個物件的檢視區塊。
build()	Object[]	驗證這個物件，並以數據分析要求的格式傳回。
forIds(ids)	Fields	傳回新的 Fields 物件，並篩選出 ID 位於 ids 中的 Field。
getDefaultDimension()	Field	傳回要用於欄位集的預設維度。
getDefaultMetric()	Field	傳回要用於欄位集的預設指標。
getFieldById(fieldId)	Field	傳回具有指定 ID 的欄位，如果這個 Fields 物件中沒有具有該 ID 的欄位，則傳回 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()

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

回攻員

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

擲回

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

---

forIds(ids)

傳回新的 Fields 物件，該物件已篩選出 ID 位於 ids 中的 Field。

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[]	要保留的欄位 ID。

回攻員

Fields：新的 Fields 物件。

---

getDefaultDimension()

傳回要用於欄位集的預設維度。建立新的視覺化效果時，系統會自動選取預設維度。

回攻員

Field：設為預設維度的維度，或 null (如果未設定預設維度)。

---

getDefaultMetric()

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

回攻員

Field：設為預設指標的指標，或在未設定預設指標時為 null。

---

getFieldById(fieldId)

傳回具有指定 ID 的欄位，如果這個 Fields 物件中沒有具有該 ID 的欄位，則傳回 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	要取得的欄位 ID。

回攻員

Field - 具有指定 ID 的 Field，或 null (如果這個 Fields 物件中不含這類欄位)。

---

newDimension()

傳回新維度 Field。

回攻員

Field - 新維度 Field。

---

newMetric()

傳回新的指標 Field。

回攻員

Field - 新指標 Field。

---

setDefaultDimension(fieldId)

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

參數

名稱	類型	說明
fieldId	String	要當做預設維度的欄位 ID。這組欄位必須包含此 ID。

---

setDefaultMetric(fieldId)

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

參數

名稱	類型	說明
fieldId	String	要用做預設指標的欄位 ID。這組欄位必須包含此 ID。