글로벌 제어 그룹별로 사용자 프로필 내보내기
/users/export/global_control_group
이 엔드포인트를 사용하여 글로벌 컨트롤 그룹 내의 모든 사용자를 내보낼 수 있습니다.
사용자 데이터는 줄 바꿈으로 구분된 열러 사용자 JSON 객체 파일로 내보내집니다(예: 한 줄에 하나의 JSON 객체). 파일이 생성될 때마다 글로벌 제어 그룹의 모든 사용자가 포함됩니다. Braze는 사용자가 글로벌 컨트롤 그룹에서 추가 및 제거된 시점에 대한 기록을 저장하지 않습니다.
필수 구성 요소
이 엔드포인트를 사용하려면 users.export.global_control_group
권한이 있는 API 키가 필요합니다.
사용량 제한
자격 증명 기반 응답 세부 정보
Braze에 S3 또는 Azure 자격 증명을 추가한 경우, 각 파일은 버킷에 segment-export/SEGMENT_ID/YYYY-MM-dd/RANDOM_UUID-TIMESTAMP_WHEN_EXPORT_STARTED/filename.zip
과 같은 키 형식의 ZIP 파일로 업로드됩니다. Azure를 사용하는 경우, Braze의 Azure 파트너 개요 페이지에서 기본 데이터 내보내기 대상으로 설정 확인란이 선택되어 있는지 확인하세요. 일반적으로 처리를 최적화하기 위해 사용자 5,000명당 1개의 파일을 생성합니다. 워크스페이스큰 내에서 더 작은 세그먼트를 내보내면 파일이 여러 개 생성될 수 있습니다. 그런 다음 파일을 추출하고 필요한 경우 모든 json
파일을 단일 파일로 연결할 수 있습니다. gzip
의 output_format
을 지정하면 파일 확장자가 .zip
대신 .gz
가 됩니다.
ZIP에 대한 내보내기 경로 분석
ZIP 형식:
bucket-name/segment-export/SEGMENT_ID/YYYY-MM-dd/RANDOM_UUID-TIMESTAMP_WHEN_EXPORT_STARTED/filename.zip
ZIP 예:
braze.docs.bucket/segment-export/abc56c0c-rd4a-pb0a-870pdf4db07q/2019-04-25/d9696570-dfb7-45ae-baa2-25e302r2da27-1556044807/114f0226319130e1a4770f2602b5639a.zip
등록정보 | 세부 정보 | 예제에서는 다음과 같이 표시됩니다. |
---|---|---|
bucket-name |
버킷 이름에 따라 수정되었습니다. | braze.docs.bucket |
segment-export |
수정되었습니다. | segment-export |
SEGMENT_ID |
내보내기 요청에 포함됩니다. | abc56c0c-rd4a-pb0a-870pdf4db07q |
YYYY-MM-dd |
성공적인 콜백이 수신된 날짜입니다. | 2019-04-25 |
RANDOM_UUID |
요청 시점에 Braze에서 생성한 임의의 UUID입니다. | d9696570-dfb7-45ae-baa2-25e302r2da27 |
TIMESTAMP_WHEN_EXPORT_STARTED |
내보내기가 요청된 유닉스 시간(UTC 기준 2017-01-01:00:00:00Z 이후 초)입니다. | 1556044807 |
filename |
파일당 무작위입니다. | 114f0226319130e1a4770f2602b5639a |
이 엔드포인트를 사용하여 내보내기에 대한 자체 버킷 정책을 적용하려면 자체 S3 또는 Azure 자격 증명을 설정할 것을 강력히 권장합니다. 클라우드 스토리지 자격 증명을 제공하지 않은 경우 요청에 대한 응답으로 모든 사용자 파일이 포함된 ZIP 파일을 다운로드할 수 있는 URL이 제공됩니다. URL은 내보내기가 준비된 후에만 유효한 위치가 됩니다.
클라우드 스토리지 자격 증명을 제공하지 않으면 이 엔드포인트에서 내보낼 수 있는 데이터의 양에 제한이 있다는 점에 유의하세요. 내보내는 필드와 사용자 수에 따라 파일 크기가 너무 크면 파일 전송에 실패할 수 있습니다. 가장 좋은 방법은 fields_to_export
를 사용하여 내보낼 필드를 지정하고 전송 크기를 낮추기 위해 필요한 필드만 지정하는 것입니다. 파일 생성 시 오류가 발생하면 무작위 버킷 번호를 기준으로 사용자 기반을 더 많은 세그먼트로 나누는 것을 고려해 보세요(예: 무작위 버킷 번호가 1,000 미만 또는 1,000~2,000 사이인 세그먼트 생성).
두 시나리오 모두 내보내기가 준비되면 선택 사항으로 알림을 받으려면 callback_endpoint
를 제공할 수 있습니다. callback_endpoint
가 제공되면 다운로드가 준비되었을 때 제공된 주소로 게시 요청을 보냅니다. 게시물의 본문은 “성공”:true입니다. Braze에 클라우드 스토리지 자격 증명을 추가하지 않은 경우, 글 본문에 다운로드 URL이 값으로 포함된 url
속성이 추가로 표시됩니다.
사용자 기반이 클수록 내보내기 시간이 길어집니다. 예를 들어 사용자가 2,000만 명인 앱은 한 시간 이상 걸릴 수 있습니다.
요청 본문
1
2
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
1
2
3
4
5
{
"callback_endpoint" : (optional, string) endpoint to post a download URL to when the export is available,
"fields_to_export" : (required, array of string) name of user data fields to export, for example, ['first_name', 'email', 'purchases'],
"output_format" : (optional, string) When using your own S3 bucket, allows to specify file format as 'zip' or 'gzip'. Defaults to zip file format
}
개별 사용자 지정 속성은 내보낼 수 없습니다. 그러나 모든 커스텀 속성은 fields_to_export 배열에 custom_attributes를 포함시켜 내보낼 수 있습니다(예: ['first_name', 'email', 'custom_attributes']
).
요청 매개변수
매개변수 | 필수 | 데이터 유형 | 설명 |
---|---|---|---|
callback_endpoint |
선택 사항 | 문자열 | 내보내기를 사용할 수 있을 때 다운로드 URL을 게시할 엔드포인트를 설정합니다. |
fields_to_export |
필수* | 문자열 배열 | 내보낼 사용자 데이터 필드의 이름, 사용자 지정 속성을 내보낼 수도 있습니다. *2021년 4월부터 신규 계정은 내보낼 특정 필드를 지정해야 합니다. |
output_format |
선택 사항 | 문자열 | 자체 S3 버킷을 사용하는 경우 파일 형식을 zip 또는 gzip 으로 지정할 수 있습니다. 기본값은 ZIP 파일 형식입니다. |
요청 예시
1
2
3
4
5
6
7
8
curl --location --request POST 'https://rest.iad-01.braze.com/users/export/global_control_group' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
"callback_endpoint" : "",
"fields_to_export" : ["email", "braze_id"],
"output_format" : "zip"
}'
내보낼 필드
다음은 유효한 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 |
문자열 | 어트리뷰션 통합의 데이터(설정된 경우). 캠페인 및 광고 그룹 아래의 선택적 하위 그룹에 대한 식별자입니다. |
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 : (Roku) Roku 광고 식별자- 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 형식의 사용자 전화번호. |
purchase s |
배열 | 이 사용자가 지난 90일 동안 구매한 구매 건수입니다. |
random_bucket |
정수 | 무작위 사용자 세그먼트를 균일하게 분산시키는 데 사용되는 사용자의 무작위 버킷 번호입니다. |
time_zone |
문자열 | 사용자의 표준 시간대를 IANA 표준 시간대 데이터베이스와 동일한 형식으로 입력합니다. |
total_revenue |
Float | 이 사용자에게 귀속된 총 수익입니다. 총 수익은 사용자가 받은 캠페인 및 캔버스에 대한 전환 기간 동안 구매한 금액을 기준으로 계산됩니다. |
uninstalled_at |
타임스탬프 | 사용자가 앱을 삭제한 날짜와 시간입니다. 앱이 제거되지 않은 경우 생략됩니다. |
user_aliases |
객체 | alias_name 및 alias_label 을 포함하는 사용자 별칭 개체가 있는 경우. |
응답
1
2
3
4
5
6
7
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
"message": (required, string) the status of the export, returns 'success' when completed without errors,
"object_prefix": (required, string) the filename prefix that will be used for the JSON file produced by this export, for example,'bb8e2a91-c4aa-478b-b3f2-a4ee91731ad1-1464728599',
"url" : (optional, string) the URL where the segment export data can be downloaded if you do not have your own S3 credentials
}
URL을 사용할 수 있게 된 후에는 몇 시간 동안만 유효합니다. 따라서 Braze에 자신의 S3 자격 증명을 추가하는 것을 적극 권장합니다.
사용자 내보내기 파일 출력 예시
사용자 내보내기 개체를 포함합니다(가능한 최소한의 데이터만 포함 - 개체에서 필드가 누락된 경우 null, false 또는 비어 있는 것으로 가정해야 함).
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
{
"created_at" : (string),
"external_id" : (string),
"user_aliases" : [
{
"alias_name" : (string),
"alias_label" : (string)
}
],
"braze_id": (string),
"first_name" : (string),
"last_name" : (string),
"email" : (string),
"dob" : (string) date for the user's date of birth,
"home_city" : (string),
"country" : (string) ISO-3166-1 alpha-2 standard,
"phone" : (string),
"language" : (string) ISO-639-1 standard,
"time_zone" : (string),
"last_coordinates" : (array of float) [lon, lat],
"gender" : (string) "M" | "F",
"total_revenue" : (float),
"attributed_campaign" : (string),
"attributed_source" : (string),
"attributed_adgroup" : (string),
"attributed_ad" : (string),
"custom_attributes" : (object) custom attribute key-value pairs,
"custom_events" : [
{
"name" : (string),
"first" : (string) date,
"last" : (string) date,
"count" : (int)
},
...
],
"purchases" : [
{
"name" : (string),
"first" : (string) date,
"last" : (string) date,
"count" : (int)
},
...
],
"devices" : [
{
"model" : (string),
"os" : (string),
"carrier" : (string),
"idfv" : (string) only included for iOS devices when IDFV collection is enabled,
"idfa" : (string) only included for iOS devices when IDFA collection is enabled,
"google_ad_id" : (string) only included for Android devices when Google Play Advertising Identifier collection is enabled,
"roku_ad_id" : (string) only included for Roku devices,
"ad_tracking_enabled" : (bool)
},
...
],
"apps" : [
{
"name" : (string),
"platform" : (string),
"version" : (string),
"sessions" : (string),
"first_used" : (string) date,
"last_used" : (string) date
},
...
],
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
{
"created_at" : "2020-07-10 15:00:00.000 UTC",
"external_id" : "A8i3mkd99",
"user_aliases" : [
{
"alias_name" : "user_123",
"alias_label" : "amplitude_id"
}
],
"braze_id": "5fbd99bac125ca40511f2cb1",
"random_bucket" : 2365,
"first_name" : "Jane",
"last_name" : "Doe",
"email" : "[email protected]",
"dob" : "1980-12-21",
"home_city" : "Chicago",
"country" : "US",
"phone" : "+442071838750",
"language" : "en",
"time_zone" : "Eastern Time (US & Canada)",
"last_coordinates" : [41.84157636433568, -87.83520818508256],
"gender" : "F",
"total_revenue" : 65,
"attributed_campaign" : "braze_test_campaign_072219",
"attributed_source" : "braze_test_source_072219",
"attributed_adgroup" : "braze_test_adgroup_072219",
"attributed_ad" : "braze_test_ad_072219",
"custom_attributes":
{
"loyaltyId": "37c98b9d-9a7f-4b2f-a125-d873c5152856",
"loyaltyPoints": "321",
"loyaltyPointsNumber": 107
},
"custom_events": [
{
"name": "Loyalty Acknowledgement",
"first": "2021-06-28T17:02:43.032Z",
"last": "2021-06-28T17:02:43.032Z",
"count": 1
},
...
],
"purchases": [
{
"name": "item_40834",
"first": "2021-09-05T03:45:50.540Z",
"last": "2022-06-03T17:30:41.201Z",
"count": 10
},
...
],
"devices": [
{
"model": "Pixel XL",
"os": "Android (Q)",
"carrier": null,
"device_id": "312ef2c1-83db-4789-967-554545a1bf7a",
"ad_tracking_enabled": true
},
...
],
"apps": [
{
"name": "MovieCannon",
"platform": "Android",
"version": "3.29.0",
"sessions": 1129,
"first_used": "2020-02-02T19:56:19.142Z",
"last_used": "2021-11-11T00:25:19.201Z"
},
...
],
}