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 物件，篩選出 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()

驗證這個物件，並以 Data Studio 所需的格式傳回。

回攻員

Object[]：經過驗證的欄位資料，以物件清單的形式呈現。

擲回

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

forIds(ids)

傳回新的 Fields 物件，篩選出 ids 中 ID 為 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']);

參數

名稱類型說明
idsString[]應保留的欄位 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');

參數

名稱類型說明
fieldIdString要取得的欄位 ID。

回攻員

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

newDimension()

傳回新的維度 Field。

回攻員

Field：新的維度 Field。

newMetric()

傳回新的指標 Field。

回攻員

Field：新指標 Field。

setDefaultDimension(fieldId)

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

參數

名稱類型說明
fieldIdString要用來做為預設維度的欄位 ID。此 ID 必須出現在欄位組合中。

setDefaultMetric(fieldId)

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

參數

名稱類型說明
fieldIdString要用來做為預設指標的欄位 ID。此 ID 必須出現在欄位組合中。