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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
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 — ตัวสร้างนี้สําหรับการต่อเชื่อม