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

บันทึกการดึงข้อมูล

การวิเคราะห์ช่วยให้คุณสามารถสอบถามข้อมูลที่รวบรวมใน BigQuery ผ่าน API

อ้างอิง: Analytics Operation Structure

การเตรียมการ

ในการใช้ API การสอบถามข้อมูล คุณต้องกรอกใบสมัครสำหรับ API การสอบถามบันทึกผ่านเมนู Hive Console → Analytics → Log Definition เมื่อกรอกใบสมัครเสร็จแล้ว AccessKey และ SecondAccessKey จะถูกออกให้สำหรับบันทึกที่คุณสามารถสอบถามได้ ทั้ง AccessKey และ SecondAccessKey ทำงานเหมือนกัน โดย SecondAccessKey เป็นกุญแจเพิ่มเติมที่ออกให้ใช้เมื่อมีปัญหากับ AccessKey

※ AccessKey และ SecondAccessKey ควรเก็บเป็นความลับและไม่ควรเปิดเผยต่อสาธารณะ ※ หาก AccessKey หรือ SecondAccessKey ถูกเปิดเผย จะต้องรีเฟรชหรือเพิกถอนทันที

วิธีการสมัครใช้ Data Query OpenAPI

เลือกเกมที่คุณต้องการออก AccessKey ในเมนูการกำหนดล็อก จากนั้นคลิกที่ชื่อล็อกที่คุณต้องการออกเพื่อเข้าสู่หน้ารายละเอียด คลิกที่ปุ่ม 'สมัคร OpenAPI' และจากนั้นกดปุ่ม 'ยืนยัน' เพื่อออกคีย์

วิธีการต่ออายุหรือเพิกถอน AccessKey

เลือกเกมที่คุณต้องการต่ออายุหรือเพิกถอน AccessKey ในเมนู Log Definition จากนั้นคลิกที่ชื่อบันทึกเพื่อเข้าสู่หน้ารายละเอียด ต่ออายุ: คลิกปุ่ม 'ต่ออายุ' เพื่อออก AccessKey ใหม่ และ AccessKey ที่ออกก่อนหน้านี้จะไม่สามารถใช้งานได้อีกต่อไป เพิกถอน: คลิกปุ่ม 'เพิกถอน' เพื่อลบ AccessKey ที่มีอยู่ และคีย์นี้จะไม่สามารถใช้งานได้อีกต่อไป

ข้อมูล API ทั่วไป

ประเภทบริการ โดเมน
การผลิต analytics-openapi.com2us.com
Sandbox sandbox-analytics-openapi.com2us.com


  • พารามิเตอร์หัวข้อที่จำเป็น: X-Analyitcs-Accesskey คุณต้องรวมค่าคีย์นี้ในส่วนหัวของคำขอเพื่อยืนยันสิทธิ์การเข้าถึงสำหรับการสอบถามข้อมูล OpenAPI.

API การสอบถามข้อมูล

  • URL: https://{domain}/data/query/{logName}

  • คำอธิบาย: ดึงข้อมูลที่ตรงกับเงื่อนไขการค้นหาที่กำหนด

คำขอ (POST, application/json)

ชื่อ ประเภท จำเป็น คำอธิบาย ตัวอย่าง
startDate STRING O เวลาเริ่มต้นการค้นหาใน UTC (รูปแบบ: yyyy-MM-dd hh:mm:ss) (จำเป็นหากส่งค่าถัดไป: ไม่) 2024-01-01 00:00:00
endDate STRING O เวลาสิ้นสุดการค้นหาใน UTC (รูปแบบ: yyyy-MM-dd hh:mm:ss) (จำเป็นหากส่งค่าถัดไป: ไม่) 2024-01-02 00:00:00
properties JSON X เงื่อนไขการค้นหาในรูปแบบ JSON {ชื่อฟิลด์ BigQuery: ค่าการค้นหา, ...} {"vid":123, "market":"A"}
QueryType STRING X "0": รวมเฉพาะฟิลด์ที่กำหนดเอง, "1": รวมทุกฟิลด์ (ค่าเริ่มต้น: "0") "0"
nextPageToken STRING X ค่าตัวระบุเพื่อดึงข้อมูลหน้าถัดไป คืนค่าข้อมูล 20 รายการต่อหน้า ไม่ต้องการพารามิเตอร์อื่นเมื่อค้นหาด้วยค่าดังกล่าว f3ebf4b6859a4f248b283a4fff1ded13

การตอบกลับ (application/json)

ชื่อ ประเภท คำอธิบาย ตัวอย่าง
totalRows INTEGER จำนวนแถวทั้งหมดในผลการค้นหา 123
nextPageToken STRING โทเค็นสำหรับการดึงหน้าถัดไป * หากเป็นหน้าสุดท้าย, null f3ebf4b6859a4f248b283a4fff1ded13
datas LIST[JSON] ข้อมูลที่ดึงมา [ { "dateTime": "2024-01-01T23:38:24Z", "vid": 123, "characterLv": 1 }, ... ]

ตัวอย่างคำขอ

curl -X 'POST' \
'https://sandbox-analytics-openapi.com2us.com/data/query/hive_login_log' \
-H 'accept: application/json' \
-H 'X-Analyitcs-Accesskey: Your access key' \
-H 'Content-Type: application/json' \
-d '{
"startDate": "2024-04-16 00:00:00",
"endDate": "2024-04-17 00:00:00"
}'

API ตรวจสอบข้อมูล

  • URL: https://{domain}/data/check/{logName}
  • คำอธิบาย: ตรวจสอบว่ามีบันทึกที่ตรงกับเกณฑ์การค้นหาหรือไม่ใน BigQuery ภายในปีที่ผ่านมา.

คำขอ (POST, application/json)

ชื่อ ประเภท จำเป็น คำอธิบาย ตัวอย่าง
properties JSON O เงื่อนไขการค้นหาในรูปแบบ JSON {ชื่อฟิลด์ BigQuery: ค่าการค้นหา, ...} {"guid":"52e10350-fe3d-487f-8631-1dc640010c87"}

การตอบสนอง (application/json)

ชื่อ ประเภท คำอธิบาย ตัวอย่าง
isExists BOOLEAN ข้อมูลมีอยู่หรือไม่ true
datas LIST[JSON] ค่าตัวอย่างล่าสุด 5 ค่า ของข้อมูลที่มีอยู่ รวมถึงค่า dateTime และ guid พร้อมกับค่าฟิลด์ที่ตรงกับเกณฑ์การค้นหา. [ { "vid": 123, "dateTime": "2024-04-16T23:09:24Z", "guid": "52e10350-fe3d-487f-8631-1dc640010c87" }, ... ]

ตัวอย่างคำขอ

curl -X 'POST' \
'https://sandbox-analytics-openapi.com2us.com/data/check/hive_login_log' \
-H 'accept: application/json' \
-H 'X-Analyitcs-Accesskey: Your access key' \
-H 'Content-Type: application/json' \
-d '{
"properties": {"guid":"52e10350-fe3d-487f-8631-1dc640010c87"}
}'

รหัสข้อผิดพลาด

สำหรับข้อมูลรายละเอียดเกี่ยวกับรหัสข้อผิดพลาดแต่ละรหัส โปรดดูข้อความรายละเอียดในค่าที่ส่งกลับ

  • 40x: ข้อผิดพลาดของกุญแจการเข้าถึง
    • กุญแจการเข้าถึงต้องตรงกับกุญแจการเข้าถึงสำหรับบริษัท เกม และชื่อบันทึกที่คุณพยายามสอบถาม หากเกิดข้อผิดพลาดนี้ คุณต้องตรวจสอบว่ากุญแจการเข้าถึงถูกต้อง
  • 50x: ข้อผิดพลาดของระบบ
    • ข้อผิดพลาดที่เกิดขึ้นระหว่างการดึงข้อมูลและการประมวลผล
    • ตรวจสอบให้แน่ใจว่าชื่อฟิลด์หรือประเภทค่าที่อยู่ในเงื่อนไขการสอบถามถูกต้อง
    • หากรายละเอียดระบุว่า "ข้อผิดพลาดของระบบ" ซึ่งหมายถึงข้อผิดพลาดที่ไม่ทราบ โปรดลองอีกครั้งหลังจากผ่านไปสักครู่