สอบถามคุณสมบัติผู้ใช้

นักพัฒนาสามารถสอบถามคุณสมบัติของผู้ใช้ได้โดยระบุ user ID หรือ anonymous user ID รองรับการสอบถามแบบกลุ่ม (batch) สูงสุด 100 user ID หรือ anonymous user ID ต่อคำขอ

วิธีการร้องขอ (Request Method)

GET

URL สำหรับร้องขอ (Request URL)

https://api-${endpoint}.gptbots.ai/v2/user-property/query

การยืนยันตัวตน (Authentication)

โปรดดูรายละเอียดที่ ภาพรวม ใน API Reference

การร้องขอ (Request)

ตัวอย่างการร้องขอ (Request Example)

curl -X GET 'https://api-${endpoint}.gptbots.ai/v2/user-property/query' \ -H 'Authorization: Bearer ${token}' \ -d '{ "user_ids": [ "example_user_id_1", "example_user_id_2" ], "anonymous_ids": [ "example_anonymous_id_1", "example_anonymous_id_2" ] }'

                      
                      curl -X GET 'https://api-${endpoint}.gptbots.ai/v2/user-property/query'  \
-H 'Authorization: Bearer ${token}' \
-d '{
      "user_ids": [
        "example_user_id_1",
        "example_user_id_2"
      ],
      "anonymous_ids": [
        "example_anonymous_id_1",
        "example_anonymous_id_2"
      ]
}'

บล็อกโค้ดนี้ในหน้าต่างลอย

ส่วนหัวของคำขอ (Request Headers)

ชื่อฟิลด์	ประเภท	คำอธิบาย
Authorization	Bearer ${API Key}	ใช้สำหรับยืนยันตัวตนด้วย Authorization: Bearer ${API Key} สามารถรับ token ได้จากหน้า API Keys

เนื้อหาคำขอ (Request Body)

พารามิเตอร์	ประเภท	คำอธิบาย	จำเป็นต้องใส่หรือไม่
user_ids	string	User ID ที่ต้องการสอบถามคุณสมบัติ	จำเป็น, ใช้แทนกับ anonymous_ids
anonymous_ids	string	Anonymous user ID ที่ต้องการสอบถามคุณสมบัติ	จำเป็น, ใช้แทนกับ user_ids

ต้องระบุอย่างใดอย่างหนึ่งระหว่าง user_ids หรือ anonymous_ids หากระบุทั้งสอง user_ids จะมีลำดับความสำคัญมากกว่า

การตอบกลับ (Response)

ตัวอย่างเนื้อหาการตอบกลับ (Response Body)

{ { "user_id": "example_user_id_1", "property_values": [ { "property_name": "example_property_name", "value": "example_value" }, { "property_name": "example_property_name", "value": "example_value" } ] }, { "anonymous_id": "example_anonymous_id_2", "property_values": [ { "property_name": "example_property_name", "value": "example_value" }, { "property_name": "example_property_name", "value": "example_value" } ] } }

                      
                      {
  {
    "user_id": "example_user_id_1",
    "property_values": [
      {
        "property_name": "example_property_name",
        "value": "example_value"
      },
      {
        "property_name": "example_property_name",
        "value": "example_value"
      }
    ]
  },
  {
    "anonymous_id": "example_anonymous_id_2",
    "property_values": [
      {
        "property_name": "example_property_name",
        "value": "example_value"
      },
      {
        "property_name": "example_property_name",
        "value": "example_value"
      }
    ]
  }
}

บล็อกโค้ดนี้ในหน้าต่างลอย

การตอบกลับเมื่อสำเร็จ (Successful Response)

พารามิเตอร์	ประเภท	คำอธิบาย
user_id	string	User ID ที่สอบถาม
anonymous_id	string	Anonymous user ID ที่สอบถาม
property_values	list	รายการคุณสมบัติผู้ใช้และค่าของแต่ละคุณสมบัติสำหรับ user_id
property_name	string	ชื่อของคุณสมบัติผู้ใช้
value	object	ค่าของคุณสมบัติผู้ใช้

การตอบกลับเมื่อเกิดข้อผิดพลาด (Error Response)

พารามิเตอร์	ประเภท	คำอธิบาย
code	int	รหัสข้อผิดพลาด
message	string	ข้อความข้อผิดพลาด

รหัสสถานะ (Status Codes)

รหัสสถานะ	คำอธิบาย
200	สำเร็จ
400	พารามิเตอร์ไม่ถูกต้อง
401	ไม่มีสิทธิ์เข้าถึง
403	ถูกปฏิเสธการเข้าถึง
500	ข้อผิดพลาดของเซิร์ฟเวอร์
503	ไม่พบ User ID
504	ไม่พบ Anonymous User ID