> For the complete documentation index, see [llms.txt](https://onestore-dev.gitbook.io/dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://onestore-dev.gitbook.io/dev/cht/tools/app-links/reference.md).

# Reference

## 用語 <a href="#yong-ci" id="yong-ci"></a>

| Required Terminology | Description                           | Remarks         |
| -------------------- | ------------------------------------- | --------------- |
| PID                  | PID 代表產品識別碼。這是一個在應用程式註冊時自動發放的唯一 ID 值。 | PID 不應與 AID 混淆。 |

## **支援客户端版本** <a href="#referencechinese-ke-hu-duan-zhi-chi-ban-ben" id="referencechinese-ke-hu-duan-zhi-chi-ban-ben"></a>

大韓民國

| 商店版本         | 備註    | 套件包名稱                   | 支援版本                                           |
| ------------ | ----- | ----------------------- | ---------------------------------------------- |
| T store      | -     | com.skt.skaf.A000Z00040 | Version Name = 5.0.0 / Version Code = 50000 以上 |
| Olleh Market | 預載版本  | com.kt.olleh.storefront | Version Name = 5.0.0 / Version Code = 50000 以上 |
| U+Store      | LTE終端 | com.lguplus.appstore    | Version Name = 5.0.0 / Version Code = 50000 以上 |

大韓民國以外國家/地區

| 商店版本   | 備註 | 套件包名稱                         | 支援版本                                            |
| ------ | -- | ----------------------------- | ----------------------------------------------- |
| 新加坡/臺灣 | -  | com.onestorecorp.gaa.storeapp | 支援所有版本                                          |
| 美國     | -  | com.dti.folderlauncher        | Version Name = 4.0.0 / Version Code = 400000 以上 |

### **選定商店(Deprecated)** <a href="#referencechinese-xuan-ding-shang-dian-deprecated" id="referencechinese-xuan-ding-shang-dian-deprecated"></a>

* **以下內容不建議使用（Deprecated處理） 作為選定商店的分隔符，建議使用common方式。**<br>

  ```
  onestore://{store selection }/product/{product PID}?view_type={value}
  ```

  | 選定商店                                             | 假設                 | 動作                                                    |
  | ------------------------------------------------ | ------------------ | ----------------------------------------------------- |
  | common                                           | 只安裝一個應用程式商品客戶端時    | 立即連動相應商店                                              |
  | common                                           | 已安裝兩個以上的應用程式商品客戶端時 | 首先顯示一個畫面，可自行選擇欲連動的商品                                  |
  | <p>tstore</p><p>ollehmarket</p><p>uplusstore</p> | 只安裝一個應用程式商品客戶端時    | <p>如果已安裝相應商店客戶端，立即連動</p><p>如果未安裝相應商店客戶端，停止操作（無回應）</p> |
  | <p>tstore</p><p>ollehmarket</p><p>uplusstore</p> | 已安裝兩個以上的應用程式商品客戶端時 | <p>如果已安裝相應商店客戶端，立即連動</p><p>如果未安裝相應商店客戶端，停止操作（無回應）</p> |

  示例

  ```
  onestore://common/product/{product PID}?view_type={view_type}
  onestore://tstore/product/{product PID}?view_type={view_type}
  onestore://ollehmarket/product/{product PID}?view_type={view_type}
  onestore://uplusstore/product/{product PID}?view_type={view_type}
  ```

## **關於URL scheme連動 Reference** <a href="#referencechinese-guan-yu-urlscheme-lian-jie-de-yin-yong" id="referencechinese-guan-yu-urlscheme-lian-jie-de-yin-yong"></a>

* #### 商品詳細查看 Reference <a href="#referencechinese-shang-pin-xiang-xi-cha-kan-de-yin-yong" id="referencechinese-shang-pin-xiang-xi-cha-kan-de-yin-yong"></a>

  command

  ```
  onestore://common/product/{product id}
  ```

  | Parameter  | Type   | Mandatory | Limit | sample       | Description |
  | ---------- | ------ | --------- | ----- | ------------ | ----------- |
  | product id | String | M         | 十位數字  | `0000252337` | 商品的PID（數字）  |

* #### 商品搜尋查看 Reference <a href="#referencechinese-shang-pin-sou-suo-cha-kan-de-yin-yong" id="referencechinese-shang-pin-sou-suo-cha-kan-de-yin-yong"></a>

  command

  ```
  onestore://common/search/{query}
  ```

  | Parameter | Type   | Mandatory | Limit           | sample       | Description |
  | --------- | ------ | --------- | --------------- | ------------ | ----------- |
  | 關鍵字       | String | M         | 10 digit number | `0000252337` | 輸入關鍵字       |

* #### 請求更新 <a href="#referencechinese-qing-qiu-geng-xin" id="referencechinese-qing-qiu-geng-xin"></a>

  command

  ```
  command onestore://common/product/bg_update/{product id}
  ```

  | Parameter  | Type   | Mandatory | Limit | sample       | Description |
  | ---------- | ------ | --------- | ----- | ------------ | ----------- |
  | product id | String | M         | 十位數字  | `0000252337` | 商品的PID（數字）  |

* 請求更新時規格的參考事項
  * 更新在Background進行，通過提示（Noti）告知進行過程。
  * 若已經安裝最新版本，將無視更新請求。
  * 該動作只針對會員，故系統只有是ONE Store會員才會有反應。
  * 若用戶不是會員或是登入失敗，為了進行認證將自動顯示登入畫面。
  * 收費應用程式：已有購買紀錄才可啟動。
  * 免費應用程式：自動進行購買處理並下載。

<br>

### **查詢referrer統計** <a href="#referencechinese-cha-xun-referrer-tong-ji" id="referencechinese-cha-xun-referrer-tong-ji"></a>

command

```
onestore://common/{Individual connection commands}?refType=(Int)&referrer=(STRING)&callerType=(INT)
```

| refType | referrer     | callerType                                                                              | 備註                                                 |
| ------- | ------------ | --------------------------------------------------------------------------------------- | -------------------------------------------------- |
| 1       | package name | <p>7: Android app<br>8: 網頁瀏覽器<br>9: 短信(SMS)<br>10: 推播訊息（GCM 等）<br>11: 廣告網路 (T-AD 等）</p> | 通過應用程式呼叫時，建議使用套件包名稱（PKG Name），除此之外都使用URL (UTF-8)呼叫 |
| 2       | URL          | 相同                                                                                      | 相同                                                 |
| 3       | 合作夥伴名稱 + PID | 如果與合作夥伴共同進行行銷活動，建議使用該方法                                                                 | <p><br></p>                                        |

### 伺服器 A**PI** <a href="#referencechinese-fu-wu-duan-api" id="referencechinese-fu-wu-duan-api"></a>

#### 使用套件包名（packageName）確認PID及版本名稱 <a href="#referencechinese-shi-yong-bao-ming-packagename-que-ren-pid-ji-ban-ben-ming-cheng" id="referencechinese-shi-yong-bao-ming-packagename-que-ren-pid-ji-ban-ben-ming-cheng"></a>

command

```
https://oneapi.onestore.net/api/devcenter/getAppVersion/v1?pkgNm={Packagename}&deviceModelCd={ModelName}&osVer={OS version}&sdkVersion={SDK version}
```

**Request Parameters**

| Parameter     | Type   | Mandatory | Limit   | sample                   | Description |
| ------------- | ------ | --------- | ------- | ------------------------ | ----------- |
| pkgNm         | String | M         | `??100` | `com.nhn.android.search` | 應用程式的套件包名稱  |
| deviceModelCd | String | O         | `??100` | `SM-N920S`               | <p><br></p> |
| osVer         | String | O         | 5       | `6.0.1`                  | 終端設備的OS版本   |
| sdkVersion    | String | O         | 5       | 30                       | <p><br></p> |

**Response Parameters**

<table><thead><tr><th width="115">Name</th><th width="127">Mandatory</th><th width="87">Type</th><th width="129">Description</th><th></th></tr></thead><tbody><tr><td>result</td><td><br></td><td>M</td><td><strong>Object</strong></td><td>回應結果訊息</td></tr><tr><td><br></td><td>code</td><td>M</td><td>String</td><td><ul><li>000 : success</li><li>100 : no data</li><li>200 : server error</li><li>400 : bad request</li><li>509 : server busy</li></ul></td></tr><tr><td><br></td><td>desc</td><td>M</td><td>String</td><td>回應訊息</td></tr><tr><td>prodId</td><td><br></td><td>M</td><td>String</td><td>商品PID</td></tr><tr><td>verNm</td><td><br></td><td>M</td><td>String</td><td>應用程式版本名稱，只有註冊終端設備名稱和OS版本才會顯示</td></tr><tr><td>verCd</td><td><br></td><td>M</td><td>String</td><td>應用程式版本代碼（請見下面說明）</td></tr><tr><td>longVerCd</td><td><br></td><td><br></td><td>String</td><td><ul><li><p>Version Code</p><ul><li>Android OS版本為Pie以上且已註冊Major Version Code時，回應如下。</li><li><p>Major Version Code 和 version Code 合併版本代碼</p><ul><li>(((long) major) &#x3C;&#x3C; 32) | (((long) minor) &#x26; 0xffffffffL)</li></ul></li><li>此外，回應與"verCd"相同的值</li></ul></li></ul></td></tr><tr><td>title</td><td><br></td><td>M</td><td>String</td><td>商品名稱</td></tr><tr><td>topMenuId</td><td><br></td><td>M</td><td>String</td><td>版本名稱，只有註冊終端設備名稱和OS版本才會顯示</td></tr><tr><td>topMenuNm</td><td><br></td><td>M</td><td>String</td><td>版本名稱，只有註冊終端設備名稱和OS版本才會顯示</td></tr><tr><td>menuId</td><td><br></td><td>M</td><td><br></td><td>最大分類代碼</td></tr><tr><td>menuNm</td><td><br></td><td>M</td><td>String</td><td>最大分類名稱</td></tr><tr><td>sellerNm    </td><td><br></td><td>M</td><td>String</td><td>銷售者名稱</td></tr><tr><td>game</td><td><br></td><td>M</td><td>boolean</td><td></td></tr></tbody></table>

不輸入型號時的回應

```
{
    "result": {
        "code": "000",
        "desc": "success"
    },
    "prodId": "0000758646",
    "verNm": "1.36.120365",
    "verCd": "120365",
    "title": "블루 아카이브",
    "topMenuId": "DP01",
    "topMenuNm": "게임",
    "menuId": "DP01004",
    "menuNm": "롤플레잉",
    "sellerNm": "(주) 넥슨",
    "game": true
}
```

<br>

<br>