ร้านข้อมูลที่จัดเรียงแล้ว (เวอร์ชัน Beta)

*เนื้อหานี้แปลโดยใช้ AI (เวอร์ชัน Beta) และอาจมีข้อผิดพลาด หากต้องการดูหน้านี้เป็นภาษาอังกฤษ ให้คลิกที่นี่

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

OrderedDataStores

https://apis.roblox.com/ordered-data-stores

รายการ

GET /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries

คืนรายการของรายการจากคลังข้อมูลที่สั่งซื้อ

พารามิเตอร์

universeId string

รหัสระบุประสบการณ์ที่มีคลังข้อมูลที่สั่งซื้อที่คุณต้องการเข้าถึงดู ID จักรวาล เกี่ยวกับวิธีการคัดลอกบน แดชบอร์ดของผู้สร้าง

Path
จำเป็นต้องมี
orderedDataStore string

ร้านค้า

Path
จำเป็นต้องมี
scope string

ชื่อของสเกลของคลังข้อมูล ดู สเกล

Path
จำเป็นต้องมี
max_page_size number

จํานวนเรื่องสูงสุดที่จะส่งคืนบริการอาจส่งคืนน้อยกว่าค่านี้ค่าเริ่มต้นคือ 10 .ค่าสูงสุดคือ 100 และการใส่ข้อมูลใดๆ ที่มากกว่า 100 จะถูกบังคับให้เป็น 100

page_token string

โทเค็นหน้าที่ได้รับจากการโทรก่อนหน้า List ครั้งให้สิ่งนี้เพื่อดึงหน้าต่อไปเมื่อจัดหน้า พารามิเตอร์อื่น ๆ ทั้งหมดที่ให้กับ List จะต้องตรงกับการโทรที่ให้โทเค็นหน้า

order_by string

ทิศทางการจัดเรียง ลำดับเริ่มต้นคือการเพิ่มขึ้น ใส่สuffix desc สำหรับการลดลง

filter string

ช่วงของค่าที่มีคุณสมบัติของรายการที่จะส่งคืน ดู ตัวกรอง

คำขอ

curl
curl --location 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries' \

 --header 'x-api-key: <insert-api-key>'

การตอบกลับ

200 - OK
OK
ส่งคืน object
entries array<object>

รายการจากขอบเขตที่ระบุ

nextPageToken string

โทเคนซึ่งสามารถส่งเป็น page_token เพื่อดึงหน้าถัดไป หากฟิลด์นี้ถูกข้ามไป จะไม่มีหน้าต่อไป

สิทธิ์ที่ต้องมี

ต้องมีสิทธิ์เข้าถึงคีย์ API ต่อไปนี้เพื่อเรียกใช้ Endpoint นี้ ดูข้อมูล เพิ่มเติมเกี่ยวกับการสร้างคีย์ที่เหมาะสมได้ที่จัดการคีย์ API

  • อ่าน

สร้าง

POST /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries

สร้างบันทึกใหม่ด้วยค่าเนื้อหาที่ให้ไว้

พารามิเตอร์

universeId string

รหัสระบุประสบการณ์ที่มีคลังข้อมูลที่สั่งซื้อที่คุณต้องการเข้าถึงดู ID จักรวาล เกี่ยวกับวิธีการคัดลอกบน แดชบอร์ดของผู้สร้าง

Path
จำเป็นต้องมี
orderedDataStore string

ร้านค้า

Path
จำเป็นต้องมี
scope string

ชื่อของสเกลของคลังข้อมูล ดู สเกล

Path
จำเป็นต้องมี
id string

ชื่อของรายการ

จำเป็นต้องมี

คำขอ

curl
curl --location 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries?id=<id>' \

--header 'x-api-key: <insert-api-key>' \

--header 'Content-Type: application/json' \

--data '{ 

    "value": <long> 

}'

การตอบกลับ

200 - OK
OK
ส่งคืน object
id string

ชื่อของรายการ

path string

เส้นทางทรัพยากรของคำขอ

value number

มูลค่าของรายการ

สิทธิ์ที่ต้องมี

ต้องมีสิทธิ์เข้าถึงคีย์ API ต่อไปนี้เพื่อเรียกใช้ Endpoint นี้ ดูข้อมูล เพิ่มเติมเกี่ยวกับการสร้างคีย์ที่เหมาะสมได้ที่จัดการคีย์ API

  • เขียน

รับ

GET /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries/{entry}

รับและส่งคืนรายการที่ระบุ

พารามิเตอร์

universeId string

รหัสระบุประสบการณ์ที่มีคลังข้อมูลที่สั่งซื้อที่คุณต้องการเข้าถึงดู ID จักรวาล เกี่ยวกับวิธีการคัดลอกบน แดชบอร์ดของผู้สร้าง

Path
จำเป็นต้องมี
orderedDataStore string

ร้านค้า

Path
จำเป็นต้องมี
scope string

ชื่อของสเกลของคลังข้อมูล ดู สเกล

Path
จำเป็นต้องมี
entry string

ID ของรายการ

Path
จำเป็นต้องมี

คำขอ

curl
curl --location 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries/<entry>' \

 --header 'x-api-key: <insert-api-key>'

การตอบกลับ

200 - OK
OK
ส่งคืน object
id string

ชื่อของรายการ

path string

เส้นทางทรัพยากรของคำขอ

value number

มูลค่าของรายการ

สิทธิ์ที่ต้องมี

ต้องมีสิทธิ์เข้าถึงคีย์ API ต่อไปนี้เพื่อเรียกใช้ Endpoint นี้ ดูข้อมูล เพิ่มเติมเกี่ยวกับการสร้างคีย์ที่เหมาะสมได้ที่จัดการคีย์ API

  • อ่าน

ลบ

DELETE /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries/{entry}

ลบรายการที่ระบุ

พารามิเตอร์

universeId string

รหัสระบุประสบการณ์ที่มีคลังข้อมูลที่สั่งซื้อที่คุณต้องการเข้าถึงดู ID จักรวาล เกี่ยวกับวิธีการคัดลอกบน แดชบอร์ดของผู้สร้าง

Path
จำเป็นต้องมี
orderedDataStore string

ร้านค้า

Path
จำเป็นต้องมี
scope string

ชื่อของสเกลของคลังข้อมูล ดู สเกล

Path
จำเป็นต้องมี
entry string

ID ของรายการ

Path
จำเป็นต้องมี

คำขอ

curl
curl --location --request DELETE 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries/<entry>' \

 --header 'x-api-key: <insert-api-key>'

การตอบกลับ

สิทธิ์ที่ต้องมี

ต้องมีสิทธิ์เข้าถึงคีย์ API ต่อไปนี้เพื่อเรียกใช้ Endpoint นี้ ดูข้อมูล เพิ่มเติมเกี่ยวกับการสร้างคีย์ที่เหมาะสมได้ที่จัดการคีย์ API

  • เขียน

อัปเดต

PATCH /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries/{entry}

อัปเดตมูลค่าเข้าและส่งคืนเข้าที่อัปเดตแล้ว

พารามิเตอร์

universeId string

รหัสระบุประสบการณ์ที่มีคลังข้อมูลที่สั่งซื้อที่คุณต้องการเข้าถึงดู ID จักรวาล เกี่ยวกับวิธีการคัดลอกบน แดชบอร์ดของผู้สร้าง

Path
จำเป็นต้องมี
orderedDataStore string

ร้านค้า

Path
จำเป็นต้องมี
scope string

ชื่อของสเกลของคลังข้อมูล ดู สเกล

Path
จำเป็นต้องมี
entry string

ID ของรายการ

Path
จำเป็นต้องมี
allow_missing boolean

ธงที่อนุญาตให้สร้างบันทึกหากบันทึกไม่มีอยู่ ดู อนุญาตธงที่หายไป

คำขอ

curl
curl --location --request PATCH 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries/<entry>' \

--header 'x-api-key: <insert-api-key>' \

--header 'Content-Type: application/json' \

--data '{ 

    "value": <long> 

}'

การตอบกลับ

200 - OK
OK
ส่งคืน object
id string

ชื่อของรายการ

path string

เส้นทางทรัพยากรของคำขอ

value number

มูลค่าของรายการ

สิทธิ์ที่ต้องมี

ต้องมีสิทธิ์เข้าถึงคีย์ API ต่อไปนี้เพื่อเรียกใช้ Endpoint นี้ ดูข้อมูล เพิ่มเติมเกี่ยวกับการสร้างคีย์ที่เหมาะสมได้ที่จัดการคีย์ API

  • เขียน

การเพิ่มขึ้น

POST /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries/{entry}:increment

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

ปัญหาที่รู้จัก: ค่าเข้าสามารถเพิ่มขึ้นเกินขอบเขตที่ถูกต้องและอาจยังคงอยู่ในแบ็คเอนด์ ค่าที่ส่งคืนจะติดกับขอบเขตที่ถูกต้อง

พารามิเตอร์

universeId string

รหัสระบุประสบการณ์ที่มีคลังข้อมูลที่สั่งซื้อที่คุณต้องการเข้าถึงดู ID จักรวาล เกี่ยวกับวิธีการคัดลอกบน แดชบอร์ดของผู้สร้าง

Path
จำเป็นต้องมี
orderedDataStore string

ร้านค้า

Path
จำเป็นต้องมี
scope string

ชื่อของสเกลของคลังข้อมูล ดู สเกล

Path
จำเป็นต้องมี
entry string

ID ของรายการ

Path
จำเป็นต้องมี

คำขอ

curl
curl --location 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries/<entry>:increment' \

--header 'x-api-key: <insert-api-key>' \

--header 'Content-Type: application/json' \

--data '{ 

    "amount": <long> 

}'

การตอบกลับ

200 - OK
OK
ส่งคืน object
id string

ชื่อของรายการ

path string

เส้นทางทรัพยากรของคำขอ

value number

มูลค่าของรายการ

สิทธิ์ที่ต้องมี

ต้องมีสิทธิ์เข้าถึงคีย์ API ต่อไปนี้เพื่อเรียกใช้ Endpoint นี้ ดูข้อมูล เพิ่มเติมเกี่ยวกับการสร้างคีย์ที่เหมาะสมได้ที่จัดการคีย์ API

  • เขียน

วัตถุ

วัตถุต่อไปนี้ใช้บรรยายเพย์โหลดที่ยอมรับหรือส่งคืน ดูข้อมูลเพิ่มเติมว่าจะใช้วัตถุเหล่านี้ตอนไหนที่ Endpoint แต่ละจุด

CreateEntryRequest

สร้างบันทึกใหม่ด้วยค่าที่ให้ไว้

คุณลักษณะ

value number

มูลค่าที่จะตั้งค่าบันทึกใหม่หากมูลค่าอินพุตเกินมูลค่าสูงสุดที่สนับสนุนโดย int64 ซึ่งเป็น 9,223,372,036,854,775,807 คำขอจะล้มเหลวด้วยข้อผิดพลาด 400 Bad Request

Entry

แทนที่เป็นรายการ

คุณลักษณะ

id string

ชื่อของรายการ

path string

เส้นทางทรัพยากรของคำขอ

value number

มูลค่าของรายการ

IncrementEntryRequest

เพิ่มมูลค่าเข้าสู่รายการ

คุณลักษณะ

amount number

จำนวนที่จะเพิ่มขึ้นโดยมูลค่าเข้าหากมูลค่าอินพุตเกินมูลค่าสูงสุดที่สนับสนุนโดย int64 ซึ่งเป็น 9,223,372,036,854,775,807 คำขอจะล้มเหลวด้วยข้อผิดพลาด 400 Bad Request

ListEntriesResponse

คอลเล็กชัน

คุณลักษณะ

entries array<object>

รายการจากขอบเขตที่ระบุ

nextPageToken string

โทเคนซึ่งสามารถส่งเป็น page_token เพื่อดึงหน้าถัดไป หากฟิลด์นี้ถูกข้ามไป จะไม่มีหน้าต่อไป

UpdateEntryRequest

อัปเดตรายการที่ให้มาพร้อมกับค่าใหม่

คุณลักษณะ

value number

มูลค่าที่จะอัปเดตบันทึกหากมูลค่าอินพุตเกินมูลค่าสูงสุดที่สนับสนุนโดย int64 ซึ่งเป็น 9,223,372,036,854,775,807 คำขอจะล้มเหลวด้วยข้อผิดพลาด 400 Bad Request