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 ใหม่ซึ่งกรองเป็น Field ที่มีรหัสใน ids
getDefaultDimension()	Field	แสดงผลมิติข้อมูลเริ่มต้นที่จะใช้กับชุดช่อง
getDefaultMetric()	Field	แสดงผลเมตริกเริ่มต้นที่จะใช้กับชุดช่อง
getFieldById(fieldId)	Field	แสดงผลฟิลด์ที่มีรหัสที่ระบุ หรือ null หากไม่มีฟิลด์ที่มีรหัสนั้นอยู่ในออบเจ็กต์ Fields นี้
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 ใหม่ซึ่งกรองเป็น Field ที่มีรหัสใน ids

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[]	รหัสของช่องที่ควรเก็บไว้

รีเทิร์น

Fields — ออบเจ็กต์ Fields ใหม่

---

getDefaultDimension()

แสดงผลมิติข้อมูลเริ่มต้นที่จะใช้กับชุดช่อง ระบบจะเลือกมิติข้อมูลเริ่มต้นโดยอัตโนมัติเมื่อมีการสร้างการแสดงข้อมูลผ่านภาพใหม่

รีเทิร์น

Field — มิติข้อมูลที่กําหนดเป็นมิติข้อมูลเริ่มต้น หรือ null หากไม่ได้กําหนดมิติข้อมูลเริ่มต้น

---

getDefaultMetric()

แสดงผลเมตริกเริ่มต้นที่จะใช้กับชุดช่อง ระบบจะเลือกเมตริกเริ่มต้นโดยอัตโนมัติเมื่อมีการสร้างการแสดงข้อมูลผ่านภาพใหม่

รีเทิร์น

Field — เมตริกที่ตั้งเป็นเมตริกเริ่มต้น หรือ null หากไม่ได้ตั้งค่าเมตริกเริ่มต้น

---

getFieldById(fieldId)

แสดงผลฟิลด์ที่มีรหัสที่ระบุ หรือ null หากไม่มีฟิลด์ที่มีรหัสนั้นอยู่ในออบเจ็กต์ Fields นี้

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	รหัสของช่องที่จะรับ

รีเทิร์น

Field — Field ที่มีรหัสที่ระบุ หรือ null หากไม่มีช่องดังกล่าวอยู่ในออบเจ็กต์ Fields นี้

---

newDimension()

แสดงผลมิติข้อมูลใหม่ Field

รีเทิร์น

Field — มิติข้อมูลใหม่ Field

---

newMetric()

แสดงผลเมตริกใหม่ Field

รีเทิร์น

Field — เมตริกใหม่ Field

---

setDefaultDimension(fieldId)

ตั้งค่ามิติข้อมูลเริ่มต้นที่จะใช้กับชุดช่อง ระบบจะเลือกมิติข้อมูลเริ่มต้นโดยอัตโนมัติเมื่อสร้างการแสดงข้อมูลผ่านภาพใหม่

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
fieldId	String	รหัสของช่องที่จะใช้เป็นมิติข้อมูลเริ่มต้น รหัสนี้ต้องอยู่ในชุดช่อง

---

setDefaultMetric(fieldId)

ตั้งค่าเมตริกเริ่มต้นที่จะใช้กับชุดช่อง ระบบจะเลือกเมตริกเริ่มต้นโดยอัตโนมัติเมื่อมีการสร้างการแสดงข้อมูลผ่านภาพใหม่

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
fieldId	String	รหัสของช่องที่จะใช้เป็นเมตริกเริ่มต้น รหัสนี้ต้องอยู่ในชุดช่อง