Class Field

필드

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

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

자세한 문서

getAggregation()

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

리턴

AggregationType - 이 필드의 AggregateType입니다.


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()

FieldFieldType를 반환합니다.

리턴

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는 데이터 스튜디오에서 유사한 데이터를 측정기준으로 결합하는 방법을 결정합니다. 측정항목에서 호출하면 오류가 발생합니다.

매개변수

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

리턴

Field - 체이닝을 위한 빌더입니다.


setDescription(description)

Field의 설명을 설정합니다. 설명은 필드의 용도에 관한 간단한 설명입니다.

매개변수

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

리턴

Field - 체이닝을 위한 빌더입니다.


setFormula(formula)

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

매개변수

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

리턴

Field - 체이닝을 위한 빌더입니다.


setGroup(group)

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

매개변수

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

리턴

Field - 체이닝을 위한 빌더입니다.


setId(id)

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

매개변수

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

리턴

Field - 체이닝을 위한 빌더입니다.


setIsHidden(isHidden)

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

매개변수

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

리턴

Field - 체이닝을 위한 빌더입니다.


setIsReaggregatable(isReaggregatable)

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

매개변수

이름유형설명
isReaggregatableBoolean설정할 재집계 허용 상태입니다.

리턴

Field - 체이닝을 위한 빌더입니다.


setName(name)

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

매개변수

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

리턴

Field - 체이닝을 위한 빌더입니다.


setType(type)

FieldFieldType를 설정합니다.

매개변수

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

리턴

Field - 체이닝을 위한 빌더입니다.