POST: 유저 프로필 추출

POST api/v1/export/userprofile

적재되어있는 유저 프로필을 추출할 수 있는 API 입니다.

쿼리 파라미터

이름	필수값 여부	타입	설명
service_id	필수	String	서비스 ID

헤더

필드명	필수값 여부	타입	값	설명
Content-Type	필수	String	application/json	-
Authorization	필수	String	Bearer your-auth-token	API 인증 토큰

요청 본문

현재 식별 속성에 대한 추출은 외부ID(df_external_id) 만 지원합니다. identities_condition_type 의 값이 all 이더라도, 외부ID (df_external_id) 만 추출됩니다.

필드명	필수값 여부	타입	설명
properties	선택	List of String	필터링 대상 유저 속성명 리스트, 값이 존재하지 않을 경우 모든 유저 속성 추출
properties_condition_type	필수	String	필터링 연산자, 아래 값을 지원합니다. all : 전체 유저 속성, include : properties의 유저 속성만 포함, exclude : properties의 유저 속성 제외
identities	선택	List of String	필터링 대상 식별 속성명 리스트, 값이 존재하지 않을 경우 모든 식별 속성 추출
identities_condition_type	선택	String	필터링 연산자, 아래 값을 지원합니다. 기본값은 include입니다. all : 전체 식별 속성, include : identities의 식별 속성만 포함, exclude : identities의 식별 속성 제외
audience	선택	String	추출하고자 하는 유저가 포함된 오디언스ID, 값이 존재하지 않을 경우 모든 유저에 대해 추출

응답

유저 프로필 추출의 응답은 , 로 구분되는 헤더가 포함된 csv 포맷입니다. 첫번째 줄이 헤더이고, 두번째 줄부터 추출된 데이터입니다. 아래의 표는 주요 헤더에 대한 설명입니다.

통합ID의 경우 properties, properties_condition_type, identities, identities_condition_type 에 상관없이 응답에 항상 포함됩니다.

유저 프로필 속성에 대한 자세한 내용은 표준 유저 프로필 속성 목록 을 참고하시면 됩니다.

현재 식별 속성에 대한 추출은 외부ID(df_external_id) 만 지원합니다. identities_condition_type 의 값이 all 이더라도, 외부ID (df_external_id) 만 추출됩니다.

필드명	구분	설명
df_unified_id	통합ID	통합ID
${your-identity-property-key}	식별 속성	식별 속성
${your-standard-user-property-key}	표준 유저 프로필 속성	표준 유저 프로필 속성, Datetime 타입의 경우 서비스 타임존 기준
${your-custom-user-property-key}	커스텀 유저 프로필 속성	커스텀유저 프로필 속성, Datetime 타입의 경우 서비스 타임존 기준

요청 예시

curl -L \
  -X POST \
  -H 'Authorization: Bearer ${your-export-api-token}' \
  -H 'Content-Type: application/json' \
  'https://openapi.dfinery.ai/api/v1/export/userprofile?service_id=${your-service-id}' \
  -d '{
    "audience": "nwh3nu",
    "properties_condition_type": "exclude",
    "properties": [
        "df_birth"
    ],
    "identities": ["df_external_id"],
    "identities_condition_type": "include"
}'

응답 예시

성공 응답

custom_user_datetime,df_gender,df_kakao_ads_optin,df_membership,df_push_ads_optin,df_push_night_ads_optin,df_push_optin,df_sms_ads_optin,df_unified_id,scenario_list_string
,Male,false,,true,false,true,false,ZCUyK5F,"[""1"",""2""]"
,,false,,false,false,false,false,xrx4ib2,null
,,false,,false,false,true,false,BWCExSV,null
,,false,,false,false,false,false,uZFjOE3,null

실패 응답

자세한 내용은 상세 응답 참고하시면 됩니다.