👍

Try it!

Try out the Custom Exports API using your Branch data via the API reference here

概述

Benefits of Custom Exports API

  • The Branch Custom Exports find and queue log records that match your search criteria for export. You can do so either via the Custom Exports section in your Branch Dashboard or via the API (this page).

API Limitations

Limitation

细节

Data Availability

The data will be available around 2-3 hours behind real-time

Max number of records returned by API

2 Million

如果需要更多记录,请以较短的时间间隔进行多次请求,以将必要的数据放入“批次”中。

In some cases, Branch can increase the number of records above 2 million. Please contact Support to request an increase.

Max number of days that can be queried at a time

60

Export Window

Rolling 120 day window

Rate Limit for creating exports*

  • 每分钟10个请求
  • 25 requests per hour

Rate Limit for checking the status of a report*

  • 50 requests per minute
  • 每小时 1000 个请求

Exporting from test environments

At this moment, it is not possible to export data out of a Branch Test environment

60 分钟内的重复请求将被缓存

如果彼此之间在 60 分钟内发出相同的请求,则您不会看到多个正在运行的导出作业。相反,将使用同一个导出作业。如果您使用的是 API,则将返回相同的 job_id。这是为了避免彼此在几秒钟或几分钟内针对完全相同的数据集发出数百或数千个请求的情况。

60 分钟后,您的请求将启动一项新作业以检索数据。

*You will get the following response once you've hit the rate limit:

{
    "errors": [
        {
            "message": "Limit is exceeded for org-525983469347282987, retry after 3418 seconds",
            "error_code": 7
        }
    ]
}

Prerequisites & API Access

In order to use the Custom Exports API, you need to have completed the following:

  1. Created a Branch Dashboard
  2. Implemented the Branch SDK into your mobile app (iOS | Android)
  3. Opt into sharing device data through Apple's AppTrackingTransparency framework. When an install is attributed to paid ads, a 2nd install event will fire post user opt-in.

🚧

Data Changes Post iOS

Opt-ins will affect your final install count. We recommend using a different identifier (ex. IDFV) to de-dupe install events on your internal systems.

For additional information on changes post iOS 14.5, visit our FAQ Pages

  1. Logged into the Branch Dashboard with the Sensitive Data and Export Access Permission enabled.

提供代理商 API 访问权限

任何有权访问帐户的 API key 的用户都将能够访问 Branch 的 Custom Export API(从而可以访问未经筛选的日志级数据)。因此,我们建议您不要在邀请过程中向第三方提供查看 API key 所需的权限。

🚧

Data Purge

  • Branch will purge last-attributed data after 60 days.

如果您与运行广告 campaign 的代理商合作,并希望授予他们导出后续数据的权限,则可以向他们提供对 Custom Export API 的访问权限。

为代理商团队成员提供对 Custom Export API 的访问权限,请执行以下操作:

  1. In the left-hand navigation, under Configure, click on Account Settings.
  2. On the Account Settings page, click on the Agencies tab.
  3. Expand the agency in question, find the agency team member you want to give access to, hover on the button in the Actions column and click Edit.
  4. In the Edit Agency Team Member modal:
    1. Under Access Level, check the Export box.
    2. Under Permissions, check the Sensitive Data box.
  5. 可选:添加数据筛选项
    1. Under Data Filters, toggle any necessary data filters on/blue. Exported data will be filtered accordingly.
  6. 点击保存
12421242

🚧

Agency-Tagged 数据

如果您未启用 Only Show Agency-Tagged Data 数据筛选项,则代理商团队成员将能够导出与所有 campaign 关联的敏感数据。

认证

Calls to the Custom Export API require an access token parameter to be passed with each request. Access tokens are generated on a per-user basis and are permanent.

Learn how to retrieve your Access Token (a.k.a. an API Key).

API Usage

Create Export Request

POST /v2/logs?organization_id=ORG_ID
POST /v2/logs?app_id=APP_ID
Headers:
Access-Token: API_KEY
Content-Type: application/json
Body: JSON parameters
Host: api2.branch.io

Request Headers:

标头

描述

必要项

Access-Token

Key that encapsulates the user's permission w.r.t an org. Obtained from the Branch Dashboard needed for authentication.

Content-Type

application/json

Request Body Parameters:

参数

类型

描述

必要项

start_date

Date

The beginning datetime for the requested results, provided in ISO-8601 format including Hours, Minutes, Seconds and Milliseconds.

不带偏差的日期(即时区)默认为为时区参数提供的值。如果未指定时区参数,则日期时区默认为 UTC。日期必须在最近的120天内。范例:2016-01-01T00:00:00Z

end_date

Date

The end datetime for the requested results, provided in ISO-8601 format including Hours, Minutes, Seconds and Milliseconds.

不带偏差的日期(即时区)默认为为时区参数提供的值。如果未指定时区参数,则日期时区默认为 UTC。示例:2016-01-01T23:59:59:999Z

report_type

String

The Branch EO topic to be exported.

fields

Comma Separated List

List of comma-separated fields desired in results.

limit

Integer

Limit the number of items returned per request. Maximum allowed value is 2 million. If more than 2 million records are required, please make multiple requests with smaller time intervals to pull the data needed in “batches”.

时区

String

时区结果。接受 tz 数据库字符串,例如 “America / Los_Angeles”。

Optional parameter; results are returned in the dashboard timezone if not provided. Will default to UTC only if dashboard timezone is not set.

filter

Comma Separated List

Filter by fields and boolean operators against fields of the LogInstalls model; must be URI encoded and JSON parsed. Example: ["gt","last_attributed_touch_timestamp", 1604015756]

response_format

Nullable String

响应格式;可以是 “json” 或 “csv”。如果未选择,则默认为 CSV。 Branch 对 CSV 文件使用UTF-8 编码。

Response Body Parameters:

参数

描述

handle

Unique request handle generated against the endpoint call.

export_job_status_url

The URL of the export request.

Example Request/Response:

curl -X POST 'https://api2.branch.io/v2/logs?app_id=123456700098765432'
    -H "Content-Type: application/json"
    -H "Access-Token: YOUR_ACCESS_TOKEN_HERE"
    -d '{"report_type": "eo_open",
            "limit": 100,
            "fields": ["timestamp","name"],
            "start_date": "2019-12-09T00:00:00Z",
            "end_date": "2019-12-09T01:59:59Z",
            "filter": ["gt","last_attributed_touch_timestamp", 1604015756]
            }'
{"handle":"1612dbb3-85ef-49f8-b1c5-5818c163600c","export_job_status_url":"https://api2.branch.io/v2/logs/1612dbb3-85ef-49f8-b1c5-5818c163600c?app_id=123456700098765432"}

Response Codes:

Response Code

描述

200

Status of aggregate export.

400

Authentication Failed.

Get Export Request

GET /v2/logs/JOB_ID
Headers:
Access-Token: API_KEY
Host: api2.branch.io

Request Headers:

标头

描述

必要项

Access-Token

Key that encapsulates the user's permission w.r.t an org. Obtained from the Branch Dashboard needed for authentication.

Content-Type

application/json

Response Path Parameters

参数

类型

描述

必要项

request_handle

String

The ID returned by the log export queue.

Request Query Parameters:

参数

类型

描述

必要项

limit

Integer

要返回的最大结果数。

format

String

Format of returned data. json or csv

Response Body Parameters

参数

类型

描述

code

Integer

The response code.

lines_exported

Integer

Number of lines exported against the originated request.

status

String

Request status over the current execution time.

status_url

String

The URL of the export request.

Example Request/Response:

curl -X GET https://api2.branch.io/v2/logs/<YOUR_HANDLE>\?app_id\=<YOUR_BRANCH_APP_ID>
  -H "Content-Type: application/json" 
  -H "Access-Token:<YOUR_ACCESS_TOKEN>"
{"code":200,"lines_exported":2000000,"status":"complete","response_url":"https://branch-exports-web.s3.amazonaws.com/732662944269095814-eo_open-2019-12-10-2019-12-10-1612dbb3-85ef-49f8-b1c5-5818c163600c-bUlN2lwyTE10qIVH.csv?Signature=YOUR_ACCESS_TOKEN_HERE&AWSAccessKeyId=YOUR_ACCESS_TOKEN_HERE&Expires=1577305615"}

Response Codes:

Response Code

描述

200

Status of aggregate export

400

Authentication Failed

404

Job ID Not Found

Status Values:

Status

描述

pending

Request is pending.

running

Request is still running.

complete

Request is complete.

fail

Request failed.

附录

Available EO Fields

字段

类型

描述

app_id

Long

App ID (capitalize ID in Liveview)

app_name

String

App Name

归因

Boolean

Attributed

content_items

ArrayStruct

内容项

custom_data

MapStringString

自定义数据

customer_event_alias

String

Customer Event Alias

days_from_last_attributed_touch_to_event

Integer

Days From Last Attributed Touch To Event

deep_linked

Boolean

Deep Linked

di_match_click_token

Long

DI Match Click Token

event_data_ad_type

enum { BANNER, INTERSTITIAL, REWARDED_VIDEO, NATIVE }

广告类型

event_data_affiliation

String

Affiliation

event_data_coupon

String

Coupon

event_data_currency

String

货币

event_data_description

String

Event Description

event_data_exchange_rate

Double

Exchange Rate

event_data_revenue

Double

Revenue

event_data_revenue_in_usd

Double

Revenue In USD

event_data_search_query

String

Search Query

event_data_shipping

Double

Shipping

event_data_tax

Double

Tax

event_data_transaction_id

String

交易 ID

event_data_local_currency

String

Local Currency

event_data_local_currency_exchange_rate

String

Local Currency Exchange Rate

event_data_revenue_in_local_currency

String

Revenue in Local Currency

event_data_custom_param_1

String

Custom parameter for event

event_data_custom_param_2

String

Custom parameter for event

event_data_custom_param_3

String

Custom parameter for event

event_timestamp

Long

Event Timestamp

existing_user

Boolean

现有用户

external_intent_uri

String

External Intent URI

first_event_for_user

Boolean

First Event For User

hash_version

String

Hash Version

hours_from_last_attributed_touch_to_event

Integer

House From Last Attributed Touch To Event

id

String

ID

install_activity_attributed

Boolean

Install Attributed

install_activity_data_has_clicked_ad

Boolean

Install Has Clicked Ad

install_activity_data_has_clicked_email

Boolean

Install Has Clicked Email

install_activity_timestamp

Long

Install Timestamp

install_activity_touch_data_additional_data_tilde_ad_id

Long

Install Ad ID

install_activity_touch_data_additional_data_tilde_ad_set_id

Long

Install Ad Set ID

install_activity_touch_data_additional_data_tilde_campaign_id

Long

Install Campaign ID

install_activity_touch_data_additional_data_tilde_creative_id

Long

Install Creative ID

install_activity_touch_data_dollar_3p

String

Install Partner 3p Value

install_activity_touch_data_plus_via_features

String

Install Features

install_activity_touch_data_plus_web_format

String

Install Web Format

install_activity_touch_data_tilde_ad_name

String

Install Ad Name

install_activity_touch_data_tilde_ad_set_name

String

Install Ad Set Name

install_activity_touch_data_tilde_advertising_partner_id

Long

Install Ad Partner ID

install_activity_touch_data_tilde_advertising_partner_name

String

Install Ad Partner

install_activity_touch_data_tilde_agency

String

Install Agency

install_activity_touch_data_tilde_agency_id

Long

Install Agency ID

install_activity_touch_data_tilde_campaign

String

Install Campaign

install_activity_touch_data_tilde_channel

String

Install Channel

install_activity_touch_data_tilde_creative_name

String

Install Creative Name

install_activity_touch_data_tilde_customer_ad_name

String

Install Customer Ad Name

install_activity_touch_data_tilde_customer_ad_set_name

String

Install Customer Ad Set Name

install_activity_touch_data_tilde_customer_campaign

String

Install Customer Campaign

install_activity_touch_data_tilde_customer_keyword

String

Install Customer Keyword

install_activity_touch_data_tilde_customer_placement

String

Install Customer Placement

install_activity_touch_data_tilde_customer_secondary_publisher

String

Install Customer Secondary Publisher

install_activity_touch_data_tilde_customer_sub_site_name

String

Install Customer Sub Site Name

install_activity_touch_data_tilde_feature

String

Install Feature

install_activity_touch_data_tilde_journey_name

String

Install Journey Name

install_activity_touch_data_tilde_keyword

String

Install Keyword

install_activity_touch_data_tilde_placement

String

Install Placement

install_activity_touch_data_tilde_secondary_publisher

String

Install Secondary Publisher

install_activity_touch_data_tilde_stage

String

Install Stage

install_activity_touch_data_tilde_tags

String

Install Tags

install_activity_touch_data_tilde_view_name

String

Install View Name

install_activity_touch_type

String

Install Touch Type

last_attributed_touch_data_custom_fields

String

Last Attributed Touch Custom Fields

last_attributed_touch_data_dollar_3p

String

Ad Partner (3p)

last_attributed_touch_data_dollar_marketing_title

String

Marketing Title

last_attributed_touch_data_plus_current_feature

String

Current Feature

last_attributed_touch_data_tilde_id

Long

Last Attributed Touch ID

last_attributed_touch_data_plus_touch_id

String

Last Attributed Touch Touch ID

last_cta_view_data_plus_touch_id

String

Last CTA View Touch ID

last_attributed_touch_data_plus_via_features

ArrayString

Via Features

last_attributed_touch_data_plus_web_format

String

Web Format

last_attributed_touch_data_tilde_ad_id

String

Ad ID

last_attributed_touch_data_tilde_ad_name

String

Ad Name

last_attributed_touch_data_tilde_ad_set_id

String

Ad Set ID

last_attributed_touch_data_tilde_ad_set_name

String

广告集名称

last_attributed_touch_data_tilde_advertising_account_name

String

Advertising Account Name

last_attributed_touch_data_tilde_advertising_account_id

String

Advertising Account ID

last_attributed_touch_data_tilde_advertising_partner_id

String

Ad Partner ID

last_attributed_touch_data_tilde_advertising_partner_name

String

广告合作伙伴

last_attributed_touch_data_tilde_agency

String

代理商

last_attributed_touch_data_tilde_agency_id

String

代理商 ID

last_attributed_touch_data_tilde_banner_dimensions

String

Banner Dimensions

last_attributed_touch_data_tilde_branch_ad_format

String

Branch Ad Format

last_attributed_touch_data_tilde_campaign

String

Campaign

last_attributed_touch_data_tilde_campaign_id

String

Campaign ID

last_attributed_touch_data_tilde_campaign_type

String

广告活动类型

last_attributed_touch_data_tilde_channel

String

渠道

last_attributed_touch_data_tilde_creative_name

String

广告名称

last_attributed_touch_data_tilde_creative_id

String

广告素材 ID

last_attributed_touch_data_tilde_customer_ad_name

String

Customer Ad Name

last_attributed_touch_data_tilde_customer_ad_set_name

String

Customer Ad Set Name

last_attributed_touch_data_tilde_customer_campaign

String

Customer Campaign

last_attributed_touch_data_tilde_customer_keyword

String

Customer Keyword

last_attributed_touch_data_tilde_customer_placement

String

Customer Placement

last_attributed_touch_data_tilde_customer_secondary_publisher

String

Customer Secondary Publisher

last_attributed_touch_data_tilde_customer_sub_site_name

String

Customer Sub Site Name

last_attributed_touch_data_tilde_external_touch_id

String

External Touch ID

last_attributed_touch_data_tilde_feature

String

功能

last_attributed_touch_data_tilde_journey_id

String

Journey ID

last_attributed_touch_data_tilde_journey_name

String

Journey Name

last_attributed_touch_data_tilde_keyword

String

Keyword

last_attributed_touch_data_tilde_keyword_id

String

关键字 ID

last_attributed_touch_data_tilde_optimization_model

String

Optimization Model

last_attributed_touch_data_tilde_placement

String

放置

last_attributed_touch_data_tilde_placement_id

String

Placement ID

last_attributed_touch_data_tilde_secondary_ad_format

String

Secondary Ad Format

last_attributed_touch_data_tilde_secondary_publisher

String

Secondary Publisher

last_attributed_touch_data_tilde_secondary_publisher_id

String

Secondary Publisher ID

last_attributed_touch_data_tilde_stage

String

阶段

last_attributed_touch_data_tilde_sub_site_name

String

Sub Site Name

last_attributed_touch_data_tilde_tags

ArrayString

标记

last_attributed_touch_data_tilde_technology_partner

String

Technology Partner

last_attributed_touch_data_tilde_touch_subtype

String

Google Video Ads "Engaged View"

last_attributed_touch_data_tilde_view_id

String

View ID

last_attributed_touch_data_tilde_view_name

String

View Name

last_attributed_touch_timestamp

Long

Last Attributed Touch Timestamp

last_attributed_touch_timestamp_iso

String

Last Attributed Touch Timestamp (ISO)

last_attributed_touch_type

String

Last Attributed Touch Type

last_cta_view_data_custom_fields

String

Last CTA View Custom Fields

last_cta_view_data_dollar_3p

String

Last CTA View Ad Partner (3p)

last_attributed_touch_data_plus_referring_domain

String

Referring Domain

last_cta_view_data_plus_via_features

ArrayString

Last CTA View Via Features

last_cta_view_data_plus_web_format

String

Last CTA View Web Format

last_cta_view_data_tilde_ad_id

String

Last CTA View Ad ID

last_cta_view_data_tilde_ad_name

String

Last CTA View Ad Name

last_cta_view_data_tilde_ad_set_id

String

Last CTA View Ad Set ID

last_cta_view_data_tilde_ad_set_name

String

Last CTA View Ad Set Name

last_cta_view_data_tilde_advertising_partner_name

String

Last CTA View Ad Partner

last_cta_view_data_tilde_agency

String

Last CTA View Agency

last_cta_view_data_tilde_banner_dimensions

String

Last CTA View Banner Dimensions

last_cta_view_data_tilde_branch_ad_format

String

Last CTA View Branch Ad Format

last_cta_view_data_tilde_campaign

String

Last CTA View Campaign

last_cta_view_data_tilde_campaign_id

String

Last CTA View Campaign ID

last_cta_view_data_tilde_campaign_type

String

Last CTA View Campaign Type

last_cta_view_data_tilde_channel

String

Last CTA View Channel

last_cta_view_data_tilde_creative_id

String

Last CTA View Creative ID

last_cta_view_data_tilde_creative_name

String

Last CTA View Creative Name

last_cta_view_data_tilde_external_touch_id

Long

Last CTA View External Touch ID

last_cta_view_data_tilde_feature

String

Last CTA View Feature

last_cta_view_data_tilde_id

Long

Last CTA View ID

last_cta_view_data_tilde_keyword_id

String

Last CTA View Keyword ID

last_cta_view_data_tilde_optimization_model

String

Last CTA View Optimization Model

last_cta_view_data_tilde_placement

String

Last CTA View Placement

last_cta_view_data_tilde_secondary_ad_format

String

Last CTA View Secondary Ad Format

last_cta_view_data_tilde_secondary_publisher

String

Last CTA View Secondary Publisher<

last_cta_view_data_tilde_stage

String

Last CTA View Stage

last_cta_view_data_tilde_tags

ArrayString

Last CTA View Tags

last_cta_view_data_tilde_technology_partner

String

Last CTA View Technology Partner

last_cta_view_timestamp

Long

Last CTA View Timestamp

last_cta_view_timestamp_iso

String

Last CTA View Timestamp (ISO)

+match_guaranteed

boolean

Flag that determines if the app session was made with 100% accuracy. Only available in Custom Exports API

minutes_from_last_attributed_touch_to_event

Integer

Minutes From Last Attributed Touch To Event

名称

String

Name of event based on selected topic

Organization_id

Long

机构编号

organization_name

String

Organization Name

origin

String

Origin

reengagement_activity_attributed

Boolean

Reengagement Activity Attribute

reengagement_activity_data_has_clicked_ad

Boolean

Reengagement Has Clicked Ad

reengagement_activity_data_has_clicked_email

Boolean

Reengagement Has Clicked Email

reengagement_activity_timestamp

String

Reengagement Timestamp

reengagement_activity_touch_data_additional_data_tilde_ad_id

Long

Reengagement Ad ID

reengagement_activity_touch_data_additional_data_tilde_ad_set_id

Long

Reengagement Ad Set ID

reengagement_activity_touch_data_additional_data_tilde_campaign_id

Long

Reengagement Campaign ID

reengagement_activity_touch_data_additional_data_tilde_creative_id

Long

Reengagement Creative ID

reengagement_activity_touch_data_dollar_3p

String

Reengagement Partner 3p Value

reengagement_activity_touch_data_plus_via_features

String

Reengagement Features

reengagement_activity_touch_data_plus_web_format

String

Reengagement Web Format

reengagement_activity_touch_data_tilde_ad_name

String

Reengagement Ad Name

reengagement_activity_touch_data_tilde_ad_set_name

String

Reengagement Ad Set Name

reengagement_activity_touch_data_tilde_advertising_partner_id

Long

Reengagement Advertising Partner ID

reengagement_activity_touch_data_tilde_advertising_partner_name

String

Reengagement Advertising Partner Name

reengagement_activity_touch_data_tilde_agency

String

Reengagement Agency

reengagement_activity_touch_data_tilde_agency_id

Long

Reengagement Agency ID

reengagement_activity_touch_data_tilde_campaign

String

Reengagement Campaign

reengagement_activity_touch_data_tilde_channel

String

Reengagement Channel

reengagement_activity_touch_data_tilde_creative_name

String

Reengagement Creative Name

reengagement_activity_touch_data_tilde_customer_ad_name

String

Reengagement Customer Ad Name

reengagement_activity_touch_data_tilde_customer_ad_set_name

String

Reengagement Customer Ad Set Name

reengagement_activity_touch_data_tilde_customer_campaign

String

Reengagement Customer Campaign

reengagement_activity_touch_data_tilde_customer_keyword

String

Reengagement Customer Keyword

reengagement_activity_touch_data_tilde_customer_placement

String

Reengagement Customer Placement

reengagement_activity_touch_data_tilde_customer_secondary_publisher

String

Reengagement Customer Secondary Publisher

reengagement_activity_touch_data_tilde_customer_sub_site_name

String

Reengagement Customer Sub Site

reengagement_activity_touch_data_tilde_feature

String

Reengagement Feature

reengagement_activity_touch_data_tilde_journey_name

String

Reengagement Journey Name

reengagement_activity_touch_data_tilde_keyword

String

Reengagement Keyword

reengagement_activity_touch_data_tilde_placement

String

Reengagement Placement

reengagement_activity_touch_data_tilde_secondary_publisher

String

Reengagement Secondary Publisher

reengagement_activity_touch_data_tilde_stage

String

Reengagement Stage

reengagement_activity_touch_data_tilde_tags

String

Reengagement Tags

reengagement_activity_touch_data_tilde_view_name

String

Reengagement View Name

reengagement_activity_touch_type

String

Reengagement Touch Type

referrer_click_timestamp

Long

Referrer Click Timestamp

seconds_from_install_to_event

Integer

Seconds From Install To Event

seconds_from_last_attributed_touch_to_event

Integer

Seconds From Last Attributed Touch To Event

seconds_from_last_attributed_touch_to_store_install_begin

Integer

Seconds From Touch To Store Install Begin

site_event_items_count

Integer

Content Items Count

store_install_begin_timestamp

Long

Store Install Begin Timestamp

timestamp

Long

timestamp

timestamp_iso

String

Timestamp (ISO)

user_data_aaid

String

AAID

user_data_android_id

String

Android ID

user_data_app_package_name

String

App Package Name | TUNE ONLY

user_data_app_version

String

App 版本

user_data_brand

String

品牌

user_data_browser

String

Browser

user_data_build

String

Build

user_data_cpu_type

String

CPU Type

user_data_cross_platform_id

String

Cross Platform ID

user_data_developer_identity

String

Developer Identity(开发者身份)

user_data_device_type

String

设备类型

user_data_environment

String

Environment

user_data_geo_city_code

Integer

城市代码

user_data_geo_city_en

String

城市

user_data_geo_country_code

String

国家代码

user_data_geo_country_en

String

Country

user_data_geo_dma_code

Integer

DMA Code

user_data_geo_lat

Float

纬度

user_data_geo_lon

Float

经度

user_data_geo_postal_code

String

邮政编码

user_data_geo_region_en

String

Region

user_data_geo_region_code

String

Region Code

user_data_http_referrer

String

HTTP Referrer

user_data_idfa

String

IDFA

user_data_idfv

String

IDFV

user_data_installer_package_name

String

Installer Package Name | TUNE ONLY

user_data_internet_connection_type

String

Internet Connection Type

user_data_ip

String

IP 地址

user_data_is_jailbroken

Boolean

IIs Jailbroken

user_data_kindle_id

String

Kindle ID

user_data_language

String

语言

user_data_limit_ad_tracking

Boolean

限制广告追踪

user_data_model

String

模型

user_data_oaid

String

Huawei OAID

user_data_os

String

操作系统

user_data_os_version

String

操作系统版本

user_data_os_version_android

String

OS Version (Android)

user_data_past_cross_platform_ids

ArrayString

Past Cross Platforms IDs

user_data_platform

ArrayString

平台

user_data_prob_cross_platform_ids

ArrayStruct

Probabilistic Cross Platform IDs

user_data_roku_rida

String

Roku Device ID

user_data_screen_height

Integer

Screen Height

user_data_screen_width

Integer

Screen Width

user_data_sdk_version

String

SDK 版本

user_data_user_agent

String

用户代理

user_data_windows_aid

String

Windows AID

user_data_device_locale

String

Device Locale

user_data_carrier_name

String

Carrier Name

user_data_opted_in_status

String

Whether user opted in to ATT or not

user_data_app_store

String

The app store the user downloaded from

Available SKAdNetwork Message Fields

Field

类型

描述

id

varchar

SkAdNetwork Message ID

body_transaction_id

varchar

SKAdNetwork Transaction ID

body_version

varchar

SKAdNetwork Version

body_ad_network_id

varchar

SKAdNetwork Ad Network ID

body_campaign_id

整数

SKAdNetworkCampaign ID

body_app_id

bigint

SKAdNetwork App ID (App Store ID)

body_attribution_signature

varchar

Body Attribution Signature

body_redownload

boolean

SKAdNetwork Redownload

body_source_app_id

bigint

SKAdNetwork Source App ID

body_conversion_value

整数

Body Conversion Value

body_fidelity_type

整数

Body Fidelity Type

body_did_win

boolean

Body Did Win

last_attributed_touch_data_tilde_ad_set_name

varchar

Ad Partner Ad Set Name

last_attributed_touch_data_tilde_ad_set_id

varchar

Ad Partner Ad Set ID

last_attributed_touch_data_tilde_campaign_id

varchar

Ad Partner Campaign ID

last_attributed_touch_data_tilde_campaign

varchar

Ad Partner Campaign Name

invalid_reason

varchar

Invalid Reason

timestamp

bigint

Timestamp when Branch received data

event_timezone_adjusted_day

bigint

Timestamp provided by Partner

annotation_dollar_3p

varchar

Annotation Dollar 3P

annotation_conversion_value_mapped_value

varchar

Annotation Conversion Vale Mapped Value

annotation_customer_event_alias

varchar

Annotation Customer Event Alias

annotation_revenue_lower

varchar

Annotation Revenue Lower Bound

annotation_revenue_upper

varchar

Annotation Revenue Upper Bound

app_id

bigint

Branch App ID

Organization_id

bigint

Branch Organization ID

advertiser_copy

Boolean

Advertiser Copy for iOS 15+ devices

🚧

知识产权差异

对于无法将 IP 解析到某个位置的事件,只有很少一部分事件无法使用国家和城市等地理数据。

Available Topics

主题

可读名称

eo_click_blocked

Blocked Clicks

eo_commerce_event_blocked

Blocked Commerce Events

eo_content_event_blocked

Blocked Content Events

eo_branch_cta_view_blocked

Blocked CTA Views

eo_custom_event_blocked

Blocked Custom Events

eo_impression_blocked

Blocked Impressions

eo_install_blocked

Blocked Installs

eo_open_blocked

Blocked Opens

eo_pageview_blocked

Blocked Pageviews

eo_reinstall_blocked

Blocked Reinstalls

eo_sms_sent_blocked

Blocked SMS Sent

eo_user_lifecycle_event_blocked

Blocked User Lifecycle Events

eo_web_session_start_blocked

Blocked Web Session Starts

eo_click

Clicks

eo_commerce_event

商业活动

eo_content_event

Content Event

eo_branch_cta_view

CTA Views

eo_custom_event

自订活动

eo_impression

Impressions(展示)

eo_install

Installs

eo_open

Open

eo_pageview

浏览量

webhook2

Postback Records

eo_reinstall

Reinstall

skadnetwork_invalid_messages

SKAdNetwork Invalid Messages

skadnetwork_valid_messages

SKAdNetwork Valid Messages

eo_sms_sent

短信已发送

eo_user_lifecycle_event

用户 Lifecycle Event

eo_web_session_start

Web Session Start

eo_web_to_app_auto_redirect

Web To App Auto Redirects

eo_san_touch

Self-Attributing Network Touch

🚧

被屏蔽的主题

Branch 允许从请求之日起最多导出60天的被阻止主题。