딥링킹 API

딥링킹(Deep Linking) URL 생성

엔드 포인트 - 생성

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

파라미터 - 생성

파라미터

branch_key | REQUIRED

발신 앱의 Branch 키. Branch 설정 대시보드에 있습니다.

data | Optional

링크와 함께 포함할 사전입니다. SDK에서 세션 또는 설치 파라미터로 액세스합니다. 여기에서 찾을 수 있는 모든 링크 제어 파라미터에 대한 데이터 사전을 사용합니다.

alias | Optional

표준 인코딩된 짧은 URL 대신 가상 별칭을 지정할 수 있습니다. 예를 들어 임의의 문자/정수 string 대신, 가상 별칭을 *.app.link/devonaustin으로 설정할 수 있습니다. 별칭은 unique한 **로 적용되며 도메인 및 링크 당 변경할 수 없습니다 - 이는 삭제하지 않는 한 재사용될 수 없습니다.

최대 128자

참고: 동일한 별명으로 해당 엔드 포인트에 포스트(POST) 하고 기타 포스트(POST) 파라미터 매칭 세트를 기존 별명이 지정된 링크로 포스트(POST) 하면 원본이 반환됩니다. 충돌이 발생하고 매치를 지정하지 않았다면 HTTP 409 오류를 반환합니다.

type | Optional

  • URL을 일회용 URL로 만들려면 type을 1로 설정하십시오. 딥링크(Deep Link)를 1회 성공한 후에는 딥링크(Deep Link)를 하지 않습니다.

  • 유형을 2로 설정하여 마케팅 URL을 만듭니다. 대시보드의 Marketing 탭 아래에 표시되는 URL입니다 (Marketing 탭에 표시되는 링크의 마케팅 제목도 설정하려면 data 사전의 *$marketing_title 필드를 원하는 값으로 설정하십시오).

  • default는 SDK.git를 통해 생성된 표준 Branch 링크인 0으로 설정됩니다.

duration | Optional

초 단위. 딥링크(Deep Link) 매칭에 대한 매치 지속 시간을 재정의하려는 경우에만 해당 키를 설정하십시오. Branch에서 클릭이 미처리 상태를 유지하고 새로운 앱 세션과 매치될 수 있도록 허용하는 시간입니다. 기본값일 때 7200 (2시간)으로 설정되어 있습니다.

Branch analytics parameters | Optional

대시보드에서 데이터가 일관되고 읽기 쉽게 표시되도록 조직적인 분석 레이블 구조로 링크에 태그를 지정하는 것이 중요합니다.

identity | Optional

유저를 식별하는 데 사용되는 ID입니다. 링크가 ID에 연결되어 있지 않으면 ID를 지정할 필요가 없습니다.

최대 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"
}

딥링킹(Deep Linking) URL 대량 생성하기

링크 생성 방법에 대한 자세한 내용은 Branch 링크 생성 가이드를 참조하십시오.

엔드 포인트 - 대량 생성

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

파라미터 - 대량 생성

딥링킹(Deep Linking) URL 생성에서 파라미터의 json 배열.

파라미터

branch_key | REQUIRED

발신 앱의 Branch 키. Branch 설정 대시보드에 있습니다.

Branch Parameters | Optional

Branch 링크에 자신의 key-value 파라미터를 추가할 수 있습니다. 해당 파라미터는 Branch SDK를 통해 앱으로 전달됩니다.

참고: 요청 페이로드 크기에는 100KB의 제한이 있습니다.

샘플 요청 - 대량 생성

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"
      }
    }
  ]'

샘플 응답 - 대량 생성

유효하지 않은 파라미터의 딥링킹(Deep Linking) URL 및/또는 오류 배열입니다.

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

기존 링크 삭제

📘

테스트 환경에서 사용할 수 없음

엔드 포인트 - 삭제

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

파라미터 - 삭제

파라미터

[access_key | REQUIRED

API 키 / 액세스 토큰. API 키 검색 방법을 참고하십시오. (일명 Access Token)

샘플 요청 - 삭제

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
}

기존 딥링크(Deep Link) 읽기

딥링크(Deep Link) 프로퍼티를 반환합니다.

엔드 포인트 - 읽기

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

파라미터 - 읽기

파라미터

branch_key | REQUIRED

발신 앱의 Branch 키. Branch 설정 대시보드에 있습니다.

url | REQUIRED

읽게 할 딥링크(Deep Link) URL.

샘플 요청 - 읽기

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
}

기존 딥링크(Deep Link) 업데이트

엔드 포인트 - 업데이트

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

파라미터 - 업데이트

파라미터

branch_key | REQUIRED

발신 앱의 Branch 키. Branch 설정 대시보드에 있습니다.

branch_secret | REQUIRED

발신 앱인 경우 Branch 시크릿입니다. Branch 설정 대시보드에 있습니다.

url | REQUIRED

업데이트하려는 딥링크(Deep Link) URL입니다.

샘플 요청 - 업데이트

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
}

링크 업데이트 팁

Link 업데이트 API가 링크의 데이터 객체를 완전히 겹쳐 쓰므로 업데이트할 때 (변경하는 데이터뿐 아니라) 링크의 모든 데이터를 포함해야 합니다.

링크를 대량으로 업데이트하려면 스크립트를 작성할 때 Link 업데이트 및 Link 읽기 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'
  • Branch 링크와 관련된 ID를 업데이트할 수 없습니다.
  • 링크의 type 은 변경할 수 없습니다. 예를 들어 마케팅 링크는 type 2이며, Branch SDK에서 생성된 표준 링크는 type 0입니다.
  • 다음 추가 필드는 업데이트할 수 없습니다.
    • app_id
    • identity_id
    • domain
    • state
    • creation_source
    • app_short_identifier

Commerce Event 로깅

엔드 포인트 - 커머스

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

파라미터 - 커머스

파라미터

branch_key | REQUIRED

발신 앱의 Branch 키. Branch 설정 대시보드에 있습니다.

name | REQUIRED

로그할 이벤트의 이름입니다. 다음 중 하나일 수 있습니다. ADD_TO_CART, ADD_TO_WISHLIST, CLICK_AD, VIEW_CART, INITIATE_PURCHASE, ADD_PAYMENT_INFO, PURCHASE, SPEND_CREDITS

customer_event_alias | Optional

유저가 정의한 이벤트 별명으로 위에 정의된 이벤트 이름에 추가로 사용됩니다.

user_data.os | REQUIRED

Example "Android", "iOS","MAC_OS","LINUX","WINDOWS" etc.

user_data.os_version | Optional

The version of the operating system.

user_data.environment | Optional

일반적으로 FULL_APP

user_data.aaid | Optional

안드로이드 / 구글 광고 ID입니다.

user_data.android_id | Optional

안드로이드 하드웨어 ID

user_data.idfa | Optional

iOS 광고 ID

user_data.idfv | Optional

iOS 벤더 ID

user_data.limit_ad_tracking | Optional

파트너가 광고주에 의해 트래킹 되지 않도록 선택한 경우 참입니다.

user_data.user_agent | Optional

이벤트가 발생한 브라우저 또는 앱의 유저 에이전트입니다. 일반적으로 웹 뷰와 연결됩니다.

user_data.browser_fingerprint_id | Optional

브라우저 트래킹을 위한 Branch 내부 전용 필드입니다.

user_data.http_origin | Optional

Web SDK가 웹 세션 시작을 로그한 현재 페이지 URL입니다.

user_data.http_referrer | Optional

Web SDK가 웹 세션 시작을 로그한 현재 페이지로 연결되는 참조 URL입니다.

user_data.developer_identity | Optional

유저의 개발자 지정 ID입니다.

user_data.country | Optional

일반적으로 디바이스 설정 또는 유저 에이전트 string을 기반으로 하는 유저의 국가 코드입니다.

user_data.language | Optional

일반적으로 디바이스 설정 또는 유저 에이전트 string을 기반으로 하는 유저의 언어 코드입니다.

user_data.ip | REQUIRED

이벤트가 발생한 디바이스의 IP 주소

user_data.local_ip | Optional

안드로이드 전용 : 디바이스의 로컬 IP (예: '168.1.1.1')

user_data.brand | Optional

디바이스의 브랜드

user_data.device_fingerprint_id | Optional

디바이스 트래킹을 위한 Branch 내부 전용 필드입니다.

user_data.app_version | Optional

유저가 다운로드한 앱 버전입니다.

user_data.model | Optional

디바이스의 모델입니다.

user_data.screen_dpi | Optional

화면의 DPI.

user_data.screen_heighti | Optional

화면의 높이.

user_data.screen_width | Optional

화면의 폭.

custom_data | Optional

앱 개발자가 이벤트에 첨부하려는 key-values pairs입니다. Export를 통해 검색되고 Webhook을 통해 전송되는 이벤트에 첨부됩니다.

event_data.transaction_id | Optional

내부 사용을 위한 파트너 지정 트랜잭션 ID

event_data.revenue | Optional

이벤트에 대해 파트너가 지정한 리포트 수익입니다.

event_data.currency | Optional

파트너가 수익, 가격, 배송, 세금을 처음 리포트한 통화

event_data.shipping | Optional

트랜잭션과 관련된 배송비입니다.

event_data.tax | Optional

트랜잭션과 관련된 총 세금입니다.

event_data.coupon | Optional

트랜잭션 시 교환한 트랜잭션 쿠폰 (예: "SPRING2017")

event_data.affiliation | Optional

해당 트랜잭션이 발생한 상점 또는 가맹 (예: 구글 스토어)

event_data.description | Optional

이벤트와 관련된 설명, 개별 콘텐츠 항목에만 해당된 것은 아님 (아래 참조)

content_items[i].$content_schema | Optional

콘텐츠의 카테고리 / 스키마. 향후 분석에 사용될 수 있습니다. 다음 중 하나:
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 | Optional

(개별 콘텐츠 항목의 경우) 제목.

content_items[i].$og_image_url | Optional

(개별 콘텐츠 항목의 경우) 이미지 URL

content_items[i].$canonical_identifier | Optional

Branch가 콘텐츠 분석을 위해 콘텐츠/메시지를 통합하는 데 사용

content_items[i].$publicly_indexable | Optional

true: content can be seen by anyone | false`: 공용으로 색인을 생성할 수 없습니다.

content_items[i].$locally_indexable | Optional

true: 로컬(디바이스)용으로 색인을 생성할 수 있습니다. | false: 로컬용으로 색인을 생성할 수 없습니다.

content_items[i].$price | Optional

제품/콘텐츠의 가격입니다.

content_items[i].$quantity | Optional

주문될 품목의 수 (PURCHASE, ADD_TO_CART 등)입니다.

content_items[i].$sku | Optional

제품 SKU 또는 제품 ID입니다.

content_items[i].$product_name | Optional

제품 이름입니다.

content_items[i].$product_brand | Optional

제품의 브랜드입니다.

content_items[i].$product_category | Optional

제품인 경우 제품의 카테고리입니다. 다음 중 하나:
ANIMALS_AND_PET_SUPPLIES
APPAREL_AND_ACCESSORIES
ARTS_AND_ENTERTAINMENT
BABY_AND_TODDLER
BUSINESS_AND_INDUSTRIAL
CAMERAS_AND_OPTICS
ELECTRONICS
FOOD_BEVERAGES_AND_TOBACCO
FURNITURE
HARDWARE
HEALTH_AND_BEAUTY
HOME_AND_GARDEN
LUGGAGE_AND_BAGS
MATURE
MEDIA
OFFICE_SUPPLIES
RELIGIOUS_AND_CEREMONIAL
SOFTWARE
SPORTING_GOODS
TOYS_AND_GAMES
VEHICLES_AND_PARTS

content_items[i].$product_variant | Optional

제품의 변형 (예: XL, 빨간색).

content_items[i].$rating_average | Optional

항목의 평균 등급입니다.

content_items[i].$rating_count | Optional

항목의 등급 수입니다.

content_items[i].$rating_max | Optional

항목에 대해 가능한 최대 등급 (예: 별 5개가 가능한 최고 등급인 경우 5.0).

content_items[i].$creation_timestamp | Optional

콘텐츠가 생성된 시간입니다.

content_items[i].$exp_date | Optional

해당 콘텐츠가 더 이상 유효하지 않은 마지막 시간입니다. 널(null) / 0은 제한 없음을 의미합니다. 되도록 설정하지 않도록 합니다.

content_items[i].$keywords | Optional

키워드

content_items[i].$address_street | Optional

식당, 비즈니스, 객실 (호텔) 등의 주소입니다.

content_items[i].$address_city | Optional

식당, 비즈니스, 객실 (호텔) 등의 주소입니다.

content_items[i].$address_region | Optional

레스토랑, 비즈니스, 객실 (호텔) 등의 주 또는 지역입니다.

content_items[i].$address_country | Optional

레스토랑, 비즈니스, 객실 (호텔) 등의 국가 코드입니다.

content_items[i].$address_postal_code | Optional

레스토랑, 비즈니스, 객실 (호텔) 등의 우편번호입니다.

content_items[i].$latitude | Optional

레스토랑, 비즈니스, 객실(호텔) 등의 위도입니다.

content_items[i].$longitude | Optional

레스토랑, 비즈니스, 객실(호텔) 등의 경도입니다.

content_items[i].$image_captions | Optional

이미지와 관련된 캡션입니다.

content_items[i].$condition | Optional

경매의 경우 품목이 새롭거나 좋거나 무난한지 등의 여부.

다음 중 하나:
OTHER
NEW
EXCELLENT
GOOD
FAIR
POOR
USED
REFURBISHED

content_items[i].$custom_fields | Optional

앱 개발자가 콘텐츠 항목에 첨부하려는 key-values pairs입니다. Export를 통해 검색되고 Webhook을 통해 전송되는 이벤트에 첨부됩니다.

🚧

필수 식별자 관련 참고 사항

(user_data에서) 다음을 전송해야 합니다.

  1. developer_identity
    또는
  2. browser_fingerprint_id
    또는
  3. os = iOS AND (idfa 또는 idfv)
    또는
  4. os=Android AND (android_id or 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",
    "ip":"192.168.1.1",
    "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 }

Content Event 로깅

엔드 포인트 - 콘텐츠

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

파라미터 - 콘텐츠

파라미터

branch_key | REQUIRED

발신 앱의 Branch 키. Branch 설정 대시보드에 있습니다.

name | REQUIRED

로그 할 이벤트의 이름입니다. 다음 중 하나일 수 있습니다. SEARCH, VIEW_ITEM, VIEW_ITEMS, RATE, SHARE

customer_event_alias | Optional

유저가 정의한 이벤트 별명으로 위에 정의된 이벤트 이름에 추가로 사용됩니다.

user_data.os | REQUIRED

Example "Android", "iOS","MAC_OS","LINUX","WINDOWS" etc.

user_data.os_version | Optional

The version of the operating system.

user_data.environment | Optional

일반적으로 FULL_APP

user_data.aaid | Optional

안드로이드 / 구글 광고 ID입니다.

user_data.android_id | Optional

안드로이드 하드웨어 ID

user_data.idfad | Optional

iOS 광고 ID

user_data.idfv | Optional

iOS 벤더 ID

user_data.limit_ad_tracking | Optional

파트너가 광고주에 의해 트래킹 되지 않도록 선택한 경우 참입니다.

user_data.user_agent | Optional

이벤트가 발생한 브라우저 또는 앱의 유저 에이전트입니다. 일반적으로 웹 뷰와 연결됩니다.

user_data.browser_fingerprint_id | Optional

브라우저 트래킹을 위한 Branch 내부 전용 필드입니다.

user_data.http_origin | Optional

Web SDK가 웹 세션 시작을 로그한 현재 페이지 URL입니다.

user_data.http_referrer | Optional

Web SDK가 웹 세션 시작을 로그한 현재 페이지로 연결되는 참조 URL입니다.

user_data.developer_identity | Optional

유저의 개발자 지정 ID입니다.

user_data.country | Optional

일반적으로 디바이스 설정 또는 유저 에이전트 string을 기반으로 하는 유저의 국가 코드입니다.

user_data.language | Optional

일반적으로 디바이스 설정 또는 유저 에이전트 string을 기반으로 하는 유저의 언어 코드입니다.

user_data.ip | YES

이벤트가 발생한 디바이스의 IP 주소

user_data.local_ip | Optional

안드로이드 전용 : 디바이스의 로컬 IP (예: '168.1.1.1')

user_data.brand | Optional

디바이스의 브랜드

user_data.device_fingerprint_id | Optional

디바이스 트래킹을 위한 Branch 내부 전용 필드입니다.

user_data.app_version | Optional

유저가 다운로드한 앱 버전입니다.

user_data.model | Optional

디바이스의 모델입니다.

user_data.screen_dpi | Optional

화면의 DPI.

user_data.screen_height | Optional

화면의 높이.

user_data.screen_width | Optional

화면의 폭.

custom_data | Optional

앱 개발자가 이벤트에 첨부하려는 key-values pairs입니다. Export를 통해 검색되고 Webhook을 통해 전송되는 이벤트에 첨부됩니다.

event_data.transaction_id | Optional

내부 사용을 위한 파트너 지정 트랜잭션 ID

event_data.revenue | Optional

이벤트에 대해 파트너가 지정한 리포트 수익입니다.

event_data.currency | Optional

파트너가 수익, 가격, 배송, 세금을 처음 리포트한 통화

event_data.shipping | Optional

트랜잭션과 관련된 배송비입니다.

event_data.tax | Optional

트랜잭션과 관련된 총 세금입니다.

event_data.coupon | Optional

트랜잭션 시 교환한 트랜잭션 쿠폰 (예: "SPRING2017")

event_data.affiliation | Optional

해당 트랜잭션이 발생한 상점 또는 가맹 (예: 구글 스토어)

event_data.description | Optional

이벤트와 관련된 설명, 개별 콘텐츠 항목에만 해당된 것은 아님 (아래 참조)

content_items[i].$content_schema | Optional

콘텐츠의 카테고리 / 스키마. 향후 분석에 사용될 수 있습니다. 다음 중 하나:
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 | Optional

(개별 콘텐츠 항목의 경우) 제목.

content_items[i].$og_description | Optional

(개별 콘텐츠 항목의 경우) 설명.

content_items[i].$og_image_url | Optional

(개별 콘텐츠 항목의 경우) 이미지 URL

content_items[i].$canonical_identifier | Optional

Branch가 콘텐츠 분석을 위해 콘텐츠/메시지를 통합하는 데 사용

content_items[i].$publicly_indexable | Optional

true: 누구나 볼 수 있는 콘텐츠 | false: 공용으로 색인을 생성할 수 없습니다.

content_items[i].$locally_indexable | Optional

true: 로컬(디바이스)용으로 색인을 생성할 수 있습니다. | false: 로컬용으로 색인을 생성할 수 없습니다.

content_items[i].$price | Optional

제품/콘텐츠의 가격입니다.

content_items[i].$quantity | Optional

주문될 품목의 수 (PURCHASE, ADD_TO_CART 등)입니다.

content_items[i].$sku | Optional

제품 SKU 또는 제품 ID입니다.

content_items[i].$product_name | Optional

제품 이름입니다.

content_items[i].$product_brand | Optional

제품의 브랜드입니다.

ccontent_items[i].$product_category | Optional

제품인 경우 제품의 카테고리입니다. 다음 중 하나:
ANIMALS_AND_PET_SUPPLIES
APPAREL_AND_ACCESSORIES
ARTS_AND_ENTERTAINMENT
BABY_AND_TODDLER
BUSINESS_AND_INDUSTRIAL
CAMERAS_AND_OPTICS
ELECTRONICS
FOOD_BEVERAGES_AND_TOBACCO
FURNITURE
HARDWARE
HEALTH_AND_BEAUTY
HOME_AND_GARDEN
LUGGAGE_AND_BAGS
MATURE
MEDIA
OFFICE_SUPPLIES
RELIGIOUS_AND_CEREMONIAL
SOFTWARE
SPORTING_GOODS
TOYS_AND_GAMES
VEHICLES_AND_PARTS

content_items[i].$product_variant | Optional

제품의 변형 (예: XL, 빨간색).

content_items[i].$rating_average | Optional

항목의 평균 등급입니다.

content_items[i].$rating_count | Optional

항목의 등급 수입니다.

content_items[i].$rating_max | Optional

항목에 대해 가능한 최대 등급 (예: 별 5개가 가능한 최고 등급인 경우 5.0).

content_items[i].$creation_timestamp | Optional

콘텐츠가 생성된 시간입니다.

content_items[i].$exp_date | Optional

해당 콘텐츠가 더 이상 유효하지 않은 마지막 시간입니다. 널(null) / 0은 제한 없음을 의미합니다. 되도록 설정하지 않도록 합니다.

content_items[i].$keywords | Optional

키워드

content_items[i].$address_street | Optional

식당, 비즈니스, 객실 (호텔) 등의 주소입니다.

content_items[i].$address_city | Optional

식당, 비즈니스, 객실 (호텔) 등의 주소입니다.

content_items[i].$address_region | Optional

레스토랑, 비즈니스, 객실 (호텔) 등의 주 또는 지역입니다.

content_items[i].$address_country | Optional

레스토랑, 비즈니스, 객실 (호텔) 등의 국가 코드입니다.

content_items[i].$address_postal_code | Optional

레스토랑, 비즈니스, 객실 (호텔) 등의 우편번호입니다.

content_items[i].$latitude | Optional

레스토랑, 비즈니스, 객실(호텔) 등의 위도입니다.

content_items[i].$longitude | Optional

레스토랑, 비즈니스, 객실(호텔) 등의 경도입니다.

content_items[i].$image_captions | Optional

이미지와 관련된 캡션입니다.

content_items[i].$condition | Optional

경매의 경우 품목이 새롭거나 좋거나 무난한지 등의 여부.

다음 중 하나:
OTHER
NEW
EXCELLENT
GOOD
FAIR
POOR
USED
REFURBISHED

content_items[i].$custom_fields | Optional

앱 개발자가 콘텐츠 항목에 첨부하려는 key-values pairs입니다. Export를 통해 검색되고 Webhook을 통해 전송되는 이벤트에 첨부됩니다.

🚧

필수 식별자 관련 참고 사항

(user_data에서) 다음을 전송해야 합니다.

  1. developer_identity
    또는
  2. browser_fingerprint_id
    또는
  3. os = iOS AND (idfa 또는 idfv)
    또는
  4. os=Android AND (android_id or 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",
    "ip": "192.168.1.1",
    "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 }

유저 Lifecycle Event 로깅

엔드 포인트 - 수명 주기

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

파라미터 - 수명 주기

파라미터

branch_key | REQUIRED

발신 앱의 Branch 키. Branch 설정 대시보드에 있습니다.

name | REQUIRED

로그할 이벤트의 이름입니다. 다음 중 하나일 수 있습니다. ADD_TO_CART, ADD_TO_WISHLIST, CLICK_AD, VIEW_CART, INITIATE_PURCHASE, ADD_PAYMENT_INFO, PURCHASE, SPEND_CREDITS

user_data.os | REQUIRED

Example "Android", "iOS","MAC_OS","LINUX","WINDOWS" etc.

user_data.os_version | Optional

The version of the operating system.

user_data.environment | Optional

일반적으로 FULL_APP

user_data.aaid | Optional

안드로이드 / 구글 광고 ID입니다.

user_data.android_id | Optional

안드로이드 하드웨어 ID

user_data.idfa | Optional

iOS 광고 ID

user_data.idfv | Optional

iOS 벤더 ID

user_data.limit_ad_tracking | Optional

파트너가 광고주에 의해 트래킹 되지 않도록 선택한 경우 참입니다.

user_data.user_agent | Optional

이벤트가 발생한 브라우저 또는 앱의 유저 에이전트입니다. 일반적으로 웹 뷰와 연결됩니다.

user_data.browser_fingerprint_id | Optional

브라우저 트래킹을 위한 Branch 내부 전용 필드입니다.

user_data.http_origin | Optional

Web SDK가 웹 세션 시작을 로그한 현재 페이지 URL입니다.

user_data.http_referrer | Optional

Web SDK가 웹 세션 시작을 로그한 현재 페이지로 연결되는 참조 URL입니다.

user_data.developer_identity | Optional

유저의 개발자 지정 ID입니다.

user_data.country | Optional

일반적으로 디바이스 설정 또는 유저 에이전트 string을 기반으로 하는 유저의 국가 코드입니다.

user_data.language | Optional

일반적으로 디바이스 설정 또는 유저 에이전트 string을 기반으로 하는 유저의 언어 코드입니다.

user_data.ip | REQUIRED

이벤트가 발생한 디바이스의 IP 주소

user_data.local_ip | Optional

안드로이드 전용 : 디바이스의 로컬 IP (예: '168.1.1.1')

user_data.brand | Optional

디바이스의 브랜드

user_data.device_fingerprint_id | Optional

디바이스 트래킹을 위한 Branch 내부 전용 필드입니다.

user_data.app_version | Optional

유저가 다운로드한 앱 버전입니다.

user_data.model | Optional

디바이스의 모델입니다.

user_data.screen_dpi | Optional

화면의 DPI.

user_data.screen_height | Optional

화면의 높이.

user_data.screen_width | Optional

화면의 폭.

custom_data | Optional

앱 개발자가 이벤트에 첨부하려는 key-values pairs입니다. Export를 통해 검색되고 Webhook을 통해 전송되는 이벤트에 첨부됩니다.

event_data.description | Optional

이벤트와 관련된 설명입니다.

🚧

필수 식별자 관련 참고 사항

(user_data에서) 다음을 전송해야 합니다.

  1. developer_identity
    또는
  2. browser_fingerprint_id
    또는
  3. os = iOS AND (idfa 또는 idfv)
    또는
  4. os=Android AND (android_id or 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",
    "ip": "192.168.1.1",
    "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

파라미터 - 커스텀

파라미터

branch_key | REQUIRED

발신 앱의 Branch 키. Branch 설정 대시보드에 있습니다.

name | REQUIRED

로그 할 이벤트의 이름입니다. 커스텀 이벤트 이름의 string 일 수 있습니다. 예: "picture swiped".

user_data.os | REQUIRED

Example "Android", "iOS","MAC_OS","LINUX","WINDOWS" etc.

user_data.os_version | Optional

The version of the operating system.

user_data.environment | Optional

일반적으로 FULL_APP

user_data.aaid | Optional

안드로이드 / 구글 광고 ID입니다.

user_data.android_id | Optional

안드로이드 하드웨어 ID

user_data.idfa | Optional

iOS 광고 ID

user_data.idfv | Optional

iOS 벤더 ID

user_data.limit_ad_tracking | Optional

파트너가 광고주에 의해 트래킹 되지 않도록 선택한 경우 참입니다.

user_data.user_agent | Optional

이벤트가 발생한 브라우저 또는 앱의 유저 에이전트입니다. 일반적으로 웹 뷰와 연결됩니다.

user_data.browser_fingerprint_id | Optional

브라우저 트래킹을 위한 Branch 내부 전용 필드입니다.

user_data.http_origin | Optional

Web SDK가 웹 세션 시작을 로그한 현재 페이지 URL입니다.

user_data.http_referrer | Optional

Web SDK가 웹 세션 시작을 로그한 현재 페이지로 연결되는 참조 URL입니다.

user_data.developer_identity | Optional

유저의 개발자 지정 ID입니다.

user_data.country | Optional

일반적으로 디바이스 설정 또는 유저 에이전트 string을 기반으로 하는 유저의 국가 코드입니다.

user_data.language | Optional

일반적으로 디바이스 설정 또는 유저 에이전트 string을 기반으로 하는 유저의 언어 코드입니다.

user_data.ip | REQUIRED

이벤트가 발생한 디바이스의 IP 주소

user_data.local_ip | Optional

안드로이드 전용 : 디바이스의 로컬 IP (예: '168.1.1.1')

user_data.brand | Optional

디바이스의 브랜드

user_data.device_fingerprint_id | Optional

디바이스 트래킹을 위한 Branch 내부 전용 필드입니다.

user_data.app_version | Optional

유저가 다운로드한 앱 버전입니다.

user_data.model | Optional

디바이스의 모델입니다.

user_data.screen_dpi | Optional

화면의 DPI.

user_data.screen_height | Optional

화면의 높이.

user_data.screen_width | Optional

화면의 폭.

custom_data | Optional

앱 개발자가 이벤트에 첨부하려는 key-values pairs입니다. Export를 통해 검색되고 Webhook을 통해 전송되는 이벤트에 첨부됩니다.

event_data.description | **

이벤트와 관련된 설명입니다.

🚧

필수 식별자 관련 참고 사항

(user_data에서) 다음을 전송해야 합니다.

  1. developer_identity
    또는
  2. browser_fingerprint_id
    또는
  3. os = iOS AND (idfa 또는 idfv)
    또는
  4. os=Android AND (android_id or 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",
    "ip": "192.168.1.1",
    "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 앱 설정 가져오기

엔드 포인트 - 앱 설정 가져오기

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

파라미터 - 앱 설정 가져오기

파라미터

branch_key | REQUIRED

발신 앱의 Branch 키. Branch 설정 대시보드에 있습니다.

branch_secret | REQUIRED

발신 앱인 경우 Branch 시크릿입니다. Branch 설정 대시보드에 있습니다.

반환 - 앱 설정 가져오기

{
    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",
  }

Branch 앱 설정 업데이트

엔드 포인트 - 앱 설정 업데이트

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

파라미터 - 앱 설정 업데이트

파라미터

branch_secret | REQUIRED

발신 앱인 경우 Branch 시크릿입니다. Branch 설정 대시보드에 있습니다.

app_name | Optional

앱 이름 (최대 255자).

dev_name | Optional

주요 담당 개발자 이름 (최대 255자).

dev_email | Optional

주요 담당 개발자 이메일 (최대 255자).

android_url | Optional

안드로이드 스토어의 URL 또는 패키지 이름 (com.android.myapp)입니다. 대신 안드로이드용 폴백 URL을 설정하려면 android_app2 로 설정해야 합니다.

android_uri_scheme | Optional

안드로이드 URI scheme.

ios_url | Optional

iOS 스토어의 URL 또는 앱 ID (id512451233)

ios_uri_scheme | Optional

iOS URI scheme.

ios_store_country | Optional

앱의 국가 코드, 기본값은 US (최대 255자)입니다.

web_url | Optional

URL이 널(null)인 경우 웹 사이트를 백업합니다.

text_message | Optional

text-me 기능에 사용할 문자 메시지 {{ link }}는 짧은 링크 (최대 255자)로 대체됩니다.

og_app_id | Optional

기본 오픈 그래프(Open Graph, OG) 앱 ID (최대 255자).

og_title | Optional

링크와 함께 사용할 기본 OG 제목 (최대 255자).

og_description | Optional

링크와 함께 사용할 기본 OG 설명 (최대 255자).

og_image_url | Optional

링크와 함께 사용할 기본 OG 이미지 URL (최대 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"
  }

16일 전에 업데이트됨


딥링킹 API


제안된 편집은 API 참조 페이지에서 제한됩니다.

Markdown 본문 콘텐츠에 대한 편집만 제안할 수 있지만 API 사양에는 제안할 수 없습니다.


필터