Class Field

필드

필드 관련 데이터를 포함합니다. 속성에 따라 데이터 스튜디오에서 필드가 사용되는 방식이 결정됩니다.

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	이 Field의 AggregationType를 반환합니다.
getDescription()	String	이 Field의 설명을 반환합니다.
getFormula()	String	이 Field의 수식을 반환합니다.
getGroup()	String	이 Field의 그룹을 반환합니다.
getId()	String	이 Field의 ID를 반환합니다.
getIsReaggregatable()	Boolean	이 필드를 재집계할 수 있으면 true를 반환하고, 그렇지 않으면 false를 반환합니다.
getName()	String	이 Field의 이름을 반환합니다.
getType()	FieldType	이 Field의 FieldType를 반환합니다.
isDefault()	Boolean	이 Field가 기본 측정항목 또는 측정기준인 경우 true를 반환합니다.
isDimension()	Boolean	이 필드가 측정기준인 경우 true를 반환합니다.
isHidden()	Boolean	이 Field가 숨겨져 있으면 true을 반환합니다.
isMetric()	Boolean	이 필드가 측정항목인 경우 true를 반환합니다.
setAggregation(aggregation)	Field	이 Field의 집계 유형을 설정합니다.
setDescription(description)	Field	이 Field의 설명을 설정합니다.
setFormula(formula)	Field	이 Field의 수식을 설정합니다.
setGroup(group)	Field	이 Field의 그룹을 설정합니다.
setId(id)	Field	이 Field의 ID를 설정합니다.
setIsHidden(isHidden)	Field	이 Field의 숨김 상태를 설정합니다.
setIsReaggregatable(isReaggregatable)	Field	Field의 재집계 허용 상태를 설정합니다.
setName(name)	Field	이 Field의 이름을 설정합니다.
setType(type)	Field	이 Field의 FieldType를 설정합니다.

자세한 문서

getAggregation()

이 Field의 AggregationType를 반환합니다. AggregationType는 데이터 스튜디오에서 유사한 데이터를 측정기준으로 결합하는 방법을 결정합니다.

리턴

AggregationType: 이 필드의 aggregationType입니다.

---

getDescription()

이 Field의 설명을 반환합니다. 설명은 필드의 목적에 관한 간단한 설명입니다.

리턴

String: 이 필드에 대한 설명입니다.

---

getFormula()

이 Field의 수식을 반환합니다. 수식은 데이터 스튜디오가 쿼리 실행 시 실행하는 데이터 변환을 정의합니다.

리턴

String: 이 필드의 수식입니다.

---

getGroup()

이 Field의 그룹을 반환합니다. 그룹으로 수집된 필드는 데이터 스튜디오 UI에 함께 표시됩니다.

리턴

String: 이 필드의 그룹입니다.

---

getId()

이 Field의 ID를 반환합니다. ID는 필드 세트별로 고유하며 수식에서 필드를 참조하는 데 사용됩니다.

리턴

String: 이 필드의 ID입니다.

---

getIsReaggregatable()

이 필드를 재집계할 수 있으면 true를 반환하고, 그렇지 않으면 false를 반환합니다.

리턴

Boolean: 이 필드를 재집계할 수 있는 경우 true, 그렇지 않은 경우 false입니다.

---

getName()

이 Field의 이름을 반환합니다. 이름은 필드를 구분하기 위해 사용자에게 표시됩니다.

리턴

String: 이 필드의 이름입니다.

---

getType()

이 Field의 FieldType를 반환합니다.

리턴

FieldType: 이 필드의 유형입니다.

---

isDefault()

이 Field가 기본 측정항목 또는 측정기준인 경우 true를 반환합니다.

리턴

Boolean: 이 Field가 기본 측정항목 또는 측정기준인 경우 true이고, 그렇지 않은 경우에는 false입니다.

---

isDimension()

이 필드가 측정기준인 경우 true를 반환합니다.

리턴

Boolean - 이 필드가 측정기준인 경우 true를 반환하고, 그렇지 않으면 false를 반환합니다.

---

isHidden()

이 Field가 숨겨져 있으면 true을 반환합니다. 숨겨진 필드는 수식에서는 사용할 수 있지만 차트에서는 사용할 수 없습니다. 수식이 포함된 필드는 숨길 수 없습니다.

리턴

Boolean: 이 Field가 숨겨져 있으면 true이고, 그렇지 않으면 false입니다.

---

isMetric()

이 필드가 측정항목인 경우 true를 반환합니다.

리턴

Boolean: 이 필드가 측정항목인 경우 true를 반환하고, 그렇지 않으면 false를 반환합니다.

---

setAggregation(aggregation)

이 Field의 집계 유형을 설정합니다. AggregationType는 데이터 스튜디오에서 유사한 데이터를 측정기준으로 결합하는 방법을 결정합니다. 측정항목에서 호출하면 오류가 발생합니다.

매개변수

이름	유형	설명
aggregation	AggregationType	설정할 집계 유형입니다.

리턴

Field: 체이닝을 위한 이 빌더

---

setDescription(description)

이 Field의 설명을 설정합니다. 설명은 필드의 목적에 관한 간단한 설명입니다.

매개변수

이름	유형	설명
description	String	설정할 설명입니다.

리턴

Field: 체이닝을 위한 이 빌더

---

setFormula(formula)

이 Field의 수식을 설정합니다. 수식은 데이터 스튜디오에서 쿼리 실행 시 실행되는 데이터 변환을 정의합니다.

매개변수

이름	유형	설명
formula	String	설정할 수식입니다.

리턴

Field: 체이닝을 위한 이 빌더

---

setGroup(group)

이 Field의 그룹을 설정합니다. 그룹으로 수집된 필드는 데이터 스튜디오 UI에 함께 표시됩니다.

매개변수

이름	유형	설명
group	String	설정할 그룹입니다.

리턴

Field: 체이닝을 위한 이 빌더

---

setId(id)

이 Field의 ID를 설정합니다. ID는 필드 세트별로 고유하며 수식에서 필드를 참조하는 데 사용됩니다.

매개변수

이름	유형	설명
id	String	설정할 ID입니다.

리턴

Field: 체이닝을 위한 이 빌더

---

setIsHidden(isHidden)

이 Field의 숨김 상태를 설정합니다. 숨겨진 필드는 수식에서는 사용할 수 있지만 차트에서는 사용할 수 없습니다. 수식이 포함된 필드는 숨길 수 없습니다.

매개변수

이름	유형	설명
isHidden	Boolean	설정할 숨김 상태입니다.

리턴

Field: 체이닝을 위한 이 빌더

---

setIsReaggregatable(isReaggregatable)

Field의 재집계 허용 상태를 설정합니다. 재집계할 수 없는 필드에 집계 유형을 설정하려고 하면 오류가 발생합니다.

매개변수

이름	유형	설명
isReaggregatable	Boolean	재집계가 허용되는 상태를 설정합니다.

리턴

Field: 체이닝을 위한 이 빌더

---

setName(name)

이 Field의 이름을 설정합니다. 이름은 필드를 구분하기 위해 사용자에게 표시됩니다.

매개변수

이름	유형	설명
name	String	설정할 이름입니다.

리턴

Field: 체이닝을 위한 이 빌더

---

setType(type)

이 Field의 FieldType를 설정합니다.

매개변수

이름	유형	설명
type	FieldType	설정할 유형입니다.

리턴

Field: 체이닝을 위한 이 빌더