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 จะกำหนดวิธีที่ข้อมูล Studio รวมข้อมูลที่คล้ายกันเข้าเป็นมิติข้อมูล ซึ่งจะทำให้เกิดข้อผิดพลาดหากเรียกใช้เมตริก

พารามิเตอร์

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

รีเทิร์น

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


setDescription(description)

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

พารามิเตอร์

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

รีเทิร์น

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


setFormula(formula)

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

พารามิเตอร์

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

รีเทิร์น

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


setGroup(group)

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

พารามิเตอร์

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

รีเทิร์น

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


setId(id)

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

พารามิเตอร์

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

รีเทิร์น

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


setIsHidden(isHidden)

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

พารามิเตอร์

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

รีเทิร์น

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


setIsReaggregatable(isReaggregatable)

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

พารามิเตอร์

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

รีเทิร์น

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


setName(name)

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

พารามิเตอร์

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

รีเทิร์น

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


setType(type)

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

พารามิเตอร์

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

รีเทิร์น

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