Class Fields

필드

커뮤니티 커넥터의 Field 집합을 포함합니다. 이 필드 집합은 데이터 스튜디오에서 사용할 수 있는 측정기준과 측정항목을 정의합니다. 

const cc = DataStudioApp.createCommunityConnector();
const fields = cc.getFields();

const field1 = fields
                   .newDimension()
                   // Set other properties as needed.
                   .setId('field1_id');

메서드

메서드반환 유형간략한 설명
asArray()Field[]이 객체의 뷰를 배열로 반환합니다.
build()Object[]이 객체를 검증하고 Data Studio에 필요한 형식으로 반환합니다.
forIds(ids)Fieldsids에 ID가 있는 Field로 필터링된 새 Fields 객체를 반환합니다.
getDefaultDimension()Field필드 집합에 사용할 기본 측정기준을 반환합니다.
getDefaultMetric()Field필드 집합에 사용할 기본 측정항목을 반환합니다.
getFieldById(fieldId)Field지정된 ID가 있는 필드를 반환하거나 이 Fields 객체에 해당 ID가 있는 필드가 없는 경우 null을 반환합니다.
newDimension()Field새 측정기준 Field을 반환합니다.
newMetric()Field새 측정항목 Field를 반환합니다.
setDefaultDimension(fieldId)void필드 집합에 사용할 기본 측정기준을 설정합니다.
setDefaultMetric(fieldId)void필드 집합에 사용할 기본 측정항목을 설정합니다.

자세한 문서

asArray()

이 객체의 뷰를 배열로 반환합니다. 

const fields = DataStudioApp.createCommunityConnector().getFields();
fields.newDimension().setId('field1_id');
fields.newDimension().setId('field2_id');
fields.newDimension().setId('field3_id');

// Logging the ID of each field:
fields.asArray().map((field) => {
  Logger.log(field.getId());
});

리턴

Field[]: Field 객체의 배열입니다.

build()

이 객체를 검증하고 Data Studio에 필요한 형식으로 반환합니다.

리턴

Object[]: 검증된 필드 데이터로, 객체 목록으로 표시됩니다.

생성 값

Error: 유효한 객체를 생성할 수 없는 경우

forIds(ids)

ids에 ID가 있는 Field로 필터링된 새 Fields 객체를 반환합니다. 

const fields = DataStudioApp.createCommunityConnector().getFields();
fields.newDimension().setId('field1_id');
fields.newDimension().setId('field2_id');
fields.newDimension().setId('field3_id');

// subsetFields is a Fields object that only contains field1 and field2.
const subsetFields = fields.forIds(['field1_id', 'field3_id']);

매개변수

이름유형설명
idsString[]유지해야 하는 필드의 ID입니다.

리턴

Fields: 새 Fields 객체입니다.

getDefaultDimension()

필드 집합에 사용할 기본 측정기준을 반환합니다. 새 시각화를 만들 때 기본 측정기준이 자동으로 선택됩니다.

리턴

Field: 기본 측정기준으로 설정된 측정기준 또는 기본 측정기준이 설정되지 않은 경우 null입니다.

getDefaultMetric()

필드 집합에 사용할 기본 측정항목을 반환합니다. 새 시각화를 만들 때 기본 측정항목이 자동으로 선택됩니다.

리턴

Field: 기본 측정항목으로 설정된 측정항목 또는 기본 측정항목이 설정되지 않은 경우 null입니다.

getFieldById(fieldId)

지정된 ID가 있는 필드를 반환하거나 이 Fields 객체에 해당 ID가 있는 필드가 없는 경우 null을 반환합니다. 

const fields = DataStudioApp.createCommunityConnector().getFields();
const field1 = fields.newDimension().setId('field1_id');

// byId is the same as field1.
const byId = fields.getFieldById('field1_id');

// byId2 is null.
const byId2 = fields.getFieldById('not present id');

매개변수

이름유형설명
fieldIdString가져올 필드의 ID입니다.

리턴

Field: 지정된 ID의 Field 또는 이 Fields 객체 내에 이러한 필드가 포함되지 않은 경우 null입니다.

newDimension()

새 측정기준 Field을 반환합니다.

리턴

Field: 새 측정기준 Field입니다.

newMetric()

새 측정항목 Field를 반환합니다.

리턴

Field: 새 측정항목 Field입니다.

setDefaultDimension(fieldId)

필드 집합에 사용할 기본 측정기준을 설정합니다. 새 시각화를 만들 때 기본 측정기준이 자동으로 선택됩니다.

매개변수

이름유형설명
fieldIdString기본 측정기준으로 사용할 필드의 ID입니다. 이 ID는 필드 세트에 있어야 합니다.

setDefaultMetric(fieldId)

필드 집합에 사용할 기본 측정항목을 설정합니다. 새 시각화를 만들 때 기본 측정항목이 자동으로 선택됩니다.

매개변수

이름유형설명
fieldIdString기본 측정항목으로 사용할 필드의 ID입니다. 이 ID는 필드 집합에 있어야 합니다.