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']);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
idsString[]รหัสของฟิลด์ที่ควรเก็บไว้

รีเทิร์น

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');

พารามิเตอร์

ชื่อประเภทคำอธิบาย
fieldIdStringรหัสของช่องที่จะได้รับ

รีเทิร์น

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


newDimension()

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

รีเทิร์น

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


newMetric()

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

รีเทิร์น

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


setDefaultDimension(fieldId)

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

พารามิเตอร์

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

setDefaultMetric(fieldId)

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

พารามิเตอร์

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