深度链接API

创建深层链接URL

端点-建立

POST /v1/url
Content-Type: application/json

参数-创建

Key
需要

branch_key

原始应用程序的分支密钥;从您的分支机构设置仪表板

数据

嵌入链接的字典。可从SDK作为会话或安装参数访问。 使用数据字典中的所有链路控制参数,你'会在这里找到。

可选的

别名

您可以指定链接bnc.lt/devonaustin的别名,而不是我们的标准编码短URL。别名被强制为每个域(bnc.lt,yourapp.com等)唯一。请注意,链接别名是唯一 ,是不能删除的不可变对象。

最多128个字符

注意:如果您使用相同的别名POST到该终结点,并且将一组其他POST参数匹配到现有的别名链接,则原始文档将返回给您。如果发生冲突并且您未指定' t匹配项,则将返回HTTP 409错误。

类型

  • 将type设置为1,以使URL成为一次性使用URL。 1次成功的深层链接后,它赢得了'吨深层链接。

  • 将type设置为2以创建Marketing URL。这些是显示在仪表板上“市场营销”选项卡下的URL(还要设置链接的市场营销标题,该标题显示在“市场营销”选项卡中,请将“ 数据字典中的“ $ marketing_title 字段设置为您要想)。

  • 默认值设置为0,这是通过我们的SDK.git创建的标准分支链接

可选的

持续时间

片刻之间。仅在要覆盖深层链接匹配的持续时间时才设置此键。这是Branch允许点击保持出色并有资格与新的应用会话匹配的时间。默认设置为7200(2小时)

可选的

它'重要,这样的数据出现一致和易读的仪表板来标记分析标签的有组织结构中的链接。

可选的

身份

用于标识用户的身份。如果链接是不依赖于身份,有'没有必要指定标识。

最多127个字符

可选的

样品申请-创建

curl -XPOST https://api2.branch.io/v1/url -H "Content-Type: application/json" \
  -d '{
  "branch_key": "key_live_kaFuWw8WvY7yn1d9yYiP8gokwqjV0Swt",
  "channel": "facebook",
  "feature": "onboarding",
  "campaign": "new product",
  "stage": "new user",
  "tags": ["one", "two", "three"],
  "data": {
    "$canonical_identifier": "content/123",
    "$og_title": "Title from Deep Link",
    "$og_description": "Description from Deep Link",
    "$og_image_url": "http://www.lorempixel.com/400/400/",
    "$desktop_url": "http://www.example.com",
    "custom_boolean": true,
    "custom_integer": 1243,
    "custom_string": "everything",
    "custom_array": [1,2,3,4,5,6],
    "custom_object": { "random": "dictionary" }
  }
}'

样本响应-创建

{
  "url": "https://example.app.link/WgiqvsepqF"
}

批量创建深层链接网址

有关如何创建链接的更多详细信息,请参见分支链接创建指南

端点-批量创建

POST /v1/url/bulk/:branch_key
Content-Type: application/json

参数-批量创建

创建深层链接URL的参数的json数组。

注意:请求有效负载大小限制为100KB

Key
需要

branch_key

原始应用程序的分支密钥;从您的分支机构设置仪表板

您可以'随意将自己的任何键值参数添加到“分支”链接。这些参数将通过Branch SDK传递到您的应用

可选的

样品申请-批量创建

curl -XPOST https://api2.branch.io/v1/url/bulk/key_live_kaFuWw8WvY7yn1d9yYiP8gokwqjV0Swt -H "Content-Type: application/json" \
  -d '[
    {
      "channel": "facebook",
      "feature": "onboarding",
      "campaign": "new product",
      "stage": "new user",
      "tags": ["one", "two", "three"],
      "data": {
        "$canonical_identifier": "content/123",
        "$og_title": "Title from Deep Link",
        "$og_description": "Description from Deep Link",
        "$og_image_url": "http://www.lorempixel.com/400/400/",
        "$desktop_url": "http://www.example.com",
        "custom_boolean": true,
        "custom_integer": 1243,
        "custom_string": "everything",
        "custom_array": [1,2,3,4,5,6],
        "custom_object": { "random": "dictionary" }
      }
    },
    {
      "channel": "facebook",
      "feature": "onboarding",
      "campaign": "new product",
      "stage": "new user",
      "tags": ["one", "two", "three"],
      "data": {
        "$canonical_identifier": "content/123",
        "$og_title": "Title from Deep Link",
        "$og_description": "Description from Deep Link",
        "$og_image_url": "http://www.lorempixel.com/400/400/",
        "$desktop_url": "http://www.example.com"
      }
    }
  ]'

样本响应-批量创建

如果参数无效,则为深层链接网址和/或错误的数组。

[
  {
    "url": "https://example.app.link/0AjuiLcpqF"
  },
  {
    "url": "https://example.app.link/5IULiLcpqF"
  },
  { 
    'error': 'error message'
  }
]

删除现有链接

在测试环境中不可用

端点-删除

DELETE /v1/url
Content-Type: application/json

参数-删除

Key
需要

access_key

您的API密钥/访问令牌;了解如何检索您的API密钥 (又名访问令牌)

样品申请-删除

curl -X DELETE \
'https://api2.branch.io/v1/url?url=https://example.app.link/ABCD&app_id=YOUR_APP_ID' \
  -H "Access-Token: YOUR_ACCESS_TOKEN" 

样本回复-删除

{
  "url": "https://example.app.link/ABCD",
  "deleted": true
}

阅读现有的深层链接

返回深层链接属性

端点-读取

GET /v1/url
Content-Type: application/json

参数-读取

Key
需要

branch_key

原始应用程序的分支密钥;从您的分支机构设置仪表板

网址

您要阅读的深层链接网址。

样品申请-阅读

curl -XGET 'https://api2.branch.io/v1/url?url=https://example.app.link/WgiqvsepqF&branch_key=key_live_kaFuWw8WvY7yn1d9yYiP8gokwqjV0Swt'

样本响应-阅读

{
  "campaign": "new product",
  "channel": "facebook",
  "feature": "onboarding",
  "stage": "new user",
  "tags": [
    "one",
    "two",
    "three"
  ],
  "data": {
    "$canonical_identifier": "content/123",
    "$desktop_url": "http://www.example.com",
    "$og_description": "Description from Deep Link",
    "$og_image_url": "http://www.lorempixel.com/400/400/",
    "$og_title": "Title from Deep Link",
    "$one_time_use": false,
    "custom_array": [
      1,
      2,
      3,
      4,
      5,
      6
    ],
    "custom_boolean": true,
    "custom_integer": 1243,
    "custom_object": {
      "random": "dictionary"
    },
    "custom_string": "everything",
    "~campaign": "new product",
    "~channel": "facebook",
    "~creation_source": 0,
    "~feature": "onboarding",
    "~id": "423196192848102356",
    "~stage": "new user",
    "~tags": [
      "one",
      "two",
      "three"
    ],
    "url": "https://example.app.link/WgiqvsepqF"
  },
  "type": 0,
  "alias": null
}

更新现有的深层链接

端点-更新

PUT /v1/url
Content-Type: application/json

参数-更新

Key
需要

branch_key

原始应用程序的分支密钥;从您的分支机构设置仪表板

branch_secret

分支机密(如果原始应用程序);从您的分支机构设置仪表板

网址

您要更新的深层链接网址。

样品申请-更新

curl -XPUT 'https://api2.branch.io/v1/url?url=https%3A%2F%2Fexample.app.link%2F5IULiLcpqF' -H "Content-Type: application/json" \
  -d '{
  "branch_key": "key_live_kaFuWw8WvY7yn1d9yYiP8gokwqjV0Swt",
  "branch_secret": "secret_live_RrrsLqpzVcoVWf5t4ncQVpzlg2pRpGH9",
  "channel": "twitter",
  "data":{
    "name":"alex",
    "user_id":"12346"
  }
}'

样本响应-更新

{
  "campaign": "new product",
  "channel": "twitter",
  "feature": "onboarding",
  "stage": "new user",
  "tags": [
    "one",
    "two",
    "three"
  ],
  "data": {
    "$one_time_use": false,
    "name": "alex",
    "user_id": "12346",
    "~campaign": "new product",
    "~channel": "twitter",
    "~creation_source": 0,
    "~feature": "onboarding",
    "~id": "423196096467215333",
    "~stage": "new user",
    "~tags": [
      "one",
      "two",
      "three"
    ],
    "url": "https://example.app.link/5IULiLcpqF"
  },
  "type": 0,
  "alias": null
}

链接更新提示

链接' s数据对象被链接更新API完全覆盖,因此请确保在更新链接' s数据时包括所有链接' s数据(而不仅仅是您'更改的数据)

要批量更新链接,请在创建脚本时结合使用链接更新API和链接更新API。下面的示例Python脚本读取一个2列CSV文件,并使用B列中的值更新脚本中为A列中列出的所有链接指定的键:

import requests
import csv
import sys
import urllib
import json

#Insert API key & App Secret from the Branch dashboard, and the Link data key you want to change in each link **
branch_key = "[API_KEY]"
branch_secret = "[APP_SECRET]"
key_to_update = "[DATA_KEY_TO_UPDATE]"

#Insert filename for CSV containing links to update in first column, and values to add in second column **
ifile = open('[INSERT_FILENAME].csv', "rb")

#Constants
branchendpoint = "https://api2.branch.io/v1/url?url="
reader = csv.reader(ifile, delimiter=',')

#Uncomment the next line if you want the script to skip the first line of the CSV
#next(reader)

#Loop through CSV
for row in reader:

  #Retrieve link data for link being updated
  url = urllib.quote_plus(row[0])
  getrequest = branchendpoint + url + "&branch_key=" + branch_key
  linkdata = requests.get(getrequest)
  jsonData = json.loads(linkdata.text)

  #Set credentials for update API
  jsonData["branch_key"] = branch_key
  jsonData["branch_secret"] = branch_secret

  #Update specified data key
  newValue = row[1]
  if key_to_update in jsonData:
    jsonData[key_to_update] = newValue
  if key_to_update in jsonData["data"]:
    jsonData["data"][key_to_update] = newValue

  #PUT request to update link
  payload = json.dumps(jsonData)
  putrequest = branchendpoint + url
  r = requests.put(putrequest, json=jsonData)
  print(r.url)
  print(r)
  print
ifile.close()

限制条件

尝试更新链接时有一些限制:

  • 并非所有链接都是可更新的,即结构为bnc.lt/c/bnc.lt/d/链接
  • 链路的别名不能被更新,例如, ' https://bnc.lt/test ' - > ' https://bnc.lt/test1 '
  • 与分支链接关联的身份无法更新
  • 链接的type 不能更改,例如,营销链接是2,而我们的Branch SDK生成的标准链接是0。
  • 以下其他字段无法更新:
    • app_id
    • identity_id
    • domain
    • state
    • creation_source
    • app_short_identifier

记录商务事件

端点-商业

POST /v2/event/standard
Content-Type: application/json

参数-商业

Key
需要

branch_key

原始应用程序的分支密钥;从您的分支机构设置仪表板

名称

要记录的事件的名称。可以是以下之一:ADD_TO_CART,ADD_TO_WISHLIST,CLICK_AD,VIEW_CART,INITIATE_PURCHASE,ADD_PAYMENT_INFO,PURCHASE,SPEND_CREDITS

customer_event_alias

您定义的事件别名;除了上面定义的事件名称外,还使用。

可选的

user_data.os

之一"的Android " , "的iOS "

user_data.os_version

操作系统的版本。特定于Android和iOS。

可选的

user_data.environment

通常为FULL_APP

可选的

user_data.aaid

Android / Google广告ID。

可选的

user_data.android_id

Android硬件ID

可选的

user_data.idfa

iOS广告ID

可选的

user_data.idfv

iOS供应商ID

可选的

user_data.limit_ad_tracking

如果合作伙伴选择不被广告客户跟踪,则为true

可选的

user_data.user_agent

发生事件的浏览器或应用程序的用户代理。通常与网络视图关联。

可选的

user_data.browser_fingerprint_id

分支内部专用字段,用于跟踪浏览器。

可选的

user_data.http_origin

Web SDK记录的Web会话开始的当前页面URL。

可选的

user_data.http_referrer

引荐网址,该引荐网址指向Web SDK记录Web会话开始的当前页面。

可选的

user_data.developer_identity

开发者为用户指定的身份。

可选的

user_data.country

用户的国家/地区代码,通常基于设备设置或用户代理字符串。

可选的

user_data.language

用户的语言代码,通常基于设备设置或用户代理字符串。

可选的

user_data.local_ip

仅Android :设备的本地IP

可选的

user_data.brand

设备的品牌

可选的

user_data.device_fingerprint_id

分支内部专用字段,用于跟踪设备。

可选的

user_data.app_version

用户下载的应用版本。

可选的

user_data.model

设备的型号。

可选的

user_data.screen_dpi

屏幕' s DPI。

可选的

user_data.screen_height

屏幕高度为' s。

可选的

user_data.screen_width

屏幕'秒的宽度。

可选的

custom_data

应用程序开发人员希望附加到事件的键值对。附加到通过导出检索并通过Webhooks发送的事件。

可选的

event_data.transaction_id

合作伙伴指定的内部使用交易ID

可选的

event_data.revenue

合作伙伴指定的活动报告收入。

可选的

event_data.currency

合作伙伴最初报告收入,价格,运费,税金的货币

可选的

event_data.shipping

与交易相关的运输成本。

可选的

event_data.tax

与交易相关的总税额。

可选的

event_data.coupon

随交易兑换的交易优惠券(例如" SPRING2017 " )

可选的

event_data.affiliation

发生此交易的商店或从属关系(例如Google Store)

可选的

event_data.description

与事件相关的描述,不一定特定于任何单个内容项(请参见下文)

可选的

content_items [i]。$ content_schema

内容的类别/架构。将来可能会用于分析。下列之一:
COMMERCE_AUCTION
COMMERCE_BUSINESS
COMMERCE_OTHER
COMMERCE_PRODUCT
COMMERCE_RESTAURANT
COMMERCE_SERVICE
COMMERCE_TRAVEL_FLIGHT
COMMERCE_TRAVEL_HOTEL
COMMERCE_TRAVEL_OTHER
GAME_STATE
MEDIA_IMAGE
MEDIA_MIXED
MEDIA_MUSIC
MEDIA_OTHER
MEDIA_VIDEO
OTHER
TEXT_ARTICLE
TEXT_BLOG
TEXT_OTHER
TEXT_RECIPE
TEXT_REVIEW
TEXT_SEARCH_RESULTS
TEXT_STORY
TEXT_TECHNICAL_DOC

可选的

content_items [i]。$ og_title

标题(用于单个内容项)。

可选的

content_items [i]。$ og_description

描述(针对单个内容项)。

可选的

content_items [i]。$ og_image_url

图片网址(用于单个内容项)。

可选的

content_items [i]。$ canonical_identifier

用于允许Branch统一Content Analytics的内容/消息

可选的

content_items [i]。$ publicly_indexable

true:任何人都可以看到内容| false :无法索引供公众使用

可选的

content_items [i]。$ locally_indexable

true:可以为本地(设备)使用索引内容| false :无法索引以供本地使用

可选的

content_items [i]。$ price

产品/内容的价格。

可选的

content_items [i]。$ quantity

要订购的商品数量(用于PURCHASE,ADD_TO_CART等)。

可选的

content_items [i]。$ sku

产品sku或产品ID。

可选的

content_items [i]。$ product_name

产品'的名称。

可选的

content_items [i]。$ product_brand

产品' s品牌。

可选的

content_items [i]。$ product_category

产品为'的类别(如果为'产品)。之一:
ANIMALS_AND_PET_SUPPLIES
APPAREL_AND_ACCESSORIES
艺术与娱乐
BABY_AND_TODDLER
BUSINESS_AND_INDUSTRIAL
CAMERAS_AND_OPTICS
ELECTRONICS
FOOD_BEVERAGES_AND_TOBACCO
家具
HARDWARE
HEALTH_AND_BEAUTY
HOME_AND_GARDEN
LUGGAGE_AND_BAGS
成熟
MEDIA
OFFICE_SUPPLIES
RELIGIOUS_AND_CEREMONIAL
SOFTWARE
SPORTING_GOODS
TOYS_AND_GAMES
VEHICLES_AND_PARTS

可选的

content_items [i]。$ product_variant

乘积' s的变体(例如XL,红色)。

可选的

content_items [i]。$ rating_average

该项目的平均评分。

可选的

content_items [i]。$ rating_count

该项目的评分数。

可选的

content_items [i]。$ rating_max

该项目的最高可能评分(例如,如果5星是最高可能评分,则为5.0)。

可选的

content_items [i]。$ creation_timestamp

内容创建的时间。

可选的

content_items [i]。$ exp_date

最后一次,此后该内容不再有效。 null / 0表示没有限制。应该很少设置。

可选的

content_items [i]。$ keywords

关键字

可选的

content_items [i]。$ address_street

餐馆,公司,房间(酒店)等的街道地址。

可选的

content_items [i]。$ address_city

餐馆,公司,房间(酒店)等的街道地址。

可选的

content_items [i]。$ address_region

餐厅,公司,房间(酒店)等的州或地区

可选的

content_items [i]。$ address_country

餐厅,公司,房间(酒店)等的国家/地区代码。

可选的

content_items [i]。$ address_postal_code

餐馆,公司,房间(酒店)等的邮政编码。

可选的

content_items [i]。$ latitude

餐厅,公司,房间(酒店)等的纬度

可选的

content_items [i]。$经度

餐馆,公司,房间(酒店)等的经度

可选的

content_items [i]。$ image_captions

与图像关联的标题。

可选的

content_items [i]。$ condition

对于拍卖,该物品是否是新的,良好的,可以接受的,等等。

其中之一:
其他
新产品
优秀
良好
中等


翻新

可选的

content_items [i]。$ custom_fields

应用程序开发人员想要附加到内容项的键值对。附加到通过导出检索并通过Webhooks发送的事件。

可选的

关于必填标识符的说明

您必须发送(在user_data中):

  1. developer_identity
  2. browser_fingerprint_id
  3. os = iOS AND(idfa OR idfv)
  4. os = Android AND(android_id或aaid)

样品申请-商业

curl -vvv -d '{
  "name": "PURCHASE",
  "customer_event_alias": "my custom alias",
  "user_data": {
    "os": "Android",
    "os_version": 25,
    "environment": "FULL_APP",
    "aaid": "abcdabcd-0123-0123-00f0-000000000000",
    "android_id": "a12300000000",
    "limit_ad_tracking": false,
    "developer_identity": "user123",
    "country": "US",
    "language": "en",
    "local_ip": "192.168.1.2",
    "brand": "LGE",
    "app_version": "1.0.0",
    "model": "Nexus 5X",
    "screen_dpi": 420,
    "screen_height": 1794,
    "screen_width": 1080
  },
  "custom_data": {
    "purchase_loc": "Palo Alto",
    "store_pickup": "unavailable"
  },
  "event_data": {
    "transaction_id": "tras_Id_1232343434",
    "currency": "USD",
    "revenue": 180.2,
    "shipping": 10.5,
    "tax": 13.5,
    "coupon": "promo-1234",
    "affiliation": "high_fi",
    "description": "Preferred purchase"
  },
  "content_items": [
    {
      "$content_schema": "COMMERCE_PRODUCT",
      "$og_title": "Nike Shoe",
      "$og_description": "Start loving your steps",
      "$og_image_url": "http://example.com/img1.jpg",
      "$canonical_identifier": "nike/1234",
      "$publicly_indexable": false,
      "$price": 101.2,
      "$locally_indexable": true,
      "$quantity": 1,
      "$sku": "1101123445",
      "$product_name": "Runner",
      "$product_brand": "Nike",
      "$product_category": "Sporting Goods",
      "$product_variant": "XL",
      "$rating_average": 4.2,
      "$rating_count": 5,
      "$rating_max": 2.2,
      "$creation_timestamp": 1499892854966,
      "$exp_date": 1499892854966,
      "$keywords": [
        "sneakers",
        "shoes"
      ],
      "$address_street": "230 South LaSalle Street",
      "$address_city": "Chicago",
      "$address_region": "IL",
      "$address_country": "US",
      "$address_postal_code": "60604",
      "$latitude": 12.07,
      "$longitude": -97.5,
      "$image_captions": [
        "my_img_caption1",
        "my_img_caption_2"
      ],
      "$condition": "NEW",
      "$custom_fields": "{\"foo1\":\"bar1\",\"foo2\":\"bar2\"}"
    },
    {
      "$og_title": "Nike Woolen Sox",
      "$canonical_identifier": "nike/5324",
      "$og_description": "Fine combed woolen sox for those who love your foot",
      "$publicly_indexable": false,
      "$price": 80.2,
      "$locally_indexable": true,
      "$quantity": 5,
      "$sku": "110112467",
      "$product_name": "Woolen Sox",
      "$product_brand": "Nike",
      "$product_category": "Apparel & Accessories",
      "$product_variant": "Xl",
      "$rating_average": 3.3,
      "$rating_count": 5,
      "$rating_max": 2.8,
      "$creation_timestamp": 1499892854966
    }
  ],
  "metadata": {},
  "branch_key": "key_test_hdcBLUy1xZ1JD0tKg7qrLcgirFmPPVJc"
}' https://api2.branch.io/v2/event/standard

样本响应-商业

{ "branch_view_enabled": true/false }

记录内容事件

端点-内容

POST /v2/event/standard
Content-Type: application/json

参数-内容

Key
需要

branch_key

原始应用程序的分支密钥;从您的分支机构设置仪表板

名称

要记录的事件的名称。可以是以下之一:SEARCH,VIEW_ITEM,VIEW_ITEMS,RATE,SHARE

customer_event_alias

您定义的事件别名;除了上面定义的事件名称外,还使用。

可选的

user_data.os

之一"的Android " , "的iOS "

user_data.os_version

操作系统的版本。特定于Android和iOS。

可选的

user_data.environment

通常为FULL_APP

可选的

user_data.aaid

Android / Google广告ID。

可选的

user_data.android_id

Android硬件ID

可选的

user_data.idfa

iOS广告ID

可选的

user_data.idfv

iOS供应商ID

可选的

user_data.limit_ad_tracking

如果合作伙伴选择不被广告客户跟踪,则为true

可选的

user_data.user_agent

发生事件的浏览器或应用程序的用户代理。通常与网络视图关联。

可选的

user_data.browser_fingerprint_id

分支内部专用字段,用于跟踪浏览器。

可选的

user_data.http_origin

Web SDK记录的Web会话开始的当前页面URL。

可选的

user_data.http_referrer

引荐网址,该引荐网址指向Web SDK记录Web会话开始的当前页面。

可选的

user_data.developer_identity

开发者为用户指定的身份。

可选的

user_data.country

用户的国家/地区代码,通常基于设备设置或用户代理字符串。

可选的

user_data.language

用户的语言代码,通常基于设备设置或用户代理字符串。

可选的

user_data.local_ip

仅Android :设备的本地IP

可选的

user_data.brand

设备的品牌

可选的

user_data.device_fingerprint_id

分支内部专用字段,用于跟踪设备。

可选的

user_data.app_version

用户下载的应用版本。

可选的

user_data.model

设备的型号。

可选的

user_data.screen_dpi

屏幕' s DPI。

可选的

user_data.screen_height

屏幕高度为' s。

可选的

user_data.screen_width

屏幕'秒的宽度。

可选的

custom_data

应用程序开发人员希望附加到事件的键值对。附加到通过导出检索并通过Webhooks发送的事件。

可选的

event_data.transaction_id

合作伙伴指定的内部使用交易ID

可选的

event_data.revenue

合作伙伴指定的活动报告收入。

可选的

event_data.currency

合作伙伴最初报告收入,价格,运费,税金的货币

可选的

event_data.shipping

与交易相关的运输成本。

可选的

event_data.tax

与交易相关的总税额。

可选的

event_data.coupon

随交易兑换的交易优惠券(例如" SPRING2017 " )

可选的

event_data.affiliation

发生此交易的商店或从属关系(例如Google Store)

可选的

event_data.description

与事件相关的描述,不一定特定于任何单个内容项(请参见下文)

可选的

content_items [i]。$ content_schema

内容的类别/架构。将来可能会用于分析。下列之一:
COMMERCE_AUCTION
COMMERCE_BUSINESS
COMMERCE_OTHER
COMMERCE_PRODUCT
COMMERCE_RESTAURANT
COMMERCE_SERVICE
COMMERCE_TRAVEL_FLIGHT
COMMERCE_TRAVEL_HOTEL
COMMERCE_TRAVEL_OTHER
GAME_STATE
MEDIA_IMAGE
MEDIA_MIXED
MEDIA_MUSIC
MEDIA_OTHER
MEDIA_VIDEO
OTHER
TEXT_ARTICLE
TEXT_BLOG
TEXT_OTHER
TEXT_RECIPE
TEXT_REVIEW
TEXT_SEARCH_RESULTS
TEXT_STORY
TEXT_TECHNICAL_DOC

可选的

content_items [i]。$ og_title

标题(用于单个内容项)。

可选的

content_items [i]。$ og_description

描述(针对单个内容项)。

可选的

content_items [i]。$ og_image_url

图片网址(用于单个内容项)。

可选的

content_items [i]。$ canonical_identifier

用于允许Branch统一Content Analytics的内容/消息

可选的

content_items [i]。$ publicly_indexable

true:任何人都可以看到内容| false :无法索引供公众使用

可选的

content_items [i]。$ locally_indexable

true:可以为本地(设备)使用索引内容| false :无法索引以供本地使用

可选的

content_items [i]。$ price

产品/内容的价格。

可选的

content_items [i]。$ quantity

要订购的商品数量(用于PURCHASE,ADD_TO_CART等)。

可选的

content_items [i]。$ sku

产品sku或产品ID。

可选的

content_items [i]。$ product_name

产品'的名称。

可选的

content_items [i]。$ product_brand

产品' s品牌。

可选的

content_items [i]。$ product_category

产品为'的类别(如果为'产品)。之一:
ANIMALS_AND_PET_SUPPLIES
APPAREL_AND_ACCESSORIES
艺术与娱乐
BABY_AND_TODDLER
BUSINESS_AND_INDUSTRIAL
CAMERAS_AND_OPTICS
ELECTRONICS
FOOD_BEVERAGES_AND_TOBACCO
家具
HARDWARE
HEALTH_AND_BEAUTY
HOME_AND_GARDEN
LUGGAGE_AND_BAGS
成熟
MEDIA
OFFICE_SUPPLIES
RELIGIOUS_AND_CEREMONIAL
SOFTWARE
SPORTING_GOODS
TOYS_AND_GAMES
VEHICLES_AND_PARTS

可选的

content_items [i]。$ product_variant

乘积' s的变体(例如XL,红色)。

可选的

content_items [i]。$ rating_average

该项目的平均评分。

可选的

content_items [i]。$ rating_count

该项目的评分数。

可选的

content_items [i]。$ rating_max

该项目的最高可能评分(例如,如果5星是最高可能评分,则为5.0)。

可选的

content_items [i]。$ creation_timestamp

内容创建的时间。

可选的

content_items [i]。$ exp_date

最后一次,此后该内容不再有效。 null / 0表示没有限制。应该很少设置。

可选的

content_items [i]。$ keywords

关键字

可选的

content_items [i]。$ address_street

餐馆,公司,房间(酒店)等的街道地址。

可选的

content_items [i]。$ address_city

餐馆,公司,房间(酒店)等的街道地址。

可选的

content_items [i]。$ address_region

餐厅,公司,房间(酒店)等的州或地区

可选的

content_items [i]。$ address_country

餐厅,公司,房间(酒店)等的国家/地区代码。

可选的

content_items [i]。$ address_postal_code

餐馆,公司,房间(酒店)等的邮政编码。

可选的

content_items [i]。$ latitude

餐厅,公司,房间(酒店)等的纬度

可选的

content_items [i]。$经度

餐馆,公司,房间(酒店)等的经度

可选的

content_items [i]。$ image_captions

与图像关联的标题。

可选的

content_items [i]。$ condition

对于拍卖,该物品是否是新的,良好的,可以接受的,等等。

其中之一:
其他
新产品
优秀
良好
中等


翻新

可选的

content_items [i]。$ custom_fields

应用程序开发人员想要附加到内容项的键值对。附加到通过导出检索并通过Webhooks发送的事件。

可选的

关于必填标识符的说明

您必须发送(在user_data中):

  1. developer_identity
  2. browser_fingerprint_id
  3. os = iOS AND(idfa OR idfv)
  4. os = Android AND(android_id或aaid)

样品申请-内容

curl -vvv -d '{
  "name": "VIEW_ITEMS",
  "customer_event_alias": "my custom alias",
  "user_data": {
    "os": "Android",
    "os_version": 25,
    "environment": "FULL_APP",
    "aaid": "abcdabcd-0123-0123-00f0-000000000000",
    "android_id": "a12300000000",
    "limit_ad_tracking": false,
    "developer_identity": "user123",
    "country": "US",
    "language": "en",
    "local_ip": "192.168.1.2",
    "brand": "LGE",
    "app_version": "1.0.0",
    "model": "Nexus 5X",
    "screen_dpi": 420,
    "screen_height": 1794,
    "screen_width": 1080
  },
  "custom_data": {
    "purchase_loc": "Palo Alto",
    "store_pickup": "unavailable"
  },
  "event_data": {
    "search_query": "red sneakers",
    "description": "Preferred purchase"
  },
  "content_items": [
    {
      "$content_schema": "COMMERCE_PRODUCT",
      "$og_title": "Nike Shoe",
      "$og_description": "Start loving your steps",
      "$og_image_url": "http://example.com/img1.jpg",
      "$canonical_identifier": "nike/1234",
      "$publicly_indexable": false,
      "$price": 101.2,
      "$locally_indexable": true,
      "$sku": "1101123445",
      "$product_name": "Runner",
      "$product_brand": "Nike",
      "$product_category": "Sporting Goods",
      "$product_variant": "XL",
      "$rating_average": 4.2,
      "$rating_count": 5,
      "$rating_max": 2.2,
      "$creation_timestamp": 1499892854966,
      "$exp_date": 1499892854966,
      "$keywords": [
        "sneakers",
        "shoes"
      ],
      "$address_street": "230 South LaSalle Street",
      "$address_city": "Chicago",
      "$address_region": "IL",
      "$address_country": "US",
      "$address_postal_code": "60604",
      "$latitude": 12.07,
      "$longitude": -97.5,
      "$image_captions": [
        "my_img_caption1",
        "my_img_caption_2"
      ],
      "$condition": "NEW",
      "$custom_fields": "{\"foo1\":\"bar1\",\"foo2\":\"bar2\"}"
    },
    {
      "$og_title": "Nike Woolen Sox",
      "$canonical_identifier": "nike/5324",
      "$og_description": "Fine combed woolen sox for those who love your foot",
      "$publicly_indexable": false,
      "$price": 80.2,
      "$locally_indexable": true,
      "$sku": "110112467",
      "$product_name": "Woolen Sox",
      "$product_brand": "Nike",
      "$product_category": "Apparel & Accessories",
      "$product_variant": "Xl",
      "$rating_average": 3.3,
      "$rating_count": 5,
      "$rating_max": 2.8,
      "$creation_timestamp": 1499892854966
    }
  ],
  "metadata": {},
  "branch_key": "key_test_hdcBLUy1xZ1JD0tKg7qrLcgirFmPPVJc"
}' https://api.branch.io/v2/event/standard

样本回复-内容

{ "branch_view_enabled": true/false }

记录用户生命周期事件

端点-生命周期

 POST /v2/event/standard
 Content-Type: application/json

参数-生命周期

Key
需要

branch_key

原始应用程序的分支密钥;从您的分支机构设置仪表板

名称

要记录的事件的名称。可以是以下之一:ADD_TO_CART,ADD_TO_WISHLIST,CLICK_AD,VIEW_CART,INITIATE_PURCHASE,ADD_PAYMENT_INFO,PURCHASE,SPEND_CREDITS

user_data.os

之一"的Android " , "的iOS "

user_data.os_version

操作系统的版本。特定于Android和iOS。

可选的

user_data.environment

通常为FULL_APP

可选的

user_data.aaid

Android / Google广告ID。

可选的

user_data.android_id

Android硬件ID

可选的

user_data.idfa

iOS广告ID

可选的

user_data.idfv

iOS供应商ID

可选的

user_data.limit_ad_tracking

如果合作伙伴选择不被广告客户跟踪,则为true

可选的

user_data.user_agent

发生事件的浏览器或应用程序的用户代理。通常与网络视图关联。

可选的

user_data.browser_fingerprint_id

分支内部专用字段,用于跟踪浏览器。

可选的

user_data.http_origin

Web SDK记录的Web会话开始的当前页面URL。

可选的

user_data.http_referrer

引荐网址,该引荐网址指向Web SDK记录Web会话开始的当前页面。

可选的

user_data.developer_identity

开发者为用户指定的身份。

可选的

user_data.country

用户的国家/地区代码,通常基于设备设置或用户代理字符串。

可选的

user_data.language

用户的语言代码,通常基于设备设置或用户代理字符串。

可选的

user_data.local_ip

仅Android :设备的本地IP

可选的

user_data.brand

设备的品牌

可选的

user_data.device_fingerprint_id

分支内部专用字段,用于跟踪设备。

可选的

user_data.app_version

用户下载的应用版本。

可选的

user_data.model

设备的型号。

可选的

user_data.screen_dpi

屏幕' s DPI。

可选的

user_data.screen_height

屏幕高度为' s。

可选的

user_data.screen_width

屏幕'秒的宽度。

可选的

custom_data

应用程序开发人员希望附加到事件的键值对。附加到通过导出检索并通过Webhooks发送的事件。

可选的

event_data.description

与事件关联的描述。

可选的

关于必填标识符的说明

您必须发送(在user_data中):

  1. developer_identity
  2. browser_fingerprint_id
  3. os = iOS AND(idfa OR idfv)
  4. os = Android AND(android_id或aaid)

样品申请-生命周期

curl -vvv -d '{
  "name": "COMPLETE_REGISTRATION",
  "user_data": {
    "os": "Android",
    "os_version": 25,
    "environment": "FULL_APP",
    "aaid": "abcdabcd-0123-0123-00f0-000000000000",
    "android_id": "a12300000000",
    "limit_ad_tracking": false,
    "developer_identity": "user123",
    "country": "US",
    "language": "en",
    "local_ip": "192.168.1.2",
    "brand": "LGE",
    "app_version": "1.0.0",
    "model": "Nexus 5X",
    "screen_dpi": 420,
    "screen_height": 1794,
    "screen_width": 1080
  },
  "custom_data": {
    "foo": "bar"
  },
  "event_data": {
    "description": "Preferred purchase"
  },
  "metadata": {},
  "branch_key": "key_test_hdcBLUy1xZ1JD0tKg7qrLcgirFmPPVJc"
}' https://api.branch.io/v2/event/standard

样本响应-生命周期

{ "branch_view_enabled": true/false }

记录自定义事件

端点-自定义

POST /v2/event/custom
Content-Type: application/json

参数-自定义

Key
需要

branch_key

原始应用程序的分支密钥;从您的分支机构设置仪表板

名称

要记录的事件的名称。可以是以下之一:ADD_TO_CART,ADD_TO_WISHLIST,CLICK_AD,VIEW_CART,INITIATE_PURCHASE,ADD_PAYMENT_INFO,PURCHASE,SPEND_CREDITS

user_data.os

之一"的Android " , "的iOS "

user_data.os_version

操作系统的版本。特定于Android和iOS。

可选的

user_data.environment

通常为FULL_APP

可选的

user_data.aaid

Android / Google广告ID。

可选的

user_data.android_id

Android硬件ID

可选的

user_data.idfa

iOS广告ID

可选的

user_data.idfv

iOS供应商ID

可选的

user_data.limit_ad_tracking

如果合作伙伴选择不被广告客户跟踪,则为true

可选的

user_data.user_agent

发生事件的浏览器或应用程序的用户代理。通常与网络视图关联。

可选的

user_data.browser_fingerprint_id

分支内部专用字段,用于跟踪浏览器。

可选的

user_data.http_origin

Web SDK记录的Web会话开始的当前页面URL。

可选的

user_data.http_referrer

引荐网址,该引荐网址指向Web SDK记录Web会话开始的当前页面。

可选的

user_data.developer_identity

开发者为用户指定的身份。

可选的

user_data.country

用户的国家/地区代码,通常基于设备设置或用户代理字符串。

可选的

user_data.language

用户的语言代码,通常基于设备设置或用户代理字符串。

可选的

user_data.local_ip

仅Android :设备的本地IP

可选的

user_data.brand

设备的品牌

可选的

user_data.device_fingerprint_id

分支内部专用字段,用于跟踪设备。

可选的

user_data.app_version

用户下载的应用版本。

可选的

user_data.model

设备的型号。

可选的

user_data.screen_dpi

屏幕' s DPI。

可选的

user_data.screen_height

屏幕高度为' s。

可选的

user_data.screen_width

屏幕'秒的宽度。

可选的

custom_data

应用程序开发人员希望附加到事件的键值对。附加到通过导出检索并通过Webhooks发送的事件。

可选的

关于必填标识符的说明

您必须发送(在user_data中):

  1. developer_identity
  2. browser_fingerprint_id
  3. os = iOS AND(idfa OR idfv)
  4. os = Android AND(android_id或aaid)

样品申请-定制

curl -vvv -d '{
  "name": "picture swiped",
  "customer_event_alias": "my custom alias",
  "user_data": {
    "os": "Android",
    "os_version": 25,
    "environment": "FULL_APP",
    "aaid": "abcdabcd-0123-0123-00f0-000000000000",
    "android_id": "a12300000000",
    "limit_ad_tracking": false,
    "developer_identity": "user123",
    "country": "US",
    "language": "en",
    "local_ip": "192.168.1.2",
    "brand": "LGE",
    "app_version": "1.0.0",
    "model": "Nexus 5X",
    "screen_dpi": 420,
    "screen_height": 1794,
    "screen_width": 1080
  },
  "custom_data": {
    "foo": "bar"
  },
  "metadata": {},
  "branch_key": "key_test_hdcBLUy1xZ1JD0tKg7qrLcgirFmPPVJc"
}' https://api.branch.io/v2/event/custom

样本响应-自定义

{ "branch_view_enabled": true/false }

获取当前分支应用程序配置

端点-获取应用配置

GET /v1/app/[branch key]?branch_secret=[branch secret]

参数-获取应用配置

Key
需要

branch_key

原始应用程序的分支密钥;从您的分支机构设置仪表板

branch_secret

分支机密(如果原始应用程序);从您的分支机构设置仪表板

返回-获取应用配置

{
    branch_key: "the app key",
    branch_secret: "the app secret",
    creation_date : "date app was created",

    app_name: "name of the app",

    dev_name: "main contact name",
    dev_email: "main contact email",
    dev_phone_number: "main contact phone",

    android_app: "whether an Android app is enabled",
    android_url: "url of Android store, or namespace (com.android.myapp)",
    android_uri_scheme: "the Android URI scheme",
    android_package_name: "the Android package name",
    sha256_cert_fingerprints: "the SHA256 fingerprints for App Links",
    android_app_links_enabled: "whether App Links are enabled",

    ios_app: "whether an iOS app is enabled",
    ios_url: "url of iOS store, or app id (id512451233)",
    ios_uri_scheme:  "the iOS URI scheme",
    ios_store_country: "the country code of the app, default to US",
    ios_bundle_id: "the iOS bundle ID",
    ios_team_id: "the iOS Team ID",
    universal_linking_enabled: "whether Universal Links are enabled",

    fire_url: "the redirect on Fire phones",
    windows_phone_url: "the redirect on Windows phones",
    blackberry_url: "The redirect on Blackberry phones",
    web_url: "backup website if URLs are null",
    default_desktop_url: "the default desktop redirect, or null if set to hosted SMS",

    short_url_domain: "white labeled domain for short links",

    text_message: "text message to use, {{ link }} will be replaced with short link",

    og_app_id: "optional default Open Graph (OG) app id",
    og_title: "optional default OG title",
    og_image_url: "optional default OG image URL",
    og_description: "optional default OG description",
    
    deepview_desktop: "the current deepview selected for the desktop platform",
    deepview_ios: "the current deepview selected for the iOS platform",
    deepview_android: "the current deepview selected for the Android platform",
  }

更新分支应用程序配置

端点-更新应用程序配置

PUT /v1/app/:branch_key
Content-Type: application/json

参数-更新应用程序配置

Key
需要

branch_secret

分支机密(如果原始应用程序);从您的分支机构设置仪表板

app_name

应用程序的名称(最多255个字符)。

可选的

dev_name

主要联系人开发者姓名(最多255个字符)。

可选的

dev_email

主要联系人开发者电子邮件(最多255个字符)。

可选的

android_url

Android应用商店的网址或包名称(com.android.myapp)。请注意,要改为为Android设置后备网址,还必须将android_app 设置为2

可选的

android_uri_scheme

Android URI方案。

可选的

ios_url

iOS应用商店的URL或应用程序ID(id512451233)

可选的

ios_uri_scheme

iOS URI方案。

可选的

ios_store_country

应用的国家/地区代码,默认为美国(最多255个字符)。

可选的

web_url

如果URL为空,则备份网站。

可选的

text_message

用于文本我功能的文本消息 {link} 将被短链接(最多255个字符)代替。

可选的

og_app_id

默认打开图(OG)应用ID(最多255个字符)。

可选的

og_title

链接使用的默认OG标题(最多255个字符)。

可选的

og_description

用于链接的默认OG描述(最多255个字符)。

可选的

og_image_url

链接使用的默认OG图片网址(最多255个字符)。

可选的

返回-更新应用配置

 {
    branch_key: "the app key",
    branch_secret: "the app secret",
    creation_date : "date app was created",

    app_name: "name of the app",

    dev_name: "main contact name",
    dev_email: "main contact email",
    dev_phone_number: "main contact phone",

    android_url: "url of Android store, or namespace (com.android.myapp)",
    android_uri_scheme: "the Android URI scheme",

    ios_url: "url of iOS store, or app id (id512451233)",
    ios_uri_scheme:  "the iOS URI scheme",
    ios_store_country: "the country code of the app, default to US",

    web_url: "backup website if URLs are null",

    short_url_domain: "white labeled domain for short links",

    text_message: "text message to use, {{ link }} will be replaced with short link",

    og_app_id: "optional default Open Graph (OG) app id",
    og_title: "optional default OG title",
    og_image_url: "optional default OG image URL",
    og_description: "optional default OG description"
  }

更新4 天前

深度链接API


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

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