自定义导出和 API

概述

📘

Branch 和 TUNE 导出功能

自定义导出可用于 Branch 数据点和 TUNE 数据点。当参考以下文档时,请确保查看正确的选项卡— Branch 或 TUNE。

Branch 自定义导出 (Custom Exports) 查找并排列与您的导出搜索条件匹配的日志记录。您可以通过 Branch 操作后台 (Dashboard) 中的 Custom Exports 部分或通过 API 进行操作。

Custom exports endpoints are limited to a maximum of 2 million records each and only 60 days of data can be queried at a time. Also, you can only query up to 120 days prior to the date of export via the Branch Dashboard, this does not apply to the API.

如果需要更多记录,请以较短的时间间隔进行多次请求,以将必要的数据放入 “batches” 中。在部分情况下,Branch 可以将记录数增加到200万以上。请联系支持中心以请求增加。

🚧

iOS 14.5 发布之后 data 的变化

Apple 要求用户在 Apple 的 AppTrackingTransparency 框架下选择分享其设备 data。安装归因于付费广告时,第2次安装事件将触发用户选择加入

用户是否选择加入将影响您的最终安装数量。我们建议使用一个不同的标识符 (如IDFV) 来对内部系统上的安装事件进行去重。

iOS 14.5 发布之后的变化,额外相关信息请访问我们的 常见问题页面

认证

调用 Custom Export API 要求每个请求都传递一个 access token 参数。访问 Token 是基于每个用户生成的,并且是永久的。

了解如何获取访问 Token(即 API Key)

频率限制

频率限制取决于您发出请求的 endpoint。

创建导出(exports): 频率限制为每分钟10个请求和每小时25个请求。

为了检查导出状态,频率限制为每分钟50个请求和每小时1000个请求。

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

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

🚧

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

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

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

导出权限设置

为了访问自定义导出,用户将需要同时具有 Sensitive DataExport 访问权限。

图片图片

有关如何为用户提供所需访问权限的更多详细信息,请阅读 默认访问级别,用户角色和权限

第三方访问

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

提供代理商 API 访问权限

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

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

  1. 在左侧导航栏中的 Setup & Testing ,点击 Account Settings
  2. Account Settings 页面上,点击 Agencies 选项卡。
  3. 请展开查看存在问题的代理商,找到您要授予访问权限的代理商团队成员,将鼠标悬停在 Actions 列中的键上,然后点击 Edit
  4. Edit Agency Team Member 弹窗中:
    1. Access Level ,选中 Export 框。
    2. Permissions ,选中 Sensitive Data 框。
  5. 可选:添加数据筛选项
    1. Data Filters ,将所有必要的数据筛选项都打开/显示为蓝色。导出的数据将被相应地筛选。
  6. 点击 Save

图片图片

🚧

Agency-Tagged 数据

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

可用的主题导出

请参阅 Branch TUNE 的可用主题的完整列表。

可用字段

请参阅 Branch TUNE 可用字段的完整列表。

通过 Branch 操作后台 (Dashboard)访问

📘

我们已将用户界面限制为只能导出60天或60天以内的数据。通常,建议一次导出一天的数据。

可以直接使用 Branch 操作后台 (Dashboard)中的 Custom Export API 部分来通过 CSV 请求适当的数据,无需直接访问 Custom Export API。

请求导出:

  1. 在左侧导航的 Setup & Testing 部分下,点击 Data Import & Export ,然后点击 Exports
  2. Custom Exports页面,提供以下内容:
    • 适当的 Date Range
    • 导出应包括的 Topic 类型。
    • 您要包含的字段的 Columns
    • 您要包括的所有额外的 Filters
    • 导出的 Download Type

您还可以在 Custom Exports Created 表中查看任何请求的导出,其中包括:

  • 创建日期
  • 主题/日期范围
  • 行数
  • 格式
  • Status

通过 API 访问

Endpoint 定义

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

GET /v2/logs/JOB_ID
Headers:
Access-Token: API_KEY
Host: api2.branch.io
POST /v3/logs/advertisers/ADVERTISER_ID/exports/
Host: api.mobileapptracking.com/

GET /v3/logs/advertisers/ADVERTISER_ID/exports/JOB_ID
Host: api.mobileapptracking.com/

建立导出申请

查找并排列所有符合搜索条件的记录以进行导出;返回将在下载导出请求中使用的 “handle”。

advertiser_id | String

您的 TUNE 广告主 ID;必要项

仅适用于 TUNE 调用

app_id | String

您的 Branch 应用 ID;必要项

仅适用 Branch 调用

organization_id | String

您的 Branch 组织 ID;可选

仅适用 Branch 调用

api_key / access token | String

您的 API Key/访问 Token;必要项

report_type | String

要导出的 Branch EO 主题;必要项

start_date | Date

请求结果的开始日期时间,格式为 ISO-8601,包括小时,分钟,秒和毫秒。 ; 必要项

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

end_date | Date

要求的结果的结束日期时间,格式为 ISO-8601,包括小时,分钟,秒和毫秒。 ; 必要项

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

timezone | Timezone

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

可选参数;如果未提供,结果会在操作后台 (Dashboard)时区中返回。仅在未设置操作后台 (Dashboard)时区的情况下才会默认为 UTC

filter | Filter

BRANCH CALLS ONLY; 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]

filter_cthulhu | Filter

仅限 TUNE 调用;根据 LogInstalls 模型的字段按字段和 boolean 运算符筛选;必须通过 URI encoded 以及 JSON parsed。有关 Cthulhu 筛选详情,请参阅附录。示例: &filter_cthulhu=%5B%22and%22%2C%5B%22eq%22%2C%22mat_id%22%2C%223bc15517-92d5-4b7f-9837-e9a30d6fb9b8%22%5D%2C%5B%22eq%22%2C%22site_event_id%22%2C1844998705%5D%5D

fields | Comma Separated List

结果中的逗号分隔字段列表。必须项

limit | Integer

限制每个请求返回的项目数。最大允许值为200万。如果需要超过200万条记录,请以较短的时间间隔进行多次请求,以提取 “batches” 中所需的数据;必要项

response_format | Nullable String

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

样品导出要求

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]
            }'
https://api.mobileapptracking.com/v3/logs/advertisers/ADVERTISER_ID/exports/installs?api_key=YOUR_ACCESS_TOKEN_HERE&start_date=2019-01-14T00:00:00&end_date=2019-01-15T00:00:00&timezone=UTC&fields=site.name,site.id,device_ip&limit=100&response_format=csv

样品导出响应

{"handle":"1612dbb3-85ef-49f8-b1c5-5818c163600c","export_job_status_url":"https://api2.branch.io/v2/logs/1612dbb3-85ef-49f8-b1c5-5818c163600c?app_id=123456700098765432"}
{"handle":"0818e641-cd5c-4498-8a17-77152689bb94","export_job_status_url":"http://api.mobileapptracking.com/v3/logs/advertisers/ADVERTISER_ID/exports/0818e641-cd5c-4498-8a17-77152689bb94?api_key=YOUR_ACCESS_TOKEN_HERE","branch_url":"http://tlnk.branch.io/v3/logs/advertisers/ADVERTISER_ID/exports/installs?start_date=2019-01-14T00%3A00%3A00%2B00%3A00&end_date=2019-01-15T00%3A00%3A00%2B00%3A00&fields=site.name%2Csite.id%2Cdevice_ip&filter_cthulhu=%5B%22in%22%2C%20%22advertiser_id%22%2C%20ADVERTISER_ID%5D&response_format=csv&timezone=UTC&limit=100&api_key=YOUR_ACCESS_TOKEN_HERE"}

构建下载导出请求

查找并导出请求的队列(按 handle 排列),并提供 URL 位置以供下载。

advertiser_id | String

您的 TUNE 广告主 ID;仅适用于 TUNE CALLS

api_key / access token | String

您的 API Key/访问 Token;必要项

handle | String

日志导出队列返回的 ID。必要项

样本下载导出请求

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>"
http://api.mobileapptracking.com/v3/logs/advertisers/ADVERTISER_ID/exports/0818e641-cd5c-4498-8a17-77152689bb94?api_key=YOUR_ACCESS_TOKEN_HERE

样本下载导出响应

{"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"}
{"report_schedule_id": null, "lines_exported": null, "context": "", "url": "https://branch-exports-web.s3.amazonaws.com/ADVERTISER_ID-installs-2019-01-14-2019-01-15-0818e641-cd5c-4498-8a17-77152689bb94-wxGQxyHo0Djw2ktt.csv?Signature=5XN9MRMftyQ1XafNSTW4STMpT9U%3D&AWSAccessKeyId=AKIAI7A6NRHGMRDK2LIQ&Expires=1548295211", "percent_complete": 100, "status": "complete", "branch_url": "http://tlnk.branch.io/v3/logs/advertisers/ADVERTISER_ID/exports/0818e641-cd5c-4498-8a17-77152689bb94?api_key=YOUR_ACCESS_TOKEN_HERE"}

附录

Branch 可用主题

主题

可读名称

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

Commerce Events

eo_content_event

Content Events

eo_branch_cta_view

CTA Views

eo_custom_event

Custom Events

eo_impression

Impressions

eo_install

Installs

eo_open

Opens

eo_pageview

Pageviews

webhook2

Postback Records

eo_reinstall

Reinstalls

skadnetwork_invalid_messages

SKAdNetwork Invalid Messages

skadnetwork_valid_messages

SKAdNetwork Valid Messages

eo_sms_sent

SMS Sent

eo_user_lifecycle_event

User Lifecycle Events

eo_web_session_start

Web Session Starts

eo_web_to_app_auto_redirect

Web To App Auto Redirects

🚧

被屏蔽的主题

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

TUNE 可用主题

  • Clicks
  • 事件项目
  • 事件
  • Impressions(展示)
  • Installs
  • Open

Branch 可用的 EO 字段

Branch 可用字段

app_id | Long

App ID (capitalize ID in Liveview)

app_name | String

App Name

attributed | Boolean

Attributed

content_items | ArrayStruct

Content Items

custom_data | MapStringString

Custom Data

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 }

Ad Type

event_data_affiliation | String

Affiliation

event_data_coupon | String

Coupon

event_data_currency | String

Currency

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

Transaction ID

event_timestamp | Long

Event Timestamp

existing_user | Boolean

Existing User

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_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

Ad Set Name

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

Ad Partner

last_attributed_touch_data_tilde_agency | String

Agency

last_attributed_touch_data_tilde_agency_id | String

Agency 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

Campaign Type

last_attributed_touch_data_tilde_channel | String

Channel

last_attributed_touch_data_tilde_creative_name | String

Creative Name

last_attributed_touch_data_tilde_creative_id | String

Creative 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

Feature

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

Keyword ID

last_attributed_touch_data_tilde_optimization_model | String

Optimization Model

last_attributed_touch_data_tilde_placement | String

Placement

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

Stage

last_attributed_touch_data_tilde_sub_site_name | String

Sub Site Name

last_attributed_touch_data_tilde_tags | ArrayString

Tags

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_tune_publisher_id | Long

TUNE Publisher ID

last_attributed_touch_data_tilde_tune_publisher_name | String

TUNE Publisher Name

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)

minutes_from_last_attributed_touch_to_event | Integer

Minutes From Last Attributed Touch To Event

name | String

Name of event based on selected topic

organization_id | Long

Organization ID

organization_name | String

Organization Name

origin | String

Origin

reengagement_activity_attributed | Boolean

Reengagement Activity Attributed

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)

tune_site_event_id | Long

TUNE Site Event ID

tune_site_id | Long

TUNE Site ID

tune_site_name | String

TUNE Site Name

user_data_aaid | String

AAID

user_data_android_id | String

Android ID

user_data_app_package_name | String

App Package Name

user_data_app_version | String

App Version

user_data_brand | String

Brand

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

Device Type

user_data_environment | String

Environment

user_data_geo_city_code | Integer

City Code

user_data_geo_city_en | Integer

City

user_data_geo_country_code | String

Country Code

user_data_geo_country_en | String

Country

user_data_geo_dma_code | Integer

DMA Code

user_data_geo_lat | Float

Latitude

user_data_geo_lon | Float

Longitude

user_data_geo_postal_code | String

Postal Code

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

user_data_internet_connection_type | String

Internet Connection Type

user_data_ip | String

IP Address

user_data_is_jailbroken | Boolean

IIs Jailbroken

user_data_kindle_id | String

Kindle ID

user_data_language | String

Language

user_data_limit_ad_tracking | Boolean

Limit Ad Tracking

user_data_model | String

Model

user_data_os | String

OS

user_data_os_version | String

OS Version

user_data_os_version_android | String

OS Version (Android)

user_data_past_cross_platform_ids | ArrayString

Past Cross Platforms IDs

user_data_platform | ArrayString

Platform

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 Version

user_data_tune_mat_id | String

TUNE MAT ID

user_data_user_agent | String

User Agent

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

Branch 可用的 SKAdNetwork 消息字段

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 | integer

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 | integer

Body Conversion Value

body_fidelity_type | integer

Body Fidelity Type

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

🚧

知识产权差异

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

TUNE 可用字段

🚧

知识产权差异

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

🚧

停用字段

有些字段对我们的客户来说价值非常有限,因此已经停用。通过 Custom Export API将无法使用停用的字段。如果您有任何疑问或疑虑,请与您的客户成功经理或我们的支持团队合作。

📘

注意事项

Branch 不支持导出不常用的更新以及回传 TUNE 主题。

ad_network_id

广告平台 ID

ad_network_name

广告平台名称

advertiser_id

广告主 ID

advertiser_name

广告主名称

advertiser_opt_out

广告主退出选择

advertiser_ref_id

广告主参考 ID

advertiser_sub_ad_name

我的广告名称

advertiser_sub_ad_ref

我的广告参考

advertiser_sub_adgroup_name

我的广告组名称

advertiser_sub_adgroup_ref

我的广告组参考

advertiser_sub_campaign_name

我的 Campaign 名称

advertiser_sub_campaign_ref

我的 Campaign 参考

advertiser_sub_keyword_name

我的关键字名称

advertiser_sub_keyword_ref

我的关键字参考

advertiser_sub_placement_name

我的 Placement 名称

advertiser_sub_placement_ref

我的 Placement 参考

advertiser_sub_publisher_name

我的发行商名称

advertiser_sub_publisher_ref

我的发行商参考

advertiser_sub_site_name

我的网站名称

advertiser_sub_site_ref

我的网站参考

agency_id

代理商 ID

agency_name

代理商名称

app_version

App 版本

attribute_sub1

Attribute Sub1

attribute_sub2

Attribute Sub2

attribute_sub3

Attribute Sub3

attribute_sub4

Attribute Sub4

attribute_sub5

Attribute Sub5

branch_app_id

Branch App ID

click_created

点击已创建

country_code

国家代码

country_name

国家名称

created

Created

currency_code

货币代码

device_brand

设备品牌

device_carrier

设备载体

device_ip

设备 IP

device_model

设备型号

device_type

设备类型

download_date

下载日期

event_type

事件类型

existing_user

现有用户

google_ad_tracking

Google 广告追踪已启用

google_aid

Google Advertising ID

id

ID

impression_created

展示已创建

install_created

安装已创建

install_date

安装日期

install_publisher_name

安装发行商名称

ios_ad_tracking

启用 iOS 广告追踪

ios_ifa

iOS IDFA

ios_ifv

iOS IDFV

ip

IP

is_view_through

Is View Through

language

语言

latitude

纬度

longitude

经度

mat_id

Mat ID

metro_code

Metro Code

os_id

OS ID

os_jailbroke

越狱

os_version

操作系统版本

package_name

包名

platform_aid

平台辅助

postal_code

邮政编码

publisher_adgroup_id

发行商广告组 ID

publisher_id

发行商 ID

publisher_name

发行商名称

publisher_ref_id

发行商参考编号

publisher_sub_ad_id

发行商子广告 ID

publisher_sub_ad_name

发行商子广告名称

publisher_sub_ad_ref

发行商子广告参考

publisher_sub_adgroup_name

发行商子广告组名称

publisher_sub_adgroup_ref

发行商子广告组参考

publisher_sub_campaign_id

发行商子 Campaign ID

publisher_sub_campaign_name

发行商子 Campaign 名称

publisher_sub_campaign_ref

发行商子 Campaign 参考

publisher_sub_channel

发行商子渠道

publisher_sub_feature

发行商子功能

publisher_sub_keyword_id

发行商子关键字 ID

publisher_sub_keyword_name

发行商子关键字名称

publisher_sub_keyword_ref

发行商子关键字参考

publisher_sub_placement_id

发行商子 Placement ID

publisher_sub_placement_name

发行商子 Placement 名称

publisher_sub_placement_ref

发行商子 Placement 参考

publisher_sub_publisher_id

发行商子发行 ID

publisher_sub_publisher_name

发行商子发行名称

publisher_sub_publisher_ref

发行商子发行参考

publisher_sub_site_name

发行商子网址名称

publisher_sub1

发行商 Sub1

publisher_sub2

发行商 Sub2

publisher_sub3

发行商 Sub3

publisher_sub4

发行商 Sub4

publisher_sub5

发行商 Sub5

publisher_sub_stage

发行商子 Stage

publisher_sub_tags

发行商子标签

region_name

地区名称

revenue

Revenue

revenue_usd

收入(美元)

sdk

SDK

sdk_version

SDK 版本

search_string

搜索 String

session_datetime

会话 Datetime

site_event_id

网址事件 ID

site_event_name

网址事件名称

site_event_type

网址事件类型

site_id

网址 ID

site_name

网址名称

stat_click_id

点击 ID

stat_impression_id

展示 ID

transaction_id

交易 ID

user_agent

用户代理

user_id

用户 ID

windows_aid

Windows 广告 ID

wurfl_brand_name

品牌名称

wurfl_device_os

设备操作系统

wurfl_device_os_version

设备操作系统版本

wurfl_model_name

型号名称

字段值变更

导出以下字段时,您会注意到 TUNE 提供的值与 Branch 提供的值之间存在差异。

  • 国家名称
    • TUNE:韩国
    • Branch:韩国
  • 地区名称
    • TUNE:首尔 teugbyeoisi
    • Branch:首尔
  • 城市代码
    • TUNE:2261(首尔)
    • Branch:1835848(首尔)
  • 语言
    • Tune:ko,ko-KR,en-KR
    • Branch:KO

包括相关数据对象中的字段

相关对象不再使用 period.来访问对象的属性。字段名称将仅使用下划线_

例如, site_event.id现在将导出为site_event_id

Cthulhu 筛选说明

Cthulhu 是用 JSON 编写的前缀表示法语法,用于指定记录(通常是基于列的记录)上的筛选项。

目的
轻松解析成抽象语法树。

词汇表
any —任何有效的 json 基本类型(数字,string)
... —列表中的上一项可以重复多次

名称

说明

例如

SQL 等同

eq

["eq",<column:string>,
<value:any>]

["eq","x", 1]

x= 1

gt

["gt",<column:string>,
<value:any>]

["gt","x", 1]

x> 1

gte

["gte",<column:string>,
<value:any>]

["gte","x", 1]

x >= 1

lt

["lt",<column:string>,
<value:any>]

["lt","x", 1]

x< 1

lte

["lte",<column:string>,
<value:any>]

["lte","x", 1]

x <= 1

like

["like",<column:string>,
<value:regex>]

["like", "x", ". *foobar"]

x LIKE "%
foobar"

between

["between",<column:string>,
<lower:any>,
<upper:any>]

["between", "x",1, 2]

x
BETWEEN
1 AND 2

x >= 1 AND x <= 2

In

["in", <column: string>, <value: any>, ...]

["in","x", 1,2, 3]

x IN (1,2,3)

and

["and", , ...]

["and",["gt","x", 1],["lt","x", 2]]

x> 1 AND x < 2

or

["or", , ...]

["or",["eq","x", 1],["eq",
"x", 2]]

x = 1 OR x= 2

not

["not",]

["not",["eq","x", 1]]

x != 1

array_contains

["array_contains", ]

["array_contains","last_attributed_touch_data_tilde_tags","Share"]

array_contains(array(1, 2, 3), 2)

15 天前更新


自定义导出和 API


建议的编辑仅限于 API 参考页

您只能建议对 Markdown 正文内容进行修改,而不能建议对 API 说明进行修改。


筛选项