Class Field

มีข้อมูลที่เกี่ยวข้องกับฟิลด์ พร็อพเพอร์ตี้ของฟิลด์จะกำหนดวิธีใช้ฟิลด์ใน Data Studio

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

const field1 = fields.newDimension()
                   .setId('field1_id')
                   .setName('Field 1 ID')
                   .setDescription('The first field.')
                   .setType(cc.FieldType.YEAR_MONTH)
                   .setGroup('DATETIME');

เมธอด

วิธีการ	ประเภทการแสดงผล	รายละเอียดแบบย่อ
`getAggregation()`	`AggregationType`	แสดง `AggregationType` ของ `Field` นี้
`getDescription()`	`String`	แสดงคำอธิบายของ `Field` นี้
`getFormula()`	`String`	แสดงผลสูตรของ `Field` นี้
`getGroup()`	`String`	แสดงผลกลุ่มของ `Field` นี้
`getId()`	`String`	แสดงรหัสของ `Field` นี้
`getIsReaggregatable()`	`Boolean`	แสดงผล `true` หากรวมฟิลด์นี้ใหม่ได้ หรือ `false` ในกรณีอื่นๆ
`getName()`	`String`	แสดงผลชื่อของ `Field` นี้
`getType()`	`FieldType`	แสดง `FieldType` ของ `Field` นี้
`isDefault()`	`Boolean`	แสดงผล `true` หาก `Field` นี้เป็นเมตริกหรือมิติข้อมูลเริ่มต้น
`isDimension()`	`Boolean`	แสดงผล `true` หากฟิลด์นี้เป็นมิติข้อมูล
`isHidden()`	`Boolean`	แสดง `true` หาก `Field` นี้ซ่อนอยู่
`isMetric()`	`Boolean`	แสดงผล `true` หากฟิลด์นี้เป็นเมตริก
`setAggregation(aggregation)`	`Field`	ตั้งค่าประเภทการรวมของ `Field` นี้
`setDescription(description)`	`Field`	ตั้งค่าคำอธิบายของ `Field` นี้
`setFormula(formula)`	`Field`	ตั้งค่าสูตรของ `Field` นี้
`setGroup(group)`	`Field`	ตั้งค่ากลุ่มของ `Field` นี้
`setId(id)`	`Field`	ตั้งค่ารหัสของ `Field` นี้
`setIsHidden(isHidden)`	`Field`	ตั้งค่าสถานะซ่อนของ `Field` นี้
`setIsReaggregatable(isReaggregatable)`	`Field`	ตั้งค่าสถานะที่อนุญาตให้รวมอีกครั้งสำหรับ `Field`
`setName(name)`	`Field`	ตั้งชื่อของ `Field` นี้
`setType(type)`	`Field`	ตั้งค่า `FieldType` ของ `Field` นี้

เอกสารโดยละเอียด

`getAggregation()`

แสดง AggregationType ของ Field นี้ AggregationType จะกำหนด วิธีที่ Data Studio รวมข้อมูลที่คล้ายกันเป็นมิติข้อมูล

รีเทิร์น

AggregationType — The aggregationType for this field.

`getDescription()`

แสดงคำอธิบายของ Field นี้ คำอธิบายคือคำอธิบายสั้นๆ เกี่ยวกับ วัตถุประสงค์ของฟิลด์

รีเทิร์น

String — คำอธิบายของช่องนี้

`getFormula()`

แสดงผลสูตรของ Field นี้ สูตรจะกำหนดการเปลี่ยนรูปแบบข้อมูลที่ Data Studio เรียกใช้ในเวลาที่ทำการค้นหา

รีเทิร์น

String — สูตรสำหรับฟิลด์นี้

`getGroup()`

แสดงผลกลุ่มของ Field นี้ ระบบจะแสดงฟิลด์ที่รวบรวมไว้ในกลุ่มด้วยกัน ใน UI ของ Data Studio

รีเทิร์น

String - กลุ่มสำหรับฟิลด์นี้

`getId()`

แสดงรหัสของ Field นี้ รหัสจะไม่ซ้ำกันต่อชุดฟิลด์และใช้ในสูตร เพื่ออ้างอิงถึงฟิลด์

รีเทิร์น

String - รหัสของฟิลด์นี้

`getIsReaggregatable()`

แสดงผล true หากรวมฟิลด์นี้ใหม่ได้ หรือ false ในกรณีอื่นๆ

รีเทิร์น

Boolean — true หากฟิลด์นี้รวมใหม่ได้ false มิฉะนั้น

`getName()`

แสดงผลชื่อของ Field นี้ ชื่อจะแสดงต่อผู้ใช้เพื่อแยกความแตกต่างของช่อง

รีเทิร์น

String - ชื่อของฟิลด์นี้

`getType()`

แสดง FieldType ของ Field นี้

รีเทิร์น

FieldType - ประเภทของฟิลด์นี้

`isDefault()`

แสดงผล true หาก Field นี้เป็นเมตริกหรือมิติข้อมูลเริ่มต้น

รีเทิร์น

Boolean — true หากFieldนี้เป็นเมตริกหรือมิติข้อมูลเริ่มต้น false ไม่เช่นนั้น

`isDimension()`

แสดงผล true หากฟิลด์นี้เป็นมิติข้อมูล

รีเทิร์น

Boolean — true หากฟิลด์นี้เป็นมิติข้อมูล หรือแสดงผล false ในกรณีอื่นๆ

`isHidden()`

แสดง true หาก Field นี้ซ่อนอยู่ คุณใช้ฟิลด์ที่ซ่อนไว้ในสูตรได้ แต่ใช้ในแผนภูมิไม่ได้ คุณซ่อนฟิลด์ที่มีสูตรไม่ได้

รีเทิร์น

Boolean — true หากFieldนี้ซ่อนอยู่ false ในกรณีอื่นๆ

`isMetric()`

แสดงผล true หากฟิลด์นี้เป็นเมตริก

รีเทิร์น

Boolean — true หากฟิลด์นี้เป็นเมตริก หรือแสดงผล false ในกรณีอื่นๆ

`setAggregation(aggregation)`

ตั้งค่าประเภทการรวมของ Field นี้ AggregationType จะกำหนดวิธีที่ Data Studio รวมข้อมูลที่คล้ายกันเป็นมิติข้อมูล ซึ่งจะทำให้เกิดข้อผิดพลาดหากเรียกใช้ในเมตริก