본문으로 건너뛰기

메타데이터 관리 API

최근 업데이트 2026. 10. 03.

호출 방법은 Open API 문서의 호출 방법 설명을 참고하십시오.

관련 기능을 이해하려면 먼저 AE 사용 설명서의 메타데이터 관리 부분을 읽어 보는 것을 권장합니다: 데이터 관리-이벤트 및 속성

1. 이벤트 관리​

1. 가상 이벤트 조회​

인터페이스 URL

/open/get-virtual-event-by-name?token=xxx&projectId=377&eventName=ta@test222

요청 방식

GET

Content-Type

application/json

요청 Query 파라미터

파라미터 이름예시 값파라미터 타입필수 여부파라미터 설명
tokenxxxString예조회 키
projectId377Integer예프로젝트 ID
eventNameta@test222String예이벤트 이름

성공 응답 예시

{
"data": {
"eventDesc": "테스트 가상 이벤트",
"eventName": "ta@teset",
"remark": "",
"rule": {
"events": [
{
"eventDesc": "골드 획득",
"eventName": "obtain_coin",
"filter": {
"filterType": "COMPOUND",
"filts": [],
"relation": "and"
}
}
],
"filter": {
"filterType": "COMPOUND",
"filts": [],
"relation": "and"
}
}
},
"return_code": 0,
"return_message": "success"
}
$$파라미터 이름예시 값파라미터 타입파라미터 설명
data-Object반환 데이터
data.eventDesc테스트 가상 이벤트String이벤트 표시 이름
data.eventNameta@tesetString이벤트 이름
data.remark-String이벤트 비고
data.rule-Object가상 이벤트 규칙
data.rule.events-List이벤트 목록
data.rule.events.eventDesc골드 획득String이벤트 표시 이름
data.rule.events.eventNameobtain_coinString이벤트 이름
data.rule.events.filter-Object속성 필터
data.rule.events.filter.filterTypeCOMPOUNDString

필터:

  • COMPOUND: 복합 타입
  • SIMPLE: 단순 타입
data.rule.events.filter filts[]List필터 값 리스트
data.rule.events.filter relationandString필터 논리 관계
data.rule.filter-Object속성 필터
data.rule.filter.filterTypeCOMPOUNDString

필터:

  • COMPOUND: 복합 타입
  • SIMPLE: 단순 타입
data.rule.filter.filts[]List필터 값 리스트
data.rule.filter.relationandString필터 논리 관계
return_code0Integer반환 코드
return_messagesuccessString반환 정보

2. 이벤트 메타 정보 목록​

인터페이스 URL

/open/list-event-meta?token=xxx&projectId=377

요청 방식

GET

Content-Type

application/json

요청 Query 파라미터

파라미터 이름예시 값파라미터 타입필수 여부파라미터 설명
tokenxxxString예조회 키
projectId377Integer예프로젝트 ID

propName

-

String

아니요

속성 이름으로, 이 파라미터는 속성과 관련된 이벤트를 조회하는 데 사용됩니다. 전달하지 않으면 모든 물리적 이벤트와 가상 이벤트를 반환합니다

성공 응답 예시

{
"data": {
"events": [
{
"eventDesc": "이벤트 참여",
"eventName": "activity_attend",
"eventType": "event",
"isHide": false,
"remark": "이벤트 참여321"
}
]
},
"return_code": 0,
"return_message": "success"
}
$$파라미터 이름예시 값파라미터 타입파라미터 설명
data-Object반환 데이터
data.events-List이벤트 목록
data.events.eventDesc이벤트 참여String이벤트 설명
data.events.eventNameactivity_attendString이벤트 이름
data.events.eventTypeeventString

이벤트 타입

  • event: 물리적 이벤트
  • event_v: 가상 이벤트
data.events.isHidefalseBoolean숨김 여부
data.events.remark이벤트 참여321String이벤트 비고
return_code0Integer반환 코드
return_messagesuccessString반환 정보

3. 가상 이벤트 생성​

인터페이스 URL

/open/create-virtual-event?token=xxx&projectId=0&override=false

요청 방식

POST

Content-Type

application/json

요청 Query 파라미터

파라미터 이름예시 값파라미터 타입필수 여부파라미터 설명
tokenxxxString예조회 키
projectId0Integer예프로젝트 ID
overridefalseString예같은 이름의 가상 이벤트가 이미 있는 경우 override=false이면 오류가 발생하고, override=true이면 가상 이벤트 정의를 업데이트합니다.

요청 Body 파라미터

{
"eventName": "ta@test_vevent",
"eventDesc": "테스트 가상 이벤트",
"remark": "",
"rule": {
"events": [
{
"eventDesc": "이벤트 참여",
"eventName": "activity_attend",
"filter": {
"relation": "and",
"filts": [
{
"comparator": "equal",
"columnDesc": "네트워크 타입",
"columnName": "network",
"ftv": [
"4G"
],
"selectType": "string",
"tableType": "event"
}
]
}
}
]
}
}
$$파라미터 이름예시 값파라미터 타입필수 여부파라미터 설명
eventNameta@test_veventString예이벤트 이름
eventDesc테스트 가상 이벤트String아니요이벤트 표시 이름
remarkString아니요이벤트 비고
rule-Object예규칙
rule.events-List예이벤트 목록
rule.events.eventNameactivity_attendString예이벤트 이름
rule.events.eventDesc이벤트 참여String아니요이벤트 표시 이름
rule.events.filter-Object아니요속성 필터
rule.events.filter.filterTypeSIMPLEString아니요

필터

  • COMPOUND: 복합 타입
  • SIMPLE: 단순 타입
rule.events.filter.filts-List아니요필터 객체 리스트
rule.events.filter.filts.comparatorequalString아니요비교 타입
rule.events.filter.filts.columnDesc네트워크 타입String아니요필드 표시 이름
rule.events.filter.filts.columnNamenetworkString예필드 이름
rule.events.filter.filts.ftv["4G"]List아니요필터 값 리스트
rule.events.filter.filts.selectTypestringString아니요필터 값 선택 박스 타입
rule.events.filter.filts.tableTypeeventString아니요event: 이벤트 속성, user: 유저 속성
rule.events.filter.filts.filterTypeSIMPLEString아니요

필터:

  • COMPOUND: 복합 타입
  • SIMPLE: 단순 타입
rule.events.filter.relationandString아니요필터 논리 관계

성공 응답 예시

{
"return_code": 0,
"return_message": "success"
}
파라미터 이름예시 값파라미터 타입파라미터 설명
return_code0Integer반환 코드
return_messagesuccessString반환 정보

오류 응답 예시

{
"return_code": -1008,
"return_message": "eventName은 비워 둘 수 없습니다, rule은 null일 수 없습니다"
}
파라미터 이름예시 값파라미터 타입파라미터 설명
return_code-1008Integer반환 코드
return_messageeventName은 비워 둘 수 없습니다, rule은 null일 수 없습니다String반환 정보

4. 이벤트 표시 이름 및 비고 수정​

주의
  • 이벤트 표시 이름은 최대 60자이며, 초과한 부분은 자동으로 잘립니다
  • 이벤트 표시 이름에는 이모지를 포함할 수 없습니다
  • 가상 이벤트 표시 이름은 다른 가상 이벤트의 표시 이름 및 이벤트 이름과 중복될 수 없습니다
  • 물리적 이벤트 표시 이름은 다른 물리적 이벤트의 표시 이름 및 이벤트 이름과 중복될 수 없습니다

인터페이스 URL

/open/update-event-info?token=xxx&projectId=0

요청 방식

POST

Content-Type

application/json

요청 Query 파라미터

파라미터 이름예시 값파라미터 타입필수 여부파라미터 설명
tokenxxxString예조회 키
projectId0Integer예프로젝트 ID

요청 Body 파라미터

{
"eventName": "test007",
"eventDesc": "testDesc",
"eventRemark": "testRemark"
}
파라미터 이름예시 값파라미터 타입필수 여부파라미터 설명
eventNametestString예이벤트 이름
eventDesctestDescString예이벤트 표시 이름
eventRemarktestRemarkString아니요이벤트 비고

성공 응답 예시

{
"return_code": 0,
"return_message": "success"
}
파라미터 이름예시 값파라미터 타입파라미터 설명
return_code0Integer반환 코드
return_messagesuccessString반환 정보

오류 응답 예시

{
"return_code": -1008,
"return_message": "이벤트 test007이 숨겨졌거나 삭제되었습니다. 조건을 다시 설정하십시오"
}
파라미터 이름예시 값파라미터 타입파라미터 설명
return_code-1008Integer반환 코드
return_message이벤트 test007이 숨겨졌거나 삭제되었습니다. 조건을 다시 설정하십시오String반환 정보

5. 가상 이벤트 삭제​

인터페이스 URL

/open/delete-virtual-event-by-name?token=xxx&projectId=0&eventName=test

요청 방식

POST

Content-Type

application/json

요청 Query 파라미터

파라미터 이름예시 값파라미터 타입필수 여부파라미터 설명
tokenxxxString예조회 키
projectId0Integer예프로젝트 ID
eventNametestString예이벤트 이름

성공 응답 예시

{
"return_code": 0,
"return_message": "success"
}
파라미터 이름예시 값파라미터 타입파라미터 설명
return_code0Integer반환 코드
return_messagesuccessString반환 정보

오류 응답 예시

{
"return_code": -1008,
"return_message": "이벤트 test가 숨겨졌거나 삭제되었습니다. 조건을 다시 설정하십시오"
}
파라미터 이름예시 값파라미터 타입파라미터 설명
return_code-1008String반환 코드
return_message이벤트 test가 숨겨졌거나 삭제되었습니다. 조건을 다시 설정하십시오String반환 정보

2. 속성 관리​

1. 가상 속성 조회​

인터페이스 URL

/open/get-sql-prop-by-name?token=xxx&projectId=0&propName=%23vp@location&tableType=event

요청 방식

GET

Content-Type

application/json

요청 Query 파라미터

파라미터 이름예시 값파라미터 타입필수 여부파라미터 설명
tokenxxxString예조회 키
projectId0Integer예프로젝트 ID
propName#vp@locationString예속성 이름
tableTypeeventString예event: 이벤트 속성, user: 유저 속성

성공 응답 예시

{
"data": {
"relatedEvents": [
{
"eventName": "이벤트 이름",
"eventDesc": "이벤트 표시 이름"
}
],
"sqlEventRelationType": "relation_default",
"sqlExpression": "concat(\"#country\",'-',\"#province\",'-',\"#city\")",
"vProp": {
"property": {
"columnDesc": "지리적 위치 정보",
"columnName": "#vp@location",
"selectType": "string",
"tableType": "event"
}
}
},
"return_code": 0,
"return_message": "success"
}
$$파라미터 이름예시 값파라미터 타입파라미터 설명
data-Object반환 데이터
data.relatedEvents-List연관 이벤트 목록
data.relatedEvents.eventName이벤트 이름String이벤트 이름
data.relatedEvents.eventDesc이벤트 표시 이름String이벤트 표시 이름
data.sqlEventRelationTyperelation_defaultString
  • relation_default: 연관 이벤트 자동 해석
  • relation_always: 모든 이벤트가 연관 이벤트
  • relation_by_setting: 연관 이벤트는 relatedEvents에 있음
data.sqlExpressionconcat("#country",'-',"#province",'-',"#city")StringSQL 표현식
data.vProp-Object가상 속성 목록
data.vProp.property-Object가상 속성
data.vProp.property.columnDesc지리적 위치 정보String필드 표시 이름
data.vProp.property.columnName#vp@locationString필드 이름
data.vProp.property.selectTypestringString필터 값 선택 박스 타입
data.vProp.property.tableTypeeventString

속성 타입

  • event: 이벤트 속성
  • user: 유저 속성
return_code0Integer반환 코드
return_messagesuccessString반환 정보

오류 응답 예시

{
"return_code": -1008,
"return_message": "유저 속성 test007이 숨겨졌거나 삭제되었습니다. 조건을 다시 설정하십시오"
}
파라미터 이름예시 값파라미터 타입파라미터 설명
return_code-1008Integer반환 코드
return_message유저 속성 test007이 숨겨졌거나 삭제되었습니다. 조건을 다시 설정하십시오String반환 정보

2. 속성 목록​

인터페이스 URL

/open/list-props?token=xxx&projectId=0&tableType=event&eventName=xxx

요청 방식

GET

Content-Type

application/json

요청 Query 파라미터

파라미터 이름예시 값파라미터 타입필수 여부파라미터 설명
tokenxxxString예조회 키
projectId0Integer예프로젝트 ID
tableTypeeventString예

속성 타입

  • event: 이벤트 속성
  • user: 유저 속성
eventName-String아니요tableType이 event일 때 유효합니다. 물리적 이벤트 또는 가상 이벤트의 이름으로, 이 파라미터는 이벤트와 관련된 속성을 조회하는 데 사용됩니다. 전달하지 않으면 모든 물리적 속성과 가상 속성을 반환합니다

성공 응답 예시

{
"data": {
"properties": [
{
"canCreateDict": true,
"columnDesc": "이벤트 항목def:123123123123123123",
"columnName": "activity_item_operation",
"columnRemark": "",
"dictProps": [
{
"canCreateDict": false,
"columnDesc": "",
"columnName": "activity_item_operation@channel_name",
"columnRemark": "",
"isHide": false,
"propType": "vprop_dict",
"selectType": "string",
"tableType": "event"
}
],
"isHide": false,
"propType": "prop_unpreset",
"selectType": "string",
"tableType": "event"
}
]
},
"return_code": 0,
"return_message": "success"
}
$$파라미터 이름예시 값파라미터 타입파라미터 설명
data-Object반환 데이터
data.properties-List
data.properties.canCreateDicttrueBoolean차원 테이블 생성 가능 여부
data.properties.columnDesc이벤트 항목def:123123123123123123String필드 표시 이름
data.properties.columnNameactivity_item_operationString필드 이름
data.properties.columnRemark-String필드 설명
data.properties.dictProps-List연관 차원 필드
data.properties.dictProps.canCreateDictfalseString차원 테이블 생성 가능 여부
data.properties.dictProps.columnDesc-String필드 표시 이름
data.properties.dictProps.columnNameactivity_item_operation@channel_nameString필드 이름
data.properties.dictProps.columnRemark-String필드 설명
data.properties.dictProps.isHidefalseBoolean숨김 여부
data.properties.dictProps.propTypevprop_dictString속성 타입
data.properties.dictProps.selectTypestringString필터 값 선택 박스 타입
data.properties.dictProps.tableTypeeventString필드가 속한 테이블 타입
data.properties.isHidefalseBoolean숨김 여부
data.properties.propTypeprop_unpresetString

속성 타입

  • prop_preset: 프리셋 물리적 속성
  • prop_unpreset: 커스텀 물리적 속성
  • vprop_dict: 물리적 속성 기반 차원 테이블 속성
  • vprop_sql: 물리적 속성 기반 가상 속성
  • vprop_dict_v: 가상 속성 기반 차원 테이블 속성
  • vprop_sql_v: 차원 테이블 속성 기반 가상 속성
data.properties.selectTypestringString필터 값 선택 박스 타입
data.properties.tableTypeeventString필드가 속한 테이블 타입
return_code0Integer반환 코드
return_messagesuccessString반환 정보

3. 속성 표시 이름 수정​

주의
  1. 속성 표시 이름은 최대 60자이며, 초과한 부분은 자동으로 잘립니다. 이모지를 포함할 수 없으며, 가상 속성은 다른 가상 속성의 표시 이름 및 속성 이름과 중복될 수 없고, 물리적 속성은 다른 물리적 속성의 표시 이름 및 속성 이름과 중복될 수 없습니다
  2. 속성 설명은 최대 200자이며, 초과한 부분은 자동으로 잘립니다
  3. 같은 이름의 가상 속성이 이미 있으면 가상 속성 정의를 업데이트합니다

인터페이스 URL

/open/update-prop-info?token=xxx&projectId=0

요청 방식

POST

Content-Type

application/json

요청 Query 파라미터

파라미터 이름예시 값파라미터 타입필수 여부파라미터 설명
tokenxxxString예조회 키
projectId0Integer예프로젝트 ID

요청 Body 파라미터

{
"columnName": "test",
"columnDesc": "testDesc",
"columnRemark": "testRemark",
"tableType": "event"
}
파라미터 이름예시 값파라미터 타입필수 여부파라미터 설명
columnNametestString예필드 이름
columnDesctestDescString예필드 표시 이름
columnRemarktestRemarkString아니요필드 설명
tableTypetestTypeString예

속성 타입

  • event: 이벤트 속성
  • user: 유저 속성

성공 응답 예시

{
"return_code": 0,
"return_message": "success"
}
파라미터 이름예시 값파라미터 타입파라미터 설명
return_code0Integer반환 코드
return_messagesuccessString반환 정보

오류 응답 예시

{
"return_code": -1023,
"return_message": "event property(test)가 존재하지 않습니다"
}
파라미터 이름예시 값파라미터 타입파라미터 설명
return_code-1023Integer반환 코드
return_messageevent property(test)가 존재하지 않습니다String반환 정보

4. 차원 사전 검증 및 생성​

주의

파일 업로드 방식으로 차원 사전을 생성하며, 파일 크기 제한은 200M입니다

인터페이스 URL

/open/dict-create?token=xxx&projectId=0&createParam=test

요청 방식

POST

Content-Type

text/csv

요청 Query 파라미터

파라미터 이름예시 값파라미터 타입필수 여부파라미터 설명
tokenxxxString예조회 키
projectId0Integer예프로젝트 ID
createParamtestString예-

성공 응답 예시

{
"data": {
"totalLineNum": 4,
"successLineNum": 1,
"duplcatedMainKeyLineNum": 1,
"duplcatedMainKeyColumns": ["city@test"],
"mainKeyErrorLineNum": 1,
"mainKeyErrorColumns": ["brand@quantity"],
"typeErrorLineNum": 1,
"typeErrorColumns": ["iswin@num"],
"repeatWithConlumnName": [{
"columnName": "channel@channel_name",
"columnDesc": "채널 타입"
}],
"repeatWithConlumnDesc": [{
"columnName": "channel@channel_name",
"columnDesc": "채널 타입"
}]
},
"return_code": 0,
"return_message": "success"
}
$$파라미터 이름예시 값파라미터 타입파라미터 설명
return_code0String반환 코드
return_messagesuccessString반환 정보
data-Object반환 데이터
data.totalLineNum4Integer해석한 총 행 수
data.successLineNum1Integer가져오기에 성공한 행 수
data.duplcatedMainKeyLineNum1Integer기본 키가 중복된 행 수
data.duplcatedMainKeyColumns["city@test"]List기본 키가 중복된 행 목록
data.mainKeyErrorLineNum1Integer기본 키 타입이 잘못된 행 수
data.mainKeyErrorColumns["brand@quantity"]List기본 키 타입이 잘못된 행 목록
data.typeErrorLineNum1Integer다른 열에 타입 오류가 있는 행 수
data.typeErrorColumns["iswin@num"]List다른 열에 타입 오류가 있는 행 목록
data.repeatWithConlumnName-List표시 이름이 속성 이름과 중복된 목록
data.repeatWithConlumnName.columnNamechannel@channel_nameString속성 필드 이름
data.repeatWithConlumnName.columnDesc채널 타입String속성 표시 이름
data.repeatWithConlumnDesc-List표시 이름이 다른 표시 이름과 중복된 목록
data.repeatWithConlumnDesc.columnNamechannel@channel_nameString속성 필드 이름
data.repeatWithConlumnDesc.columnDesc채널 타입String속성 표시 이름

오류 응답 예시

{
"return_code": -3004,
"return_message": "유효하지 않은 프로젝트"
}
파라미터 이름예시 값파라미터 타입파라미터 설명
return_code-3004String반환 코드
return_message유효하지 않은 프로젝트String반환 정보

5. 가상 속성 생성​

주의

같은 이름의 가상 속성이 이미 있으면 가상 속성 정의를 업데이트합니다

인터페이스 URL

/open/create-sql-prop?token=xxx&projectId=110

요청 방식

POST

Content-Type

application/json

요청 Query 파라미터

파라미터 이름예시 값파라미터 타입필수 여부파라미터 설명
tokenxxxString예조회 키
projectId110Integer예프로젝트 ID

요청 Body 파라미터

{
"sqlExpression": "get_ip_location(\"#ip\")",
"vProp" : {
"property" : {
"columnDesc": "IP 주소로 해석한 지리적 위치 정보",
"columnName": "#vp@location_array_from_ip",
"tableType": "event",
"selectType":"array"
}
},
"sqlEventRelationType" : "relation_default"
}
$$파라미터 이름예시 값파라미터 타입필수 여부파라미터 설명
sqlExpressionget_ip_location(\"#ip\")String예SQL 표현식
vProp-Object예가상 속성 정보
vProp.property-Object예가상 속성 정보

vProp.property.columnDesc

IP 주소로 해석한 지리적 위치 정보

String

아니요필드 이름
vProp.property.columnName#vp@location_array_from_ipString예

필드 표시 이름

vProp.property.tableTypeeventString예

테이블 타입

  • event: 이벤트 속성
  • user: 유저 속성
vProp.property.selectTypearrayString예필터 값 선택 박스 타입
sqlEventRelationTyperelation_defaultString아니요

해석 타입, 기본값 relation_default

  • relation_default: 연관 이벤트 자동 해석
  • relation_always: 모든 이벤트가 연관 이벤트
  • relation_by_setting: 연관 이벤트는 relatedEvents에 있음

성공 응답 예시

{
"return_code": 0,
"return_message": "success"
}
파라미터 이름예시 값파라미터 타입파라미터 설명
return_code0String반환 코드
return_messagesuccessString반환 정보

오류 응답 예시

{
"return_code": -3004,
"return_message": "유효하지 않은 프로젝트"
}
파라미터 이름예시 값파라미터 타입파라미터 설명
return_code-3004String반환 코드
return_message유효하지 않은 프로젝트String반환 정보

6. 차원 속성 삭제​

인터페이스 URL

/open/delete-dict-props?token=xxx&projectId=0&tableType=event&mainColumnName=test

요청 방식

POST

Content-Type

application/json

요청 Query 파라미터

파라미터 이름예시 값파라미터 타입필수 여부파라미터 설명
tokenxxxString예조회 키
projectId0Integer예프로젝트 ID
tableTypeeventString예

속성 타입

  • event: 이벤트 속성
  • user: 유저 속성
mainColumnNametestString예차원 테이블이 연관된 주 속성 이름

성공 응답 예시

{
"return_code": 0,
"return_message": "success"
}
파라미터 이름예시 값파라미터 타입파라미터 설명
return_code0Integer반환 코드
return_messagesuccessString반환 정보

오류 응답 예시

{
"return_code": -1008,
"return_message": "이벤트 속성 test가 숨겨졌거나 삭제되었습니다. 조건을 다시 설정하십시오"
}
파라미터 이름예시 값파라미터 타입파라미터 설명
return_code-1008Integer반환 코드
return_message이벤트 속성 test가 숨겨졌거나 삭제되었습니다. 조건을 다시 설정하십시오String반환 정보

7. SQL 가상 속성 삭제​

인터페이스 URL

/open/delete-sql-prop-by-name?token=xxx&projectId=0&tableType=event&propName=test

요청 방식

POST

Content-Type

application/json

요청 Query 파라미터

파라미터 이름예시 값파라미터 타입필수 여부파라미터 설명
tokenxxxString예조회 키
projectId0Integer예프로젝트 ID
tableTypeeventString예

속성 타입

  • event: 이벤트
  • user: 유저
propNametestString예속성 이름

성공 응답 예시

{
"return_code": 0,
"return_message": "success"
}
파라미터 이름예시 값파라미터 타입파라미터 설명
return_code0Integer반환 코드
return_messagesuccessString반환 정보

오류 응답 예시

{
"return_code": -1023,
"return_message": "virtual event prop test가 존재하지 않습니다"
}
파라미터 이름예시 값파라미터 타입파라미터 설명
return_code-1023Integer반환 코드
return_messagevirtual event prop test가 존재하지 않습니다String반환 정보

이 문서가 도움이 되었나요?