出口段用戶配置文件

帖子

/用戶/出口/段

使用該端點出口段內所有用戶。

用戶數據導出為多個文件的用戶由新行(即JSON對象。每行一個JSON對象)。數據導出到一個自動生成的URL,或者一個S3 bucket如果這種集成已經建立。

目前還不支持此端點通過穀歌雲存儲。

注意,一個公司可能最多運行一個出口每航段使用該端點在給定的時間。等待你的出口完成後重試。

重要的是:

2021年12月開始,這個API以下改變:

1。的fields_to_export這個API請求要求。選擇默認所有字段被移除。
2。的字段custom_events,購買,campaigns_received,canvases_received從過去的90天隻包含數據。

速率限製

我們應用默認釺速率限製每小時250000個請求的端點,作為記錄API率限製。

基於憑證的響應的細節

如果你有添加你S3或Azure憑證釺,然後將每個文件上傳到你的水桶,一個ZIP文件格式看起來像的關鍵segment-export / SEGMENT_ID YYYY-MM-dd / RANDOM_UUID-TIMESTAMP_WHEN_EXPORT_STARTED / filename.zip。如果使用Azure,確保你有默認的數據出口目的地箱檢查在釺Azure夥伴概述頁麵。一般來說,我們將創建1文件/ 5000用戶優化處理。出口小段在一個較大的工作空間可能導致多個文件。你可以解壓文件和連接所有的json如果需要文件到一個文件。如果你指定一個output_format的gzip,然後將文件擴展名. gz而不是. zip。

導出路徑控製分解為ZIP文件

ZIP文件格式:bucket名/ segment-export / SEGMENT_ID / YYYY-MM-dd / RANDOM_UUID-TIMESTAMP_WHEN_EXPORT_STARTED / filename.zip

示例ZIP文件:braze.docs.bucket / segment-export abc56c0c - rd4a pb0a - 870 pdf4db07q / 2019-04-25 / d9696570-dfb7-45ae-baa2-25e302r2da27-1556044807/114f0226319130e1a4770f2602b5639a.zip

財產	細節	所示為例…
`bucket名`	固定的基於你的桶的名字。	`braze.docs.bucket`
`segment-export`	固定的。	`segment-export`
`SEGMENT_ID`	包括在出口要求。	`abc56c0c - rd4a pb0a - 870 pdf4db07q`
`YYYY-MM-dd`	日期收到成功的回調。	`2019-04-25`
`RANDOM_UUID`	隨機UUID生成的銅焊時的請求。	`d9696570-dfb7-45ae-baa2-25e302r2da27`
`TIMESTAMP_WHEN_EXPORT_STARTED`	自2017 - 01 - 01:00:00:00z Unix時間(秒),出口要求。	`1556044807`
`文件名`	隨機的每個文件。	`114年f0226319130e1a4770f2602b5639a`

我們強烈建議客戶使用這個端點建立自己的S3或者Azmanbetx万博全站客户端ure憑據,這樣客戶可以執行自己的鬥出口政策。如果你沒有提供雲存儲憑證,URL的請求的響應提供了一個ZIP文件,其中包含所有用戶可以下載文件。隻會成為一個有效的URL位置一旦出口已經準備好了。

請注意,如果你不能提供雲存儲憑證,有限製的數據量可以從這個端點出口。根據你導出的字段的用戶數量,文件傳輸可能會失敗,如果它是太大。一個最佳實踐是指定哪些字段你想出口隻使用“fields_to_export”並指定字段的大小你需要為了保持低轉移。如果你得到錯誤生成文件,考慮把用戶分成多段基於隨機桶數量(例如,創建一個段,隨機桶數量< 1000年,在1000年至2000年之間,等等)。

在這兩種場景中,您可以選擇提供一個callback_endpoint出口時要通知準備好了。如果callback_endpoint提供,我們將做一個post請求時所提供的地址下載已經準備好了。文章將“成功”的主體:真的。如果你沒有添加釺S3憑證,然後帖子將另外的主體屬性url下載URL的值。

更大的用戶基礎將導致出口時間過長。例如,一個應用程序與2000萬用戶可能需要一個小時或更多。

請求體

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

          
               {“segment_id”:(需要,字符串)標識符為的段來是出口,“callback_endpoint”:(可選,字符串)端點來帖子一個下載URL來當的出口是可用,“fields_to_export”:(需要,數組的字符串)的名字的用戶數據字段來出口,你可能也出口自定義屬性。*開始4月2021年,新賬戶必須指定具體的字段來出口。“output_format”:(可選,字符串)當使用你的自己的年代3桶,指定文件格式作為“郵政編碼”或“gzip”。違約來郵政編碼文件格式}

警告:

個人定製屬性不能出口。然而,所有自定義屬性可以通過包括出口custom_attributes在fields_to_export數組(如[“first_name”、“電子郵件”,' custom_attributes '])。

請求參數

參數	要求	數據類型	描述
`segment_id`	要求	字符串	出口段標識符。看到段標識符。的`segment_id`對於一個給定的部分可以找到的API密鑰頁麵內釺賬戶或者您可以使用線段端點列表。
`callback_endpoint`	可選	字符串	端點發布下載URL時,出口是可用的。
`fields_to_export`	要求*	字符串數組	導出用戶數據字段的名稱,還可以導出自定義屬性。 * 2021年4月開始,新賬戶必須指定特定字段導出。
`output_format`	可選	字符串	您的文件的輸出格式。默認為`郵政編碼`文件格式。如果您使用的是自己的S3 bucket,您可以指定`郵政編碼`或`gzip`。

示例請求

          
               curl——位置請求發布的https://rest.iad - 01. braze.com/users/export/segment \——頭的application / json內容類型:\——頭的授權:無記名YOUR-REST-API-KEY \ data-raw”{“segment_id”:“segment_identifier”、“callback_endpoint”:“example_endpoint”、“fields_to_export”: [“first_name”、“電子郵件”、“購買”),“output_format”:“zip”}”

出口領域

以下是有效的列表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天。
`random_bucket`	整數	用戶的隨機的桶數,用於創建均勻分布的隨機用戶。
`time_zone`	字符串	用戶的時區在同一格式IANA時區數據庫。
`total_revenue`	浮動	總收入歸因於這個用戶。總收入計算基於購買的用戶在windows轉換活動和畫布他們收到。
`uninstalled_at`	時間戳	日期和時間用戶卸載應用程序。省略,如果應用程序沒有卸載。
`user_aliases`	對象	用戶別名對象包含`alias_name`和`alias_label`,如果存在。

重要的提醒

的字段custom_events,購買,campaigns_received,canvases_received將包含從過去90天隻包含數據。
這兩個custom_events和購買包含字段第一個和數。這兩個字段將反映的信息,並將不局限於過去90天的數據。例如,如果一個特定的用戶第一次做事件前90天前,這將是準確地反映在第一個場,數字段將考慮事件發生前最後的90天。
並發段出口公司可以運行在端點級別限製在100人以內。試圖超越這個限製將導致一個錯誤。

響應

          
               內容類型:application / json授權:持票人YOUR-REST-API-KEY{“消息”:(需要,字符串)的狀態的的出口,返回“成功”當完成沒有錯誤,“object_prefix”:(需要,字符串)的文件名前綴那將是使用為的JSON文件生產通過這出口,如。,“bb8 e2一個91年- c4aa-478年b3f2——一個4ee91731年廣告1 - 1464728599”,“url”:(可選,字符串)的URL在哪裏的段出口數據可以是下載如果你做不有你的自己的年代3憑證}

一旦可用,URL幾個小時才會有效。因此,我們強烈建議您添加自己的S3憑證釺。

示例用戶導出文件輸出

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

所有字段
樣例輸出

            
                 {“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”:({“名稱”:(字符串)},…]}

            
                 {“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”:({“名稱”:“忠誠優惠”},…]}

提示:

尋求幫助和CSV和API出口,訪問出口故障排除。

編輯這個頁麵在GitHub上

這個頁麵是有用嗎?

是的沒有

manbetx手机版3.0

產品概述

工程對於任何規模

數據與分析

直觀的工具,營銷人員

優化

集成橫跨海峽的交付

行業

用例

案例研究

戰略合作夥伴關係

所有資源→

使用銅焊

內容庫