跳到內容

出口用戶配置文件的標識符

帖子

/用戶/出口/ id

使用該端點的出口數據從任何用戶配置文件指定一個用戶標識符。

50external_idsuser_aliases可以包含在一個單一的請求。你應該希望指定嗎device_idemail_address唯一的標識符可以包含每個請求。

速率限製

為客戶與manbetx万博全站客户端釺機載或之後的8月16日,2021年,我們每分鍾2500個請求的速率限製適用於這個端點,作為記錄API率限製

請求體


            
1 2
內容類型:application / json授權:無記名YOUR-REST-API-KEY

            
1 2 3 4 5 6 7 8 9
{“external_ids”:(可選,數組字符串)外部標識符用戶希望出口,“user_aliases”:(可選,數組用戶別名對象)用戶別名用戶出口,“device_id”:(可選,字符串)設備標識符作為返回通過各種各樣的SDK方法這樣的作為“getDeviceId”,“braze_id”:(可選,字符串)標識符一個特定的用戶,“email_address”:(可選,字符串)電子郵件地址用戶,“電話”:(可選,字符串)電話數量用戶,“fields_to_export”:(可選,數組字符串)的名字用戶數據字段出口。違約所有如果提供}

請求參數

參數 要求 數據類型 描述
external_ids 可選 字符串數組 你希望用戶出口的外部標識符。
user_aliases 可選 用戶別名對象的數組 用戶別名用戶出口。
device_id 可選 字符串 返回的設備標識符,如各種SDK方法等getDeviceId
braze_id 可選 字符串 釺為一個特定的用戶標識符。
email_address 可選 字符串 電子郵件地址的用戶。
電話 可選 字符串E.164格式 電話號碼的用戶。
fields_to_export 可選 字符串數組 導出用戶數據字段的名稱。如果沒有提供默認為所有。

示例請求


            
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
curl——位置請求發布的https://rest.iad - 01. braze.com/users/export/ids \——頭的application / json內容類型:\——頭的授權:無記名YOUR-REST-API-KEY \ data-raw”{“external_ids”:“user_identifier1”、“user_identifier2”,“user_aliases”: [{“alias_name”:“example_alias”、“alias_label”:“example_label”}],“device_id”:“1234567”,“braze_id”:“braze_identifier”、“email_address”:“(電子郵件保護)”、“電話”:“+ 11112223333”、“fields_to_export”: [“first_name”、“電子郵件”、“購買”]}’

出口領域

以下是有效的列表fields_to_export。使用fields_to_export減少返回的數據可以提高這個API端點的響應時間:

出口領域 數據類型 描述
應用程序 數組 應用該用戶已登錄會話,包括的字段:

- - - - - -的名字:應用程序的名字
- - - - - -平台:應用程序平台,比如iOS、Android或Web
- - - - - -版本:應用程序版本號或名字
- - - - - -會話:這個程序的會話總數
- - - - - -first_used:第一次會議的日期
- - - - - -last_used:上次會議日期

所有字段都是字符串。
attributed_campaign 字符串 數據從歸因的集成,如果設置。標識一個特定的廣告活動。
attributed_source 字符串 數據從歸因的集成,如果設置。標識符的廣告平台。
attributed_adgroup 字符串 數據從歸因的集成,如果設置。標識符下麵的一個可選的子群活動。
attributed_ad 字符串 數據從歸因的集成,如果設置。標識符和adgroup下麵的一個可選的子群活動。
braze_id 字符串 特定於設備的唯一用戶標識符為該用戶設置通過釺。
國家 字符串 用戶的使用ISO 3166 - 1α2標準。
created_at 字符串 日期和時間為用戶配置文件被創建時,ISO 8601格式。
custom_attributes 對象 用戶自定義屬性鍵值對。
custom_events 數組 自定義事件歸因於該用戶在過去的90天。
設備 數組 用戶的設備信息,其中可能包括以下根據平台:

- - - - - -模型:設備型號名稱
- - - - - -操作係統:設備的操作係統
- - - - - -航空公司:設備的服務運營商,如果可用
- - - - - -idfv(iOS)釺的設備標識符,蘋果供應商標識符,如果存在
- - - - - -idfa:廣告(iOS)標識符,如果存在
- - - - - -device_id(Android)釺的設備標識符
- - - - - -google_ad_id(Android)穀歌播放廣告標識符,如果存在
- - - - - -roku_ad_id(Roku) Roku廣告標識符
- - - - - -ad_tracking_enabled:如果廣告在設備上啟用跟蹤,可以真或假
強加於人 字符串 用戶的出生日期格式YYYY-MM-DD
電子郵件 字符串 用戶的電子郵件地址。
external_id 字符串 唯一的用戶標識符識別用戶。
first_name 字符串 用戶的名字。
性別 字符串 用戶的性別。可能的值是:

- - - - - -:男性
- - - - - -F:女性
- - - - - -O:其他
- - - - - -N:不適用
- - - - - -P:不願意說
- - - - - -:未知
home_city 字符串 用戶的家鄉。
語言 字符串 用戶的語言在iso - 639 - 1標準。
last_coordinates 數組的浮動 用戶最近的設備位置、格式化(經度、緯度)
last_name 字符串 用戶的姓。
電話 字符串 用戶的電話號碼E.164格式。
購買 數組 購買這個用戶已經在過去的90天。
push_tokens 數組 獨特的匿名標識符指定發送應用程序的通知。
random_bucket 整數 用戶的隨機的桶數,用於創建均勻分布的隨機用戶。
time_zone 字符串 用戶的時區在同一格式IANA時區數據庫。
total_revenue 浮動 總收入歸因於這個用戶。總收入計算基於購買的用戶在windows轉換活動和畫布他們收到。
uninstalled_at 時間戳 日期和時間用戶卸載應用程序。省略,如果應用程序沒有卸載。
user_aliases 對象 用戶別名對象包含alias_namealias_label,如果存在。

請注意,/用戶/出口/ id端點將齊心協力整個用戶配置文件的用戶,包括數據等所有活動和油畫,所有自定義事件,所有購買,和自定義屬性。因此,這個端點是低於其他REST API端點。

根據請求的數據,這個API端點可能不足以滿足您的需求由於每分鍾2500個請求速率限製。如果你預期使用這個端點定期出口用戶,而不是考慮用戶出口段,這是異步和較大的數據將更加優化。

響應


            
1 2 3 4 5 6 7
內容類型:application / json授權:持票人YOUR-REST-API-KEY{“消息”:(需要,字符串)狀態出口,返回“成功”完成沒有錯誤,“用戶”:(數組對象)數據每一個出口用戶,可能如果沒有用戶發現,“invalid_user_ids”:(可選,數組字符串)每一個標識符提供請求做了對應一個已知的用戶}

的例子通過這個端點的數據見下麵的例子。

示例用戶導出文件輸出

用戶出口對象(我們至少將包括數據可能的——如果一個字段是失蹤的對象應該是假定為零,假,或空的):


              
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 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134
{“created_at”:(字符串),“external_id”:(字符串),“user_aliases”:({“alias_name”:(字符串),“alias_label”:(字符串)}),“braze_id”:(字符串),“first_name”:(字符串),“last_name”:(字符串),“電子郵件”:(字符串),“強加於人”:(字符串)日期用戶的日期出生,“home_city”:(字符串),“國家”:(字符串)ISO3166 - 1α2標準,“電話”:(字符串),“語言”:(字符串)ISO639 - 1標準,“time_zone”:(字符串),“last_coordinates”:(數組浮動)(,緯度),“性別”:(字符串)“M”|“F”,“total_revenue”:(浮動),“attributed_campaign”:(字符串),“attributed_source”:(字符串),“attributed_adgroup”:(字符串),“attributed_ad”:(字符串),“push_subscribe”:(字符串)“opted_in”|“訂閱”|“沒訂閱”,“email_subscribe”:(字符串)“opted_in”|“訂閱”|“沒訂閱”,“custom_attributes”:(對象)自定義屬性鍵-值,“custom_events”:({“名稱”:(字符串),“第一”:(字符串)日期,“最後一次”:(字符串)日期,“數”:(int)},),“購買”:({“名稱”:(字符串),“第一”:(字符串)日期,“最後一次”:(字符串)日期,“數”:(int)},),“設備”:({“模型”:(字符串),“操作係統”:(字符串),“航母”:(字符串),“idfv”:(字符串)隻有包括iOS設備IDFV集合啟用,“idfa”:(字符串)隻有包括iOS設備IDFA集合啟用,“google_ad_id”:(字符串)隻有包括安卓設備穀歌廣告標識符集合啟用,“roku_ad_id”:(字符串)隻有包括Roku設備,“ad_tracking_enabled”:(保齡球)},),“push_tokens”:({“應用程序”:(字符串)應用程序的名字,“平台”:(字符串),“令牌”:(字符串)},),“應用程序”:({“名稱”:(字符串),“平台”:(字符串),“版本”:(字符串),“會話”:(整數),“first_used”:(字符串)日期,“last_used”:(字符串)日期},),“campaigns_received”:({“名稱”:(字符串),“last_received”:(字符串)日期,“訂婚”:{“opened_email”:(保齡球),“opened_push”:(保齡球),“clicked_email”:(保齡球),“clicked_triggered_in_app_message”:(保齡球)},“轉換”:(保齡球),“api_campaign_id”:(字符串),“variation_name”:(可選,字符串)存在隻有如果一個多元運動,“variation_api_id”:(可選,字符串)存在隻有如果一個多元運動,“in_control”:(可選,bool)存在隻有如果一個多元運動},),“canvases_received”:({“名稱”:(字符串),“api_canvas_id”:(字符串),“last_received_message”:(字符串)日期,“last_entered”:(字符串)日期,“variation_name”:(字符串),“in_control”:(保齡球),“last_exited”:(字符串)日期,“steps_received”:({“名稱”:(字符串),“api_canvas_step_id”:(字符串),“last_received”:(字符串)日期},{“名稱”:(字符串),“api_canvas_step_id”:(字符串),“last_received”:(字符串)日期},{“名稱”:(字符串),“api_canvas_step_id”:(字符串),“last_received”:(字符串)日期}]},),“cards_clicked”:({“名稱”:(字符串)},]}

              
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 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133
{“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”:“5 fbd99bac125ca40511f2cb1”,“random_bucket”:2365年,“first_name”:“簡”,“last_name”:“母鹿”,“電子郵件”:(電子郵件保護),“強加於人”:“1980-12-21”,“home_city”:“芝加哥”,“國家”:“我們”,“電話”:“+ 442071838750”,“語言”:“en”,“time_zone”:“東部時間(美國和加拿大)”,“last_coordinates”:(41.84157636433568,-87.83520818508256),“性別”:“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”,“push_subscribe”:“opted_in”,“push_opted_in_at”:“2020 - 01 - 26 t22:45:53.953z”,“email_subscribe”:“訂閱”,“custom_attributes”:{“loyaltyId”:“37 c98b9d-9a7f-4b2f-a125-d873c5152856”,“loyaltyPoints”:“321”,“loyaltyPointsNumber”:107年},“custom_events”:({“名稱”:“忠誠確認”,“第一”:“2021 - 06 - 28 t17:02:43.032z”,“最後一次”:“2021 - 06 - 28 t17:02:43.032z”,“數”:1},),“購買”:({“名稱”:“item_40834”,“第一”:“2021 - 09 - 05 - t03:45:50.540z”,“最後一次”:“2022 - 06 - 03 t17:30:41.201z”,“數”:10},),“設備”:({“模型”:“像素XL”,“操作係統”:“Android (Q)”,“航母”:,“device_id”:“312 ef2c1 - 83 db - 4789 - 967 - 554545 - a1bf7a”,“ad_tracking_enabled”:真正的},),“push_tokens”:({“應用程序”:“MovieCanon”,“平台”:“Android”,“令牌”:“12345 abcd”,“device_id”:“312 ef2c1 - 83 db - 4789 - 967 - 554545 - a1bf7a”,“notifications_enabled”:真正的},),“應用程序”:({“名稱”:“MovieCannon”,“平台”:“Android”,“版本”:“3.29.0”,“會話”:1129年,“first_used”:“2020 - 02 - 02 - t19:56:19.142z”,“last_used”:“2021 - 11 - 11 - t00:25:19.201z”},),“campaigns_received”:({“名稱”:“電子郵件退訂”,“api_campaign_id”:“d72fdc84-ddda-44f1-a0d5-0e79f47ef942”,“last_received”:“2022 - 06 - 02年t03:07:38.105z”,“訂婚”:{“opened_email”:真正的},“轉換”:真正的,“multiple_converted”:{“主要轉換事件——一個“:真正的},“in_control”:,“variation_name”:“變種1”,“variation_api_id”:“1 bddc73a - a134 - 4784 - 9134 - 5 - b5574a9e0b8”},),“canvases_received”:({“名稱”:“全球抵抗組4/21/21非”,“api_canvas_id”:“46972 a9d dc81 - 473 f - aa03 e3473b4ed781”,“last_received_message”:“2021 - 07年- 07 - t20:46:24.136z”,“last_entered”:“2021 - 07年- 07 - t20:45:24.000 + 00:00”,“variation_name”:“變種1”,“in_control”:,“last_entered_control_at”:,“last_exited”:“2021 - 07年- 07 - t20:46:24.136z”,“steps_received”:({“名稱”:“步驟”,“api_canvas_step_id”:“43 d1a349-c3c8-4be1-9fbe-ce708e4d1c39”,“last_received”:“2021 - 07年- 07 - t20:46:24.136z”},]}),“cards_clicked”:({“名稱”:“忠誠優惠”},]}
這個頁麵是有用嗎?
新東西!
Baidu
map