Skip to content

식별자로 사용자 프로필 내보내기

post

/users/export/ids

이 엔드포인트를 사용하여 사용자 식별자를 지정하여 모든 사용자 프로필에서 데이터를 내보낼 수 있습니다.

하나의 요청에 최대 50개의 external_ids 또는 user_aliases 을 포함할 수 있습니다. device_id, email_address 또는 phone를 지정하려는 경우 요청당 식별자 중 하나만 포함할 수 있습니다.

필수 구성 요소

이 엔드포인트를 사용하려면 users.export.ids 권한이 있는 API 키가 필요합니다.

사용량 제한

2024년 8월 22일 이후에 Braze를 온보딩한 경우, 이 엔드포인트는 API 속도 제한에 설명된 대로 분당 250건의 요청으로 속도 제한이 적용됩니다.

요청 본문

요청 매개변수

매개변수 필수 데이터 유형 설명
external_ids 선택 사항 문자열 배열 내보내려는 사용자의 외부 식별자입니다.
user_aliases 선택 사항 사용자 별칭 객체 배열 사용자가 내보낼 사용자 별칭입니다.
device_id 선택 사항 문자열 장치 식별자(예: getDeviceId 와 같은 다양한 SDK 메서드에서 반환되는 장치 식별자).
braze_id 선택 사항 문자열 특정 사용자의 브레이즈 식별자.
email_address 선택 사항 문자열 사용자의 이메일 주소입니다.
phone 선택 사항 문자열의 E.164 형식 사용자의 전화번호입니다.
fields_to_export 필수 문자열 배열 내보낼 사용자 데이터 필드의 이름입니다.

요청 예시

내보낼 필드

다음은 유효한 fields_to_export 목록입니다. fields_to_export를 사용하여 반환되는 데이터를 최소화하면 이 API 엔드포인트의 응답 시간을 개선할 수 있습니다.

내보낼 필드 데이터 유형 설명
apps 배열 이 사용자가 세션에 로그인한 앱(필드 포함)입니다:

- name: 앱 이름
- platform: iOS, Android 또는 웹과 같은 앱 플랫폼
- version: 앱 버전 번호 또는 이름
- sessions: 이 앱의 총 세션 수
- first_used: 첫 세션 날짜
- last_used: 마지막 세션 날짜

모든 필드는 문자열입니다.
attributed_campaign 문자열 어트리뷰션 통합의 데이터(설정된 경우). 특정 광고 캠페인의 식별자입니다.
attributed_source 문자열 어트리뷰션 통합의 데이터(설정된 경우). 광고가 게재된 플랫폼의 식별자입니다.
attributed_adgroup 문자열 어트리뷰션 통합의 데이터(설정된 경우). 캠페인 아래의 선택적 하위 그룹을 위한 식별자입니다.
attributed_ad 문자열 어트리뷰션 통합의 데이터(설정된 경우). 캠페인 및 광고 그룹 아래의 선택적 하위 그룹에 대한 식별자입니다.
push_subscribe 문자열 사용자의 푸시 구독 상태.
email_subscribe 문자열 사용자의 이메일 구독 상태.
braze_id 문자열 이 사용자에 대해 Braze가 설정한 기기별 고유 사용자 식별자입니다.
country 문자열 ISO 3166-1 알파-2 표준을 사용하는 사용자의 국가.
created_at 문자열 사용자 프로필이 생성된 날짜와 시간(ISO 8601 형식)입니다.
custom_attributes 객체 이 사용자에 대한 사용자 지정 속성 키-값 쌍입니다.
custom_events 배열 지난 90일 동안 이 사용자에 의해 발생한 사용자 지정 이벤트입니다.
devices 배열 플랫폼에 따라 다음을 포함할 수 있는 사용자 디바이스에 대한 정보입니다:

- model: 디바이스 모델명
- os: 디바이스의 운영 체제
- carrier: 디바이스의 서비스 통신사(가능한 경우)
- idfv: (iOS) Braze 장치 식별자, 공급업체용 Apple 식별자(있는 경우)
- idfa: (iOS) 광고용 식별자(있는 경우)
- device_id: (Android) Braze 디바이스 식별자
- google_ad_id: (Android) Google Play 광고 식별자(있는 경우)
- roku_ad_id: (로쿠) 로쿠 광고 식별자
- ad_tracking_enabled: 기기에서 광고 추적이 활성화된 경우 참 또는 거짓일 수 있습니다.
dob 문자열 사용자의 생년월일 형식 YYYY-MM-DD.
email 문자열 사용자의 이메일 주소.
external_id 문자열 식별된 사용자를 위한 고유 사용자 식별자입니다.
first_name 문자열 사용자의 이름입니다.
gender 문자열 사용자의 성별. 가능한 값은 다음과 같습니다:

- M: 남성
- F: 여성
- O: 기타
- N: 해당 없음
- P: 말하지 않는 것을 선호합니다.
- nil: 알 수 없음
home_city 문자열 사용자의 거주 도시.
language 문자열 ISO-639-1 표준의 사용자 언어.
last_coordinates 플로트 배열 사용자의 가장 최근 디바이스 위치, 형식은 [longitude, latitude] 입니다.
last_name 문자열 사용자의 성입니다.
phone 문자열 E.164 형식의 사용자 전화번호.
purchases 배열 이 사용자가 지난 90일 동안 구매한 구매 건수입니다.
push_tokens 배열 앱의 알림을 보낼 위치를 지정하는 고유 익명 식별자입니다.
random_bucket 정수 무작위 사용자 세그먼트를 균일하게 분산시키는 데 사용되는 사용자의 무작위 버킷 번호입니다.
time_zone 문자열 사용자의 표준 시간대를 IANA 표준 시간대 데이터베이스와 동일한 형식으로 입력합니다.
total_revenue Float 이 사용자에게 귀속된 총 수익입니다. 총 수익은 사용자가 받은 캠페인 및 캔버스에 대한 전환 기간 동안 구매한 금액을 기준으로 계산됩니다.
uninstalled_at 타임스탬프 사용자가 앱을 삭제한 날짜와 시간입니다. 앱이 제거되지 않은 경우 생략됩니다.
user_aliases 객체 alias_namealias_label 을 포함하는 사용자 별칭 개체가 있는 경우.

/users/export/ids 엔드포인트는 모든 캠페인 및 캔버스 수신, 모든 사용자 지정 이벤트 수행, 모든 구매, 모든 사용자 지정 속성 등의 데이터를 포함하여 이 사용자에 대한 전체 사용자 프로필을 가져온다는 점에 유의하세요. 결과적으로 이 엔드포인트는 다른 REST API 엔드포인트보다 속도가 느립니다.

요청되는 데이터에 따라 분당 250건의 요청 속도 제한으로 인해 이 API 엔드포인트가 사용자의 요구 사항을 충족하기에 충분하지 않을 수 있습니다. 이 엔드포인트를 정기적으로 사용하여 사용자를 내보낼 예정이라면, 대신 비동기식이며 대규모 데이터 가져오기에 더 최적화된 세그먼트별로 사용자를 내보내는 것을 고려하세요.

응답

이 엔드포인트를 통해 액세스할 수 있는 데이터의 예는 다음 예시를 참조하세요.

사용자 내보내기 파일 출력 예시

사용자 내보내기 개체(가능한 최소한의 데이터만 포함 - 개체에서 필드가 누락된 경우 null 또는 비어있는 것으로 가정해야 함):

이 페이지가 얼마나 도움이 되었나요?
New Stuff!