รายการแบนเนอร์

ให้ข้อมูลที่จำเป็นสำหรับการกำหนดค่าป้ายในรูปแบบรายการ มี 3 API การตอบสนองตามค่า Request Body type_banner

1. small: คืนค่าข้อมูลที่จำเป็นในการกำหนดค่าแบนเนอร์ปกติ, การแจ้งเตือน, และแบนเนอร์แบบเลื่อน.
2. great: คืนค่าเฉพาะข้อมูลที่จำเป็นในการกำหนดค่าแบนเนอร์แบบแทรก.
3. rolling: คืนค่าเฉพาะข้อมูลที่จำเป็นในการกำหนดค่าแบนเนอร์แบบเลื่อน.

• คำขอ URL

  URL ทั่วไป	https://promotion.qpyou.cn/api/banner
  URL Sandbox	https://sandbox-promotion.qpyou.cn/api/banner
  วิธีการ HTTP	POST
  ประเภทเนื้อหา	text/html
  รูปแบบข้อมูล	JSON

• หัวข้อ

  ชื่อฟิลด์	คำอธิบาย	ประเภท	จำเป็น
  การอนุญาต	CertificationKey ที่ถูกต้องผ่านการอนุญาต Bearer	String	N

• หัวข้อ

  ชื่อฟิลด์	คำอธิบาย	ประเภท	จำเป็น
  การอนุญาต	CertificationKey ที่ถูกต้องผ่านการอนุญาต Bearer	String	N

• คำขอ เนื้อหา

  ชื่อฟิลด์	คำอธิบาย	ประเภท	จำเป็น
  ผู้ใช้	ข้อมูลผู้ใช้	วัตถุ	ใช่
  ㄴ uid	รหัสผู้ใช้ที่จัดการโดยแพลตฟอร์ม	สตริง	ไม่
  ㄴ vid	VID ที่จัดการโดยศูนย์เข้าสู่ระบบในโมดูลการรวม หรือ PlayerID ที่จัดการโดยการตรวจสอบสิทธิ์ v4 ค่าจะว่างเปล่าสำหรับโมดูลแต่ละตัว	สตริง	ไม่
  ㄴ player_token	ข้อมูลการตรวจสอบสิทธิ์ผู้ใช้	String	N
  ㄴ did	รหัสประจำตัวที่ไม่ซ้ำกันสำหรับแต่ละอุปกรณ์ที่ Provisioning สร้างขึ้น	String	Y
  ㄴ world	ข้อมูลเซิร์ฟเวอร์เกม	String	Y
  ㄴ language	รหัสภาษาที่ตั้งไว้ในเกมหรืออุปกรณ์ (ตาม ISO 639-1)	String	Y
  ㄴ hive_country	ข้อมูลประเทศที่ร้องขอ หากไม่มีค่าใด ๆ ฟิลด์จะถูกกำหนดตาม IP ที่ร้องขอ	String	N
  ㄴ age_gate_u13	ว่าจำกัดผู้ใช้ที่อายุต่ำกว่า 13 ปีตาม COPPA หรือไม่ สตูดิโอเกมส่งค่าที่ส่งกลับจากการดำเนินการฟังก์ชันที่เกี่ยวข้องใน Hive SDK `true`: จำกัดผู้ใช้ที่อายุต่ำกว่า 13 ปี `false`: ไม่มีการจำกัด	Boolean	Y
  game	ข้อมูลเกม	Object	Y
  ㄴ appid	AppID ของเกมที่พยายามแสดงแบนเนอร์	String	Y
  ㄴ app_version	เวอร์ชันเกมที่ต้องการเพื่อกำหนดว่าจะแสดงแบนเนอร์การตรวจสอบหรือไม่	String	Y
  promotion	ข้อมูลแคมเปญส่งเสริมการขาย	Object	Y
  ㄴ type_camp	ประเภทแคมเปญส่งเสริมการขาย (เลือกหรือป้อนโดยตรงเมื่อสมัครแคมเปญใน Hive Console) all: ทุกประเภท event: ประเภทเหตุการณ์ notice: ประเภทประกาศ cross: ประเภทแคมเปญข้าม Others: ประเภทประกาศที่ผู้ใช้กำหนด สูงสุด 10 ตัวอักษรพิมพ์เล็ก	String	Y
  ㄴ type_banner	ประเภทแบนเนอร์แคมเปญ small: แบนเนอร์ปกติ (แบนเนอร์แบบแถบ) great: แบนเนอร์แบบเต็มหน้าจอ rolling: แบนเนอร์แบบหมุน	String	Y

curl -L -v \
-d '{
    "user": {
        "uid": "107812001",
        "vid": "10053342680",
        "player_token" : "61738cb65677c2451cb5c41e1a3bbc",
        "did": "5115990249",
        "world": "100006",
        "language": "ko",
        "hive_country": "KO",
        "age_gate_u13": false
    },
    "game": {
        "appid": "com.com2us.hivesdk.normal.freefull.google.global.android.common",
        "app_version": "1.1"
    },
    "promotion": {
        "type_camp": "all",
        "type_banner": "small"
    }
}' \
-H "Content-Type: application/json" \
https://sandbox-promotion.qpyou.cn/api/banner

> POST /api/banner HTTP/1.1
> User-Agent: curl/7.29.0
> Host: sandbox-promotion.qpyou.cn
> Accept: /    > Content-Type: application/json
> Content-Length: 292

• การตอบสนอง (ค่าของ type_banner ใน Request Body คือ small: แบนเนอร์ปกติ, ข้อความแจ้งเตือน, แบนเนอร์เลื่อน)

• Result code
<

รหัส	ข้อความ	คำอธิบาย
200	สำเร็จ	การส่งข้อมูลสำเร็จ

• Response Example (แบนเนอร์ปกติ, ข้อความแจ้งเตือน, แบนเนอร์เลื่อน)

  < HTTP/1.1 200 OK
  < Server: nginx
  < Date: Tue, 15 Mar 2022 03:22:54 GMT
  < Content-Type: text/html; charset=UTF-8
  {
          "banner": [
                  {
                          "pid": "202456",
                          "image": "http://hive-fn.qpyou.cn/hivepromotion/banner/2008/6227_1598855945930_crosscopy.jpg",
                          "link": "http://test-promotion.qpyou.cn/news/direct/202456",
                          "start_date": "2020-08-31 15:32:00",
                          "end_date": "2023-08-10 18:30:00",
                          "start_unixtimestamp": 1598855520,
                          "end_unixtimestamp": 1691659800,
                          "type_link": "market",
                          "type_banner": "small",
                          "type_camp": "cross",
                          "interwork_data": null,
                          "badge": {
                                  "title": "ระยะเวลาการเก็บของขวัญ",
                                  "type": "gift",
                                  "start_date": "2023-03-23T16:30:00+09:00",
                                  "end_date": "2023-10-28T16:25:00+09:00",
                                  "start_unixtimestamp": 1679556600,
                                  "end_unixtimestamp": 1698477900
                          }
                  {
                          "pid": "203408",
                          "image": "http://hive-fn.qpyou.cn/hivepromotion/banner/2302/3064_1675413872939_5017_1649923083718_0418_one_640_ko.jpg",
                          "link": "",
                          "start_date": "2023-02-03 16:30:00",
                          "end_date": "2023-02-06 17:43:00",
                          "start_unixtimestamp": 1675409400,
                          "end_unixtimestamp": 1675672980,
                          "type_link": "none",
                          "type_banner": "small",
                          "type_camp": "cross",
                          "interwork_data": null,
                          "badge" : null
                  },
                  {
                          "pid": "203392",
                          "image": "http://hive-fn.qpyou.cn/hivepromotion/banner/2301/5210_1675144150263_landscape.png",
                          "link": "http://test-promotion.qpyou.cn/news/direct/203392",
                          "start_date": "2023-01-31 14:48:00",
                          "end_date": "2023-02-28 14:48:00",
                          "start_unixtimestamp": 1675144080,
                          "end_unixtimestamp": 1677563280,
                          "type_link": "interwork",
                          "type_banner": "small",
                          "type_camp": "event",
                          "interwork_data": {
                                  "api": "/language",
                                  "param": "param=japanese"
                          },
                          "badge" : null
                  }
          ],
          "count": 3,
          "notice": [
                  {
                          "nid": "96274",
                          "notice_type": "notice",
                          "title": "all23",
                          "link": "http://test-promotion.qpyou.cn/news/notice/96274",
                          "start_date": "2022-07-14 09:55:00",
                          "end_date": "9999-12-31 00:00:00",
                          "start_unixtimstamp": 1657760100,
                          "end_unixtimstamp": 253402182000,
                          "view_count": "0",
                          "game_index": "2790",
                          "language": "ko"
                  },
                  {
                          "nid": "70268",
                          "notice_type": "event",
                          "title": "test",
                          "link": "http://test-promotion.qpyou.cn/news/notice/70268",
                          "start_date": "2020-10-01 11:12:00",
                          "end_date": "9999-12-31 00:00:00",
                          "start_unixtimstamp": 1601518320,
                          "end_unixtimstamp": 253402182000,
                          "view_count": "0",
                          "game_index": "2790",
                          "language": "ko"
                  }
          ],
          "notice_count": 2,
          "rolling": [
                  {
                          "pid": "202855",
                          "image": "http://hive-fn.qpyou.cn/hivepromotion/banner/2212/9529_1672308134293_2206_1620884709352_1206_1609131801104_pngitem_1172768.png",
                          "link": "http://test-promotion.qpyou.cn/news/direct/202855",
                          "start_date": "2021-05-13 14:44:00",
                          "end_date": "2023-05-19 14:44:00",
                          "start_unixtimestamp": 1620884640,
                          "end_unixtimestamp": 1684475040,
                          "type_link": "webview",
                          "type_banner": "small",
                          "type_camp": "notice",
                          "interwork_data": null ,
                          "badge" : null
                  }
          ],
          "rolling_count": 1,
          "result_code": 200,
          "result_message": "สำเร็จ."
  }
  

• Response (ค่า type_banner ใน Request Body คือ great หรือ rolling: แบนเนอร์ระหว่างหน้าหรือแบนเนอร์เลื่อน)

  ชื่อฟิลด์	คำอธิบาย	ประเภท	จำเป็น
  result_code	รหัสการตอบกลับ 200: การตรวจสอบสำเร็จ อื่นๆ: ล้มเหลว	String	Y
  result_message	ข้อความการตอบกลับ	String	Y
  count	จำนวนแบนเนอร์	Integer	Y
  banner	รายการแบนเนอร์ อาร์เรย์จะว่าง([]) หากไม่มีการลงทะเบียนแบนเนอร์。	Array	Y
  ㄴ pid	รหัสแคมเปญส่งเสริมการขาย	String	N
  ㄴ image	URL ของภาพแบนเนอร์แคมเปญ	String	N
  ㄴ link	URL ที่เปิดเมื่อผู้ใช้คลิกแบนเนอร์แคมเปญ	String	N
  ㄴ start_date	วันที่เริ่มต้นของแคมเปญ	String	N
  ㄴ end_date	วันที่สิ้นสุดของแคมเปญ	String	N
  ㄴ start_unixtimestamp	เวลาที่เริ่มต้นของแคมเปญ (Unix timestamp)	Integer	N
  ㄴ end_unixtimestamp	เวลาที่สิ้นสุดของแคมเปญ (Unix timestamp)	Integer	N
  ㄴ type_link	ประเภทที่จะเปิดหน้าเมื่อผู้ใช้คลิกแบนเนอร์แคมเปญ (เลือกเมื่อทำการลงทะเบียนแคมเปญ) webview: เปิดลิงก์ภายใน webbrowser: เปิดลิงก์ภายนอก market: เปิดหน้าตลาด (App Store) notice: เปิดหน้าประกาศ text: เปิดข้อความประกาศส่งเสริมการขาย interwork: ย้ายไปยังหน้าที่กำหนดในเกม none: อยู่บนหน้าเดิม	String	N
  ㄴ interwork_data	ให้ API และพารามิเตอร์เพื่อย้ายไปยังหน้าที่เฉพาะในเกม (NULL หากไม่มีข้อมูล)	Object	N
  ㄴㄴ api	API URI	String	N
  ㄴㄴ param	ค่าพารามิเตอร์ในสตริงคำถามที่จะใช้ใน URI ของ API	String	N
  ㄴ type_banner	ประเภทแบนเนอร์แคมเปญ great: แบนเนอร์แบบเต็มหน้าจอ small: แบนเนอร์ปกติ (แบนเนอร์แบบแถบ) rolling: แบนเนอร์แบบเลื่อน	String	N
  ㄴ type_camp	ประเภทแคมเปญส่งเสริมการขาย (เลือกหรือป้อนโดยตรงเมื่อทำการลงทะเบียนแคมเปญใน Hive Console) event: ประเภทเหตุการณ์ notice: ประเภทประกาศ permit: แบนเนอร์การตรวจสอบ cross: แบนเนอร์ข้าม	String	N
  ㄴ badge	ข้อมูลของแบดจ์ที่แจ้งเตือนเหตุการณ์จะสิ้นสุดในไม่ช้า และแบดจ์ที่แจ้งเตือนช่วงเวลาที่สามารถรับของขวัญได้ แบนเนอร์เลื่อนและแบนเนอร์ระหว่างหน้าจะคืนค่า NULL เสมอ。	วัตถุ	N
  ㄴㄴ title	ข้อความในป้าย	String	N
  ㄴㄴ type	ประเภทของป้ายที่แสดง shutdown: ป้ายที่แจ้งเตือนถึงการสิ้นสุดของเหตุการณ์ที่ใกล้เข้ามา gift: ป้ายที่แจ้งเตือนถึงระยะเวลาที่สามารถรับของขวัญได้	String	N
  ㄴㄴ start_date	วันที่เริ่มต้นของการแสดงแบดจ์ (รูปแบบ ISO-8601)	สตริง	ไม่
  ㄴㄴ end_date	วันที่สิ้นสุดของการแสดงตรา (รูปแบบ ISO-8601)	String	N
  ㄴㄴ start_unixtimestamp	เวลาที่เริ่มต้นของการแสดงแบดจ์ (Unix timestamp)	จำนวนเต็ม	N
  ㄴㄴ end_unixtimestamp	เวลาสิ้นสุดของการแสดงแบดจ์ (Unix timestamp)	จำนวนเต็ม	N

• Result code
<

รหัส	ข้อความ	คำอธิบาย
200	สำเร็จ	การส่งข้อมูลสำเร็จ

• Response Example (แบนเนอร์ระหว่างการแทรกหรือแบนเนอร์เลื่อน)

  < HTTP/1.1 200 OK
  < Server: nginx
  < Date: Tue, 15 Mar 2022 03:22:54 GMT
  < Content-Type: text/html; charset=UTF-8
  {
          "banner": [
                  {
                          "pid": "203327",
                          "image": "http://hive-fn.qpyou.cn/hivepromotion/banner/2212/2242_1671774095448_9554_1659585211300_pet3.png",
                          "link": "http://test-promotion.qpyou.cn/news/direct/203327",
                          "start_date": "2022-12-23 14:39:00",
                          "end_date": "2024-01-28 14:39:00",
                          "start_unixtimestamp": 1671773940,
                          "end_unixtimestamp": 1706420340,
                          "type_link": "market",
                          "type_banner": "great",
                          "type_camp": "cross",
                          "interwork_data": null,
                          "badge" : null
                  },
                  {
                          "pid": "200903",
                          "image": "http://hive-fn.qpyou.cn/hivepromotion/banner/2007/4544_1593745965875_4221_1530011573_nuclear_h480.jpg",
                          "link": "http://test-promotion.qpyou.cn/news/direct/200903",
                          "start_date": "2018-06-26 20:10:00",
                          "end_date": "2026-06-26 20:10:00",
                          "start_unixtimestamp": 1530011400,
                          "end_unixtimestamp": 1782472200,
                          "type_link": "market",
                          "type_banner": "great",
                          "type_camp": "cross",
                          "interwork_data": null,
                          "badge" : null
                  },
                  {
                          "pid": "202666",
                          "image": "http://hive-fn.qpyou.cn/hivepromotion/banner/2101/9377_1611539481422_inlink_800_ko.png",
                          "link": "http://test-promotion.qpyou.cn/news/direct/202666",
                          "start_date": "2022-11-24 17:00:00",
                          "end_date": "2025-01-31 16:49:00",
                          "start_unixtimestamp": 1669276800,
                          "end_unixtimestamp": 1738309740,
                          "type_link": "webview",
                          "type_banner": "great",
                          "type_camp": "event",
                          "interwork_data": null,
                          "badge" : null
                  },
                  {
                          "pid": "202667",
                          "image": "http://hive-fn.qpyou.cn/hivepromotion/banner/2202/4588_1645527513984_4656_1643264582739_200225_smon_800_ko.png",
                          "link": "http://test-promotion.qpyou.cn/news/direct/202667",
                          "start_date": "2021-01-21 16:54:00",
                          "end_date": "2023-12-27 16:54:00",
                          "start_unixtimestamp": 1611215640,
                          "end_unixtimestamp": 1703663640,
                          "type_link": "webbrowser",
                          "type_banner": "great",
                          "type_camp": "event",
                          "interwork_data": null,
                          "badge" : null
                  },
                  {
                          "pid": "202668",
                          "image": "http://hive-fn.qpyou.cn/hivepromotion/banner/2101/5562_1611216401413_marketlink_800_ko.png",
                          "link": "http://test-promotion.qpyou.cn/news/direct/202668",
                          "start_date": "2021-01-21 17:02:00",
                          "end_date": "2025-01-31 17:02:00",
                          "start_unixtimestamp": 1611216120,
                          "end_unixtimestamp": 1738310520,
                          "type_link": "webview",
                          "type_banner": "great",
                          "type_camp": "event",
                          "interwork_data": {
                                  "api": "/openurl",
                                  "param": "rurl=https%3A%2F%2Fqa-renew-community.summonerswar.com%2Fchronicles%2Fko-kr%2Fboard%2Fdetail%2F22%2F14002"
                          },
                          "badge" : null
                  }
          ],
          "count": 5,
          "result_code": 200,
          "result_message": "Success."
  }