Class Field

ช่อง

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

var cc = DataStudioApp.createCommunityConnector();
var fields = cc.getFields();
var types = cc.FieldType;

var field1 = fields.newDimension()
  .setId('field1_id')
  .setName('Field 1 ID')
  .setDescription('The first field.')
  .setType(types.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 — aggregationType สำหรับช่องนี้


getDescription()

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

รีเทิร์น

String — คำอธิบายสำหรับช่องนี้


getFormula()

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

รีเทิร์น

String — สูตรสำหรับช่องนี้


getGroup()

แสดงผลกลุ่มของ Field นี้ ช่องที่รวบรวมไว้เป็นกลุ่มจะแสดงร่วมกันใน UI ของ Data Studio

รีเทิร์น

String — กลุ่มสำหรับช่องนี้


getId()

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

รีเทิร์น

String — รหัสสำหรับช่องนี้


getIsReaggregatable()

แสดงผล true หากสามารถรวมช่องนี้อีกครั้ง false ในกรณีอื่นๆ

รีเทิร์น

Booleantrue หากสามารถรวมช่องนี้อีกครั้ง จะเป็น false หากไม่รวมช่องนี้


getName()

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

รีเทิร์น

String — ชื่อสำหรับช่องนี้


getType()

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

รีเทิร์น

FieldType — ประเภทของช่องนี้


isDefault()

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

รีเทิร์น

Booleantrue หาก Field นี้เป็นเมตริกหรือมิติข้อมูลเริ่มต้น หรือเป็น false ในกรณีอื่นๆ


isDimension()

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

รีเทิร์น

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


isHidden()

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

รีเทิร์น

Booleantrue หากซ่อน Field นี้ไว้ false ในกรณีอื่นๆ


isMetric()

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

รีเทิร์น

Booleantrue หากช่องนี้เป็นเมตริก จะแสดงผล false เป็นอย่างอื่น


setAggregation(aggregation)

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
aggregationAggregationTypeประเภทการรวมที่ต้องการตั้งค่า

รีเทิร์น

Field — เครื่องมือสร้างนี้สำหรับการทำเชน


setDescription(description)

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
descriptionStringคำอธิบายที่จะตั้งค่า

รีเทิร์น

Field — เครื่องมือสร้างนี้สำหรับการทำเชน


setFormula(formula)

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
formulaStringสูตรที่จะตั้งค่า

รีเทิร์น

Field — เครื่องมือสร้างนี้สำหรับการทำเชน


setGroup(group)

ตั้งค่ากลุ่มของ Field นี้ ช่องที่รวบรวมไว้เป็นกลุ่มจะแสดงร่วมกันใน UI ของ Data Studio

พารามิเตอร์

ชื่อTypeคำอธิบาย
groupStringกลุ่มที่จะตั้งค่า

รีเทิร์น

Field — เครื่องมือสร้างนี้สำหรับการทำเชน


setId(id)

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
idStringรหัสที่จะตั้งค่า

รีเทิร์น

Field — เครื่องมือสร้างนี้สำหรับการทำเชน


setIsHidden(isHidden)

ตั้งค่าสถานะการซ่อนของ Field นี้ คุณสามารถใช้ช่องที่ซ่อนอยู่ในสูตร แต่ทำไม่ได้ในแผนภูมิ คุณซ่อนช่องที่มีสูตรไม่ได้

พารามิเตอร์

ชื่อTypeคำอธิบาย
isHiddenBooleanสถานะซ่อนที่จะตั้งค่า

รีเทิร์น

Field — เครื่องมือสร้างนี้สำหรับการทำเชน


setIsReaggregatable(isReaggregatable)

ตั้งสถานะที่อนุญาตการรวมอีกครั้งสำหรับ Field การพยายามตั้งค่าประเภทการรวมในช่องที่ไม่สามารถรวมอีกครั้งจะทำให้เกิดข้อผิดพลาด

พารามิเตอร์

ชื่อTypeคำอธิบาย
isReaggregatableBooleanสถานะที่อนุญาตการรวมอีกครั้งที่จะตั้งค่า

รีเทิร์น

Field — เครื่องมือสร้างนี้สำหรับการทำเชน


setName(name)

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
nameStringชื่อที่จะตั้ง

รีเทิร์น

Field — เครื่องมือสร้างนี้สำหรับการทำเชน


setType(type)

ตั้งค่าFieldTypeของFieldนี้

พารามิเตอร์

ชื่อTypeคำอธิบาย
typeFieldTypeประเภทที่จะตั้งค่า

รีเทิร์น

Field — เครื่องมือสร้างนี้สำหรับการทำเชน