定向注册
目標註冊 API 分為 註冊目標資訊的 API 和 註冊目標數據的 API。當註冊目標資訊的 API 請求基本數據時,返回的目標 ID 和目標描述請求在運行註冊目標數據的 API 時保存。目標 ID 及其描述與目標資訊的註冊 API 同步。
先決條件¶
要與註冊目標資訊的API同步,請確保發出授權令牌(API KEY)。如果您已經擁有該密鑰,請請求額外的權限。請參考Hive 伺服器API > 通知 > 推送 v4 > 認證以檢查如何請求和發出授權令牌。
註冊目標資訊的 API¶
基本數據和請求變量¶
方法 | POST | ||||
網址 | /push/targets | ||||
區域 | 欄位名稱 | 描述 | 類型 | 必要 | |
標頭 | Content-Type | application/json;charset=utf-8 | |||
授權 | bearer {{API KEY}} | ||||
主體 | company | 公司名稱(例如,gamevil,com2us,gcp) | 字串 | O | |
companyIndex | 公司代碼(在AppCenter上註冊的公司編號) | 整數 | O | ||
登記人 | id | 登記請求者的ID | 字串 | O | |
name | 登記請求者的名稱 | 字串 | X | ||
description | 目標標題或描述 | 字串 | O | ||
game | gameindex | 遊戲索引 | 整數 | O |
輸出結果¶
部門 | 欄位名稱 | 描述 | 類型 | 必填 | |
標頭 | Content-Type | application/json;charset=utf-8 | |||
UUID | {{UUID}} | ||||
主體 | id | 目標 ID | 長整數 | O | |
公司 | 與請求數據相同 | 字串 | O | ||
公司索引 | 整數 | O | |||
登記者 | id | 字串 | O | ||
姓名 | 字串 | X | |||
描述 | 字串 | O | |||
遊戲 | 遊戲索引 | 整數 | O | ||
可用性 | 可用性 | 布林值 | O |
回應狀態碼¶
鍵 | 值 | 描述 |
---|---|---|
200 | 成功 | (主體為空) |
400 | 錯誤的請求 | POST 數據被省略 JSON 格式錯誤 必需的元素被省略或無效 可以額外檢查主體中的原因消息 |
401 | 未授權 | 請求消息中的授權標頭被省略或無效 授權令牌(API KEY)未註冊 無法訪問相關 API |
403 | 禁止 | 授權標頭的授權方案不是 "Bearer"(僅支持 Bearer) |
404 | 找不到 | 請求 URL 錯誤 |
500 | 內部伺服器錯誤 | 伺服器內部錯誤 |
502 | 錯誤的網關 | 推送網關伺服器過載 網絡連接錯誤 |
503 | 服務不可用 | API 伺服器或授權伺服器凍結 |
範例代碼¶
- 呼叫
curl -L
-d '{"companyIndex": 3, "company" : "gcp", "registrant":{"id":"pushmanager", "name":"push administrator"}, "description":"push targeting test", "game":{"gameindex":592}}'
-H "Content-Type: application/json"
-H "Authorization: Bearer {API KEY}"
https://sandbox-notification.qpyou.cn/push/targets
- 請求
> POST /push/targets HTTP/1.1
> User-Agent: curl/7.19.7 (x86_64-redhat-linux-gnu) libcurl/7.19.7 NSS/3.27.1 zlib/1.2.3 libidn/1.18 libssh2/1.4.2
> Host: sandbox-notification.qpyou.cn
> Accept: */*
> Content-Type: application/json
> Authorization: Bearer {API KEY}
> Content-Length: 143
- 回應
< HTTP/1.1 200 OK
< Content-Length: 180
< Content-Type: application/json
< UUID: 6f75eab9-9e66-40da-a375-a5209cea6a9c
<
* Connection #0 to host sandbox-notification.qpyou.cn left intact
* Closing connection #0
{"id":11,"companyIndex": 3, "company" : "gcp", "game":{"gameindex":592},"description":"Tergeting test","registrant":{"name":"identifier_name","id":"identifier_id"},"available":false,"locked":false}
註冊目標數據的 API¶
基本數據和請求變量¶
方法 | POST | ||||
網址 | /push/targets/{{targeting ID}}/direct/new | ||||
區域 | 欄位名稱 | 描述 | 類型 | 必填 | |
標頭 | Content-Type | application/json;charset=utf-8 | |||
授權 | bearer {{API KEY}} | ||||
主體 | - | 目標數據的列表 查看下面的目標結構和範例。 | Target[] | O |
目標結構¶
區域 | 欄位名稱 | 描述 | 類型 | 必填 | |
目標 | 識別碼 | playerId | 請確保輸入四個識別碼之一。 | 長整數 | O |
vid | 長整數 | ||||
uid | 長整數 | ||||
did | 長整數 | ||||
app | appid | 字串 | O |
目標範例¶
[
{
"identifier": {
"playerId": 1,
"did": 1000
},
"app": {
"appid": "com.gcp.stepbystep.ios.apple.global.ent"
}
}
]
輸出結果¶
標題 | 內容類型 | application/json;charset=utf-8 | ||
UUID | {{UUID}} | |||
成功:HTTP 狀態碼 == 200 |
錯誤¶
部門 | 欄位名稱 | 描述 | 類型 | 必填 | |
失敗:HTTP 狀態碼 !== 200 | |||||
主體 | 錯誤 | 原因 | 錯誤發生的原因 | 字串 | X |
範例代碼¶
- 呼叫
curl -L
-H "Content-Type: application/json"
-H "Authorization: Bearer {API KEY}"
-d '[ { "identifier": { "playerId": 1, "did": 1000 }, "app": { "appid": "com.gcp.stepbystep.ios.apple.global.ent" } }, { "identifier": { "playerId": 2, "did": 2000 }, "app": { "appid": "com.gcp.stepbystep.android.google.global.normal" } } ]'
https://sandbox-notification.qpyou.cn/push/targets/11/direct/new
- 請求
> POST /push/targets/11/direct/new HTTP/1.1
> User-Agent: curl/7.19.7 (x86_64-redhat-linux-gnu) libcurl/7.19.7 NSS/3.27.1 zlib/1.2.3 libidn/1.18 libssh2/1.4.2
> Host: sandbox-notification.qpyou.cn
> Accept: */*
> Content-Type: application/json
> Authorization: Bearer {API KEY}
> Content-Length: 236
- 回應