Custom Attributes 생성
- 인쇄
- PDF
Custom Attributes 생성
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
Classic/VPC 환경에서 이용 가능합니다.
Custom Attributes의 Profile을 생성합니다.
사용자가 Custom Attributes 생성을 요청하면 NCLUE 시스템은 요청 작업을 등록하고 Profile ID를 반환합니다. 생성 과정은 다음과 같습니다.
생성 과정
| 순서 | 생성 상태 | 설명 |
|---|---|---|
| Step 1 | 등록됨 registered | 생성 작업이 시스템에 등록된 상태. 작업 시작 전 상태로 이 때는 삭제하여 작업 취소 가능 |
| Step 2 | 대기 중 pending | 생성 작업이 시스템 대기열에 올라간 상태 |
| Step 3 | 생성 중 in_progress | 작업이 서버에서 실행되는 상태. 서비스 가용 자원 상황에 따라 생성 시간은 상이함 |
| Step 4 | 생성 완료
| 생성이 완료되면, 성공했을 때 '사용 가능' 상태가 되어 정상적으로 사용 가능. 만약 작업에 오류가 발생한 경우, '실패' 상태가 되고, 오류 메시지를 참고하여 문제 해결 가능 |
Custom Attributes 생성은 서비스 가용 자원 상황에 따라 작업 시간에 차이가 있습니다. 생성 진행 단계는 Custom Attributes 조회 API를 호출하여 응답 바디의 'status'필드를 확인해 주십시오.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
| 메서드 | URI |
|---|---|
| POST | /api/v1/profile/custom-attributes |
요청 헤더
NCLUE API에서 공통으로 사용하는 헤더 정보는 NCLUE 공통 헤더를 참조해 주십시오.
요청 바디
요청 바디에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
name | String | Required | Profile 이름 (40자 제한) |
feature_id | String | Required | 프로파일링할 Feature ID |
keyword_set | String | Required | 사용자가 입력한 속성 키워드 목록 (대상 사용자와 유사도를 확인할 키워드)
|
result_bucket | String | Required | Custom Attributes 작업 결과를 저장할 Object Storage 버킷명 |
result_file_path | String | Required | result_bucket 버킷 내 결과를 저장할 파일 경로
|
요청 예시
요청 예시는 다음과 같습니다.
curl --location --request POST 'https://nclue.apigw.ntruss.com/api/v1/profile/custom-attributes' \
--header 'X-NCP-APIGW-TIMESTAMP: {Timestamp}' \
--header 'X-NCP-IAM-ACCESS-KEY: {Access Key}' \
--header 'X-NCP-APIGW-SIGNATURE-V2: {API Gateway Signature}'
--data '{
"name":"러닝/달리기 프로파일링",
"feature_id":"79eb85b5-8ec5-4e1a-8617-64a1977c8062",
"keyword_set":"러닝\n달리기\n마라톤\n조깅\n러닝화\n러닝양말\n러닝앱\n런닝",
"result_bucket":"your.bucket.name",
"result_file_path":"running_profiling"
}'
응답
응답 형식을 설명합니다.
응답 바디
응답 바디에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
profile_id | String | - | Profile ID |
profile_name | String | - | 사용자가 입력한 Custom Attributes의 Profile 이름 |
feature_id | String | - | 프로파일링할 Feature ID |
feature_name | String | - | 프로파일링할 Feature 이름 |
keyword_set | String | - | 사용자가 입력한 속성 키워드 목록 (대상 사용자와 유사도를 확인할 키워드) |
created_at | String | - | Custom Attributes 생성 요청 날짜 (ISO 8601 형식) |
result_bucket | String | - | Custom Attributes 작업 결과를 저장할 Object Storage 버킷명 |
result_file_path | String | - | result_bucket 버킷 내 결과를 저장할 파일 경로 |
응답 예시
응답 예시는 다음과 같습니다.
성공
호출이 성공한 경우의 응답 예시는 다음과 같습니다.
{
"profile_id":"efc3f714-d267-44e2-a574-75497cc7712c",
"profile_name":"러닝/달리기 프로파일링",
"feature_id":"79eb85b5-8ec5-4e1a-8617-64a1977c8062",
"feature_name":"쇼핑 행동시퀀스 - 2024년",
"keyword_set":"러닝,달리기,마라톤,조깅,러닝화,러닝양말,러닝앱,런닝",
"created_at":"2024-11-05T11:42:53",
"result_bucket":"your.bucket.name",
"result_file_path":"running_profiling"
}
실패
호출이 실패한 경우의 응답 예시는 응답 상태 코드를 참고해 주십시오.
이 문서가 도움이 되었습니까?