Class Fields

ช่อง

มีชุด Field สำหรับปลั๊กอินจากชุมชนสำหรับใช้ลิงก์ข้อมูล โดยช่องชุดนี้จะกำหนดว่า คุณสามารถใช้มิติข้อมูลและเมตริกได้ใน Data Studio

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[]ตรวจสอบออบเจ็กต์นี้และส่งคืนในรูปแบบที่ 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()

แสดงผลมุมมองของออบเจ็กต์นี้เป็นอาร์เรย์

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()

ตรวจสอบออบเจ็กต์นี้และส่งคืนในรูปแบบที่ Data Studio ต้องการ

รีเทิร์น

Object[] — ข้อมูลช่องที่ได้รับการตรวจสอบแล้ว ซึ่งแสดงเป็นรายการออบเจ็กต์

การขว้าง

Error — หากสร้างออบเจ็กต์ที่ถูกต้องไม่ได้


forIds(ids)

แสดงผลออบเจ็กต์ Fields ใหม่ที่กรองเป็น Field พร้อมรหัสใน ids

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

พารามิเตอร์

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

รีเทิร์น

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


getDefaultDimension()

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

รีเทิร์น

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


getDefaultMetric()

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

รีเทิร์น

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


getFieldById(fieldId)

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

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

พารามิเตอร์

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

รีเทิร์น

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


newDimension()

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

รีเทิร์น

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


newMetric()

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

รีเทิร์น

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


setDefaultDimension(fieldId)

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

พารามิเตอร์

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

setDefaultMetric(fieldId)

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

พารามิเตอร์

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