ข้ามไปที่เนื้อหา

การลงทะเบียนเป้าหมาย

API การลงทะเบียนการกำหนดเป้าหมายแบ่งออกเป็น API สำหรับลงทะเบียนข้อมูลการกำหนดเป้าหมาย และ API สำหรับลงทะเบียนข้อมูลการกำหนดเป้าหมาย เมื่อ API สำหรับลงทะเบียนข้อมูลการกำหนดเป้าหมายขอข้อมูลพื้นฐาน ID การกำหนดเป้าหมายที่ส่งกลับและคำอธิบายการกำหนดเป้าหมายจะถูกบันทึกเมื่อเรียกใช้ API สำหรับลงทะเบียนข้อมูลการกำหนดเป้าหมาย ID การกำหนดเป้าหมายและคำอธิบายจะซิงค์กับ API การลงทะเบียนสำหรับข้อมูลการกำหนดเป้าหมาย

ข้อกำหนดเบื้องต้น

เพื่อซิงค์กับ API สำหรับการลงทะเบียนข้อมูลการกำหนดเป้าหมาย ให้แน่ใจว่าได้ออกโทเค็นการอนุญาต (API KEY) หากคุณมีคีย์อยู่แล้ว ให้ขอสิทธิ์เพิ่มเติม ดูที่ Hive Server API > Notification > Push v4 > Authentication เพื่อตรวจสอบวิธีการขอและออกโทเค็นการอนุญาต

API สำหรับการลงทะเบียนข้อมูลการกำหนดเป้าหมาย

ข้อมูลพื้นฐานและตัวแปรคำขอ

วิธีการ POST
URL /push/targets
แผนก ชื่อฟิลด์ คำอธิบาย ประเภท จำเป็น
Header Content-Type application/json;charset=utf-8
Authorization bearer {{API KEY}}
Body บริษัท ชื่อบริษัท (เช่น gamevil, com2us, gcp) String O
companyIndex รหัสบริษัท (หมายเลขบริษัทที่ลงทะเบียนใน AppCenter) Integer O
ผู้ลงทะเบียน id รหัสของผู้ขอลงทะเบียน String O
ชื่อ ชื่อของผู้ขอลงทะเบียน String X
คำอธิบาย ชื่อหรือคำอธิบายเป้าหมาย String O
เกม gameindex ดัชนีเกม Integer O

ผลลัพธ์

แผนก ชื่อฟิลด์ คำอธิบาย ประเภท จำเป็น
ส่วนหัว Content-Type application/json;charset=utf-8
UUID {{UUID}}
เนื้อหา id Targetting ID Long O
บริษัท เหมือนกับข้อมูลการร้องขอ String O
companyIndex Integer O
ผู้ลงทะเบียน id String O
ชื่อ String X
คำอธิบาย String O
เกม gameindex Integer O
มีอยู่ ความพร้อมใช้งาน Boolean 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
URL /push/targets/{{targeting ID}}/direct/new
แผนก ชื่อฟิลด์ คำอธิบาย ประเภท จำเป็น
Header Content-Type application/json;charset=utf-8
Authorization bearer {{API KEY}}
Body - รายการข้อมูลการกำหนดเป้าหมาย ตรวจสอบ โครงสร้างการกำหนดเป้าหมาย และ ตัวอย่าง ด้านล่าง. Target[] O

โครงสร้างการกำหนดเป้าหมาย

แผนก ชื่อฟิลด์ คำอธิบาย ประเภท จำเป็น
เป้าหมาย ตัวระบุ playerId โปรดป้อนหนึ่งในสี่ตัวระบุ Long O
vid Long
uid Long
did Long
app appid String 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
  • การตอบสนอง
< HTTP/1.1 200 OK
< content-length: 0
< Content-Type: application/json
< UUID: d4d177d3-2f90-48ba-ae97-37890045495a