ปลั๊กอินในสตูดิโอทำงานในแต่ละโมเดลข้อมูลของสตูดิโอที่ผู้ใช้เปิด รวมถึง
ทั้งโมเดลข้อมูลสำหรับแก้ไขและทดสอบเล่น `PluginConnection` จะช่วยให้
โมเดลข้อมูลเหล่านี้ที่มีปลั๊กอินเดียวกันสามารถสื่อสารข้ามขอบเขตของ
โมเดลข้อมูลได้
ข้อความที่ส่งโดย `Class.PluginConnection:SendMessage()` จะถูกส่งไปที่
โมเดลข้อมูลระยะไกลผ่านการเรียกกลับที่ปลั๊กอินเดียวกันลงทะเบียนไว้กับ
`Class.PluginConnection:BindToMessage()` แต่ละออปเจ็กต์ `PluginConnection`
สามารถส่งและรับข้อความในขณะที่เชื่อมต่อได้ และข้อความจะถูกส่งไปยัง
อย่างเชื่อถือได้และเป็นลำดับยกเว้นเมื่อการเชื่อมต่อหลุด (เช่น เนื่องจาก
โมเดลข้อมูลระยะไกลปิดตัวลง) ก่อนที่จะได้รับข้อความ

หมายเหตุว่าหากแม้ว่าหลายปลั๊กอินจะอาจจะแบ่งปัน `PluginConnection`
ออปเจ็กต์ที่เหมือนกัน แต่แต่ละบล็อกมีการเชื่อมต่อภายในของตนเอง; ปลั๊กอิน
แต่ละตัวจะได้รับเฉพาะข้อความของตัวเองในการเรียกกลับไปยัง
`BindToMessage()` แม้ว่าปลั๊กอินอื่นจะเรียก `SendMessage()`

ฟังก์ชันนี้ผูก callback กับการเชื่อมต่อนี้ ซึ่งจะถูกเรียกเมื่อการเชื่อมต่อรับข้อความจากปลั๊กอินปัจจุบันที่ทำงานในข้อมูลระยะไกล ข้อความที่ส่งไปยัง callback จะเหมือนกับข้อความที่ปลั๊กอินส่งไปยัง `SendMessage()` สิ่งนี้ `PluginConnection` จะรักษาข้อความใด ๆ ที่ได้รับก่อนที่ปลั๊กอินจะเรียก `BindToMessage()` และจะส่งข้อความเหล่านั้นทันทีเมื่อปลั๊กอินเรียก `BindToMessage()` ทุกปลั๊กอินสามารถผูกได้เพียงหนึ่ง callback ในแต่ละครั้ง。


PluginConnection:BindToMessage

callback

ฟังก์ชันที่รับสตริงหรือบัฟเฟอร์ซึ่งจะถูกเรียกเมื่อ
สิ่งนี้ `PluginConnection` รับข้อความ。


สิ่งนี้ `Datatype.RBXScriptConnection` แทนการผูกของ callback นี้กับ `PluginConnection` ให้ตัดการเชื่อมต่อเพื่อยกเลิกการผูก callback นี้จากการเชื่อมต่อ。


ผูก callback กับ `PluginConnection` นี้เพื่อรับข้อความจาก `SendMessage()`。


ฟังก์ชันนี้ส่งสตริงหรือบัฟเฟอร์ไปยังข้อมูลระยะไกล
callback ที่ลงทะเบียนใน `BindToMessage()` โดยอินสแตนซ์ของปลั๊กอินปัจจุบันที่ทำงานในข้อมูลระยะไกลจะถูกเรียกแบบอะซิงโครนัสพร้อมข้อความเป็นอาร์กิวเมนต์ของมัน。


PluginConnection:SendMessage

message

สตริงหรือบัฟเฟอร์ที่จะถูกส่ง。


ส่งข้อมูลไปยังข้อมูลระยะไกล。


PluginConnection

ถ้าจริง สิ่งนี้ `PluginConnection` จะยังคงเชื่อมต่อกับข้อมูลเป้าหมาย
และยังสามารถส่งข้อความไปยังข้อมูลนั้นและ
รับข้อความจากข้อมูลนั้นได้ ถ้าไม่จริง การเชื่อมต่อได้ถูกตัดขาดแล้ว
เมื่อขาดการเชื่อมต่อ สิ่งนี้ `PluginConnection` จะไม่สามารถเชื่อมต่อใหม่ได้
ดังนั้นค่าของ false ที่นี่แสดงว่าสามารถทิ้งสิ่งนี้ `PluginConnection`
ได้โดยปลอดภัยแล้ว。


PluginConnection.Connected

ว่าสิ่งนี้ `PluginConnection` ยังคงเชื่อมต่ออยู่หรือไม่。


สตริงนี้มีตัวระบุที่ไม่ซ้ำกันทั่วโลกสำหรับข้อมูลเป้าหมาย
ซึ่งจะเหมือนกันสำหรับการเชื่อมต่อปลั๊กอินใดๆ ที่มุ่งเป้าไปยังข้อมูลเดียวกัน
แม้ว่าการเชื่อมต่อเหล่านั้นจะมาจากข้อมูลที่แตกต่างกันก็ตาม สัมบัตินี้ไม่สามารถเปลี่ยนแปลงได้。


PluginConnection.TargetId

รหัสประจำตัวที่ไม่ซ้ำกันสำหรับข้อมูลเป้าหมาย。


สิ่งนี้ `Enum.PluginConnectionTargetType` บอกความสัมพันธ์ของข้อมูลเป้าหมาย
กับข้อมูลปัจจุบัน ตัวอย่างเช่น ค่าของ `Enum.PluginConnectionTargetType.Test`
หมายถึงข้อมูลเป้าหมายเป็นข้อมูลการทดสอบที่เกิดขึ้นจากข้อมูลนี้
ในทางกลับกัน ค่าของ `Enum.PluginConnectionTargetType.Edit`
หมายถึงข้อมูลเป้าหมายคือเซสชันการแก้ไขที่เกิดขึ้นจากข้อมูลการทดสอบนี้
สัมบัตินี้ไม่สามารถเปลี่ยนแปลงได้。


PluginConnection.Type

สิ่งนี้ `Enum.PluginConnectionTargetType` บอกความสัมพันธ์ของข้อมูลเป้าหมาย
กับข้อมูลปัจจุบัน。


ทำให้การเชื่อมต่อระหว่างโมเดลข้อมูลปัจจุบันและอีกโมเดลหนึ่งสำหรับ
การสื่อสารของปลั๊กอิน

`Object` เป็นคลาสพื้นฐานสำหรับทุกคลาสในลำดับชั้นคลาสของ Roblox.
ทุกคลาสอื่นที่ Roblox Engine กำหนดจะสืบทอดสมาชิกทั้งหมดของ `Object`.
ไม่สามารถสร้าง `Object` ได้โดยตรง.


ตัวอย่างนี้แสดงให้เห็นถึงความละเอียดอ่อนของเหตุการณ์ `Changed` บนวัตถุปกติ
และวัตถุ `Value`.


ตัวอย่างโค้ดนี้แสดงให้เห็นถึงเหตุการณ์ Changed ที่เกิดขึ้นภายในวัตถุหลัก。


เหตุการณ์นี้จะถูกเรียกทันทีหลังจากมีการเปลี่ยนแปลงคุณสมบัติของวัตถุ โดยมีข้อยกเว้นบางประการ (ดูด้านล่าง). ค่าที่ใหม่ของคุณสมบัติที่เปลี่ยนแปลงจะ **ไม่** ถูกส่งเป็นพารามิเตอร์. แทนที่จะใช้
`object[property]` เพื่อเข้าถึงมัน:

```
object.Changed:Connect(function(property)
	print("ค่าของคุณสมบัติใหม่คือ", object[property])
end)
```

- หากคุณสนใจเฉพาะการฟังการเปลี่ยนแปลงของคุณสมบัติที่เฉพาะเจาะจงหนึ่ง ให้พิจารณาใช้
  `Class.Object:GetPropertyChangedSignal()|GetPropertyChangedSignal()`
  แทน.
- หากต้องการฟังการเปลี่ยนแปลงในคุณสมบัติ ให้ดูที่
  `Class.Instance:GetAttributeChangedSignal()` และ
  `Class.Instance.AttributeChanged`.
- หากต้องการตรวจจับเมื่อเด็กถูกเพิ่มหรือลบ ให้ดูที่
  `Class.Instance.ChildAdded` และ
  `Class.Instance.ChildRemoved`.

สำหรับวัตถุ `Class.ValueBase` เช่น `Class.IntValue` และ
`Class.StringValue` จะมีการเรียกเหตุการณ์นี้เมื่อการเปลี่ยนแปลงคุณสมบัติ `Value` ของวัตถุถูกเกิดขึ้น. เพื่อจับการเปลี่ยนแปลงอื่นๆ ในวัตถุ `Class.ValueBase`, ให้ใช้ `Class.Object:GetPropertyChangedSignal()|GetPropertyChangedSignal()`.

#### ข้อจำกัด

เหตุการณ์นี้ **ไม่** ทำงานสำหรับการเปลี่ยนแปลงที่เกี่ยวข้องกับฟิสิกส์ แต่ถ้าหาก `Class.BasePart.CFrame|CFrame`,
`Class.BasePart.AssemblyLinearVelocity|AssemblyLinearVelocity`,
`Class.BasePart.AssemblyAngularVelocity|AssemblyAngularVelocity`,
`Class.BasePart.Position|Position`, หรือ
`Class.BasePart.Orientation|Orientation` ของ `Class.BasePart`
มีการเปลี่ยนแปลงเนื่องจากแรงโน้มถ่วง. เพื่อจับการเปลี่ยนแปลงในคุณสมบัติเหล่านี้ โปรดพิจารณาใช้เหตุการณ์ที่เกี่ยวข้องกับฟิสิกส์เช่น `Class.RunService.PreSimulation`.
และเหตุการณ์ `Changed` จะไม่ทำงานเมื่อ
`Class.BasePart.AssemblyMass|AssemblyMass` อัปเดตเนื่องจากการเปลี่ยนแปลงวัสดุ ขนาด หรือความหนาแน่นของพาร์ทที่เชื่อมต่อ (แต่เหตุการณ์นี้จะทำงานสำหรับ
`Class.BasePart.Mass|Mass` หากคุณปรับขนาดของพาร์ท).

สำหรับคุณสมบัติที่เปลี่ยนแปลงอย่างบ่อยๆ, เหตุการณ์ `Changed` อาจไม่ถูกเรียกสำหรับการปรับเปลี่ยนทุกครั้ง หรืออาจไม่เกิดขึ้นเลย. **หากการเปลี่ยนแปลงของคุณสมบัติ
มีผลต่อกลไกของเกมของคุณ, โปรดทดสอบอย่างระมัดระวัง** เพื่อให้แน่ใจว่าเหตุการณ์นี้เกิดขึ้นตามที่คุณคาดหวัง.


Object.Changed

property

ชื่อของคุณสมบัติที่เปลี่ยนแปลง.


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


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

ตัวอย่างโค้ดนี้แสดงให้เห็นถึงความเทียบเท่าของเหตุการณ์ `Changed` และเหตุการณ์
ที่ส่งกลับโดย `GetPropertyChangedSignal`.

ฟังก์ชันนี้คืนค่าเหตุการณ์ที่ทำงานเหมือนกับเหตุการณ์ `Class.Object.Changed|Changed` แต่จะเกิดขึ้นเฉพาะเมื่อคุณสมบัติที่กำหนดมีการเปลี่ยนแปลง. โดยทั่วไปแล้วการใช้ฟังก์ชันนี้แทนการเชื่อมต่อกับ `Class.Object.Changed|Changed` พร้อมฟังก์ชันที่ตรวจสอบชื่อคุณสมบัติจะเป็นไอเดียที่ดีกว่า. การเรียกฟังก์ชันนี้ซ้ำๆ บนวัตถเดียวกันด้วยชื่อคุณสมบัติเดียวกันจะส่งคืนเหตุการณ์เดียวกัน.

วัตถุ `Class.ValueBase` เช่น `Class.IntValue` และ `Class.StringValue` จะใช้เหตุการณ์ `Class.Object.Changed|Changed` ที่ปรับเปลี่ยนซึ่งจะถูกเรียกเมื่อคุณสมบัติ `Value` ของพวกเขามีการเปลี่ยนแปลง. ฟังก์ชันนี้จึงให้วิธีการตรวจจับการเปลี่ยนแปลงในคุณสมบัติอื่นๆ ของวัตถุเหล่านั้น.

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

#### ข้อจำกัด

เหตุการณ์ที่ส่งคืนจากฟังก์ชันนี้จะ **ไม่** เกิดขึ้นสำหรับการเปลี่ยนแปลงที่เกี่ยวข้องกับฟิสิกส์ เช่นเมื่อ `Class.BasePart.CFrame|CFrame`,
`Class.BasePart.AssemblyLinearVelocity|AssemblyLinearVelocity`,
`Class.BasePart.AssemblyAngularVelocity|AssemblyAngularVelocity`,
`Class.BasePart.Position|Position`, หรือ
`Class.BasePart.Orientation|Orientation` ของ `Class.BasePart`
เปลี่ยนแปลงเนื่องจากแรงโน้มถ่วง. หากต้องการตรวจจับการเปลี่ยนแปลงในคุณสมบัติเหล่านี้ควรพิจารณาใช้เหตุการณ์ที่เกี่ยวข้องกับฟิสิกส์เช่น `Class.RunService.PreSimulation`.

นอกจากนี้ เหตุการณ์ที่ส่งคืนอาจไม่ส่งเกิดขึ้นในการปรับเปลี่ยนคุณสมบัติที่เปลี่ยนแปลงบ่อยๆ, และ/หรือมันอาจไม่เกิดขึ้นสำหรับคุณสมบัติเหล่านั้นเลย. ขอแนะนำให้นักพัฒนาทดสอบเงื่อนไขการเปลี่ยนแปลงคุณสมบัติที่มีผลต่อเกมอย่างระมัดระวัง.


Object:GetPropertyChangedSignal

คุณสมบัติที่จะเชื่อมต่อ.


สัญญาณที่ถูกเรียกทุกครั้งที่คุณสมบัติเปลี่ยนแปลง.


รับเหตุการณ์ที่ถูกเรียกเมื่อคุณสมบัติที่กำหนดของวัตถุเปลี่ยนแปลง.


แสดงวิธีการกำหนดประเภทของ Workspace โดยใช้ `Class.Instance:IsA()`

Workspace เป็นประเภท 'Workspace' ดังนั้นประเด็นแรกจึงเป็นจริง Workspace
ไม่ใช่ประเภท 'BasePart' ดังนั้นประเด็นที่สองจึงเป็นเท็จ Workspace
สืบทอดมาจาก Instance และจึงเป็นประเภท 'Instance' ดังนั้นประเด็นที่สาม
จึงเป็นจริง。


IsA คืนค่า true หากคลาสของวัตถุ **ตรงกับ** หรือเป็น **คลาสย่อย** ของคลาสที่กำหนด. ฟังก์ชันนี้คล้ายกับตัวดำเนินการ **instanceof** ในภาษาอื่นๆ และเป็นรูปแบบของ
[type introspection](https://en.wikipedia.org/wiki/Type_introspection). เพื่อ
ไม่สนใจการสืบทอดคลาส ให้ทดสอบคุณสมบัติ `Class.Object.ClassName|ClassName` โดยตรงแทน. สำหรับการตรวจสอบประเภทข้อมูลใน Luau แบบพื้นฐาน (หมายเลข,
สตริง, ฯลฯ) ให้ใช้ฟังก์ชัน `type` และ `typeof`.

โดยทั่วไป ฟังก์ชันนี้ถูกใช้เพื่อตรวจสอบว่าวัตถุเป็นชนิดของพาร์ทบางประเภท เช่น `Class.Part` หรือ `Class.WedgePart` ซึ่งสืบทอดจาก
`Class.BasePart` (คลาสเชิงนามธรรม). ตัวอย่างเช่น หากเป้าหมายของคุณคือการเปลี่ยนสีของแขนขาทั้งหมดของตัวละครให้เหมือนกัน คุณสามารถใช้
`Class.Instance:GetChildren()|GetChildren` เพื่อวนรอบเด็กๆ
จากนั้นใช้ IsA เพื่อกรองวัตถุที่ไม่ใช่ `Class.BasePart` ที่ขาดคุณสมบัติ `Datatype.BrickColor`:

```lua
local Players = game:GetService("Players")

local function paintFigure(character, color)
	-- วนรอบวัตถุเด็กๆ ของตัวละคร
	for _, child in character:GetChildren() do
		-- กรองวัตถุที่ไม่ใช่พาร์ทเช่น Shirt, Pants และ Humanoid
		-- R15 ใช้ MeshPart และ R6 ใช้ Part ดังนั้นเราจึงใช้ BasePart ที่นี่เพื่อตรวจจับทั้งสอง:
		if child:IsA("BasePart") then
			child.BrickColor = color
		end
	end
end
paintFigure(Players.Player.Character, BrickColor.new("Bright blue"))
```
เนื่องจากทุกคลาสสืบทอดจาก `Class.Object`, การเรียกใช้
`object:IsA("Object")` จะคืนค่า true เสมอ.


Object:IsA

className

คลาสที่คลาสของ Object จะถูกตรวจสอบ.
ใช้ตัวพิมพ์เล็ก-ใหญ่.


อธิบายว่าคลาสของ Object ตรงกันหรือเป็นคลาสย่อยของคลาสที่กำหนด.


คืนค่า true ถ้าคลาสของวัตถุตรงกับหรือสืบทอดจากคลาสที่กำหนด.


Object:isA

Object

สตริงที่อ่านอย่างเดียวซึ่งเป็นตัวแทนของคลาสที่ `Class.Object` นี้เป็นของ.

คุณสมบัตินี้สามารถใช้ร่วมกับฟังก์ชันอื่นๆ ที่ใช้ในการระบุวัตถุตามประเภท เช่น `Class.Object:IsA()` หรือ
`Class.Instance:FindFirstChildOfClass()`.

โปรดทราบว่าคุณสมบัตินี้เป็นแบบอ่านอย่างเดียวและไม่สามารถแก้ไขได้โดยสคริปต์.
นักพัฒนาที่ต้องการเปลี่ยนคลาสของวัตถุจะต้องสร้าง `Class.Object` ใหม่แทน.

ต่างจาก `Class.Object:IsA()`, ClassName สามารถใช้เพื่อเช็คว่าวัตถุมีความสัมพันธ์กับคลาสเฉพาะโดยไม่สนใจการสืบทอดคลาส. ตัวอย่างเช่น:

```
for _, child in workspace:GetChildren() do
    if child.ClassName == "Part" then
        print("พบ Part")
        -- จะค้นหา Parts ในโมเดล แต่ไม่ใช่ TrussParts, WedgeParts, ฯลฯ
    end
end
```


Object.ClassName

สตริงแบบอ่านอย่างเดียวที่เป็นตัวแทนของคลาสที่ `Class.Object` นี้เป็นของ.


Object.className

`Object` เป็นคลาสพื้นฐานสำหรับทุกคลาสในลำดับชั้นคลาสของ Roblox.


/reference/engine/classes/PluginConnection.yaml

Luau

ฟังก์ชันคือบล็อกของโค้ดที่สามารถรันหลาย ๆ ครั้งตามคำสั่ง

function

อีนัมที่อธิบายความสัมพันธ์ที่เป็นไปได้ที่โมเดลข้อมูลเป้าหมายของ `Class.PluginConnection` สามารถมีได้กับโมเดลข้อมูลปัจจุบัน。

Enum

Enum.PluginConnectionTargetType

การเชื่อมต่อระหว่าง `Datatype.RBXScriptSignal` และฟังก์ชัน。

Data Type

RBXScriptConnection

วัตถุที่เรียกใช้งานฟังก์ชันที่เชื่อมต่อเมื่อมีเหตุการณ์เฉพาะเกิดขึ้น。

RBXScriptSignal

Variant

ประเภทข้อมูลที่มีค่าเป็นจริงหรือเท็จ

boolean

ชุดของตัวอักษร เช่น ตัวอักษร ตัวเลข และสัญลักษณ์

string

ประสบการณ์

อวาตาร์

ทรัพยากร

ตัวอย่างและโปรเจ็กต์

Engine API

Open Cloud API

Studio

การวิเคราะห์

แพลตฟอร์ม

คู่มือการใช้งาน

โปรแกรมสำหรับครีเอเตอร์

การศึกษา

หลักสูตร

เรียนรู้

การยืนยันตัวตนด้วยคีย์ API

วิธีนี้ไม่ได้ทำพร้อมกันและส่งคืน `Operation` ซึ่งแสดงสถานะปัจจุบันของการดำเนินการและมีเส้นทาง Endpoint ที่คุณใช้สำรวจความคิดเห็นได้ เพื่อเช็คการตอบสนองจริงและข้อมูลเมตาที่เกี่ยวข้อง หากต้องการข้อมูลเพิ่มเติม โปรดดู[เอกสาร]({longRunningOperationsLink})เกี่ยวกับการดำเนินการที่ใช้เวลานาน
            
ส่วนต่อไปนี้จะอธิบายการตอบสนองและวัตถุข้อมูลเมตาที่จะได้รับเมื่อดำเนินการเสร็จสิ้น

Endpoint เวอร์ชัน Beta พร้อมสำหรับการใช้งานทั่วไปแล้ว อาจมีการเปลี่ยนแปลงที่ทำให้ใช้งานไม่ได้ แต่ก็เป็นไปได้ยาก

หน้าเอกสาร Open Cloud เหล่านี้จะถูกลบออกในวันที่ 31 มีนาคม 2026 คุณจะถูกเปลี่ยนเส้นทางไปยังเอกสาร Open Cloud ใหม่โดยอัตโนมัติตั้งแต่วันดังกล่าว {linkStart}เรียนรู้เพิ่มเติม{linkEnd}

หน้า Open Cloud เก่าเหล่านี้จะถูกลบออกและเปลี่ยนเส้นทางในวันที่ 31 มีนาคม 2026 {linkStart}เรียนรู้เพิ่มเติม{linkEnd}

Endpoints รุ่นทดลองพร้อมให้ใช้งานสาธารณะแล้ว แต่บางครั้งอาจมีการเปลี่ยนแปลงที่ทำให้ใช้งานไม่ได้ เนื่องจากมีการกำหนดสัญญา API ไว้เสร็จแล้ว ปรับเปลี่ยนไม่ได้

สามารถเรียกใช้ Endpoint นี้ได้ในประสบการณ์ผ่าน {httpServiceLinkStart}HttpService{httpServiceLinkEnd} ด้วยคีย์ API

สามารถตั้งค่าฟิลด์นี้ได้เมื่อสร้างทรัพยากร แต่ไม่สามารถแก้ไขได้ด้วยคำขอภายหลัง

ตั้งค่าช่องข้อมูลเหล่านี้ตอนสร้างแหล่งข้อมูลได้ แต่จะส่งคำขอแก้ไขหลังจากนั้นไม่ได้

อาจมีช่องข้อมูลนี้ในคำขอ แต่จะไม่รวมอยู่ในการตอบกลับโดยเด็ดขาด

วิธีการยืนยันตัวตนแบบเก่า ควรใช้คีย์ API หรือ OAuth 2.0 เสมอ หากมี

ต่อคีย์ API: {maxInPeriod} คำขอทุกๆ {periodInSeconds} วินาทีต่อที่อยู่ IP

ไม่จำเป็นต้องมีการยืนยันตัวตนในการเรียกใช้ โดยปกติจะมีการจำกัดอัตราการเรียกใช้ที่ลดลงอย่างมาก ควรใช้คีย์ API หรือ OAuth 2.0 เสมอ หากมีให้ใช้งาน

การยืนยันตัวตนด้วย OAuth 2.0

สำหรับแต่ละกลุ่ม จะต้องระบุฟิลด์เพียง 1 รายการ จากรายการต่อไปนี้ในแบบแผน (schema) เท่านั้น และเว้นฟิลด์อื่นๆ ไว้ได้

คุณเลือกกลับมาได้ตลอดเวลา {linkStart}ให้ข้อเสนอแนะ{linkEnd}

คุณกำลังดูเอกสารแบบเก่า {linkStart}ให้ข้อเสนอแนะ{linkEnd}

คุณเลือกไม่เข้าร่วมได้ตลอดเวลาและจะถูกนำกลับไปยังหน้าอ้างอิงเก่า {linkStart}ให้ข้อเสนอแนะ{linkEnd}

คุณกำลังดูเอกสารโฉมใหม่ {linkStart}ให้ข้อเสนอแนะ{linkEnd}

อาจใช้ช่องข้อมูลนี้การตอบกลับ แต่จะเว้นไว้ในคำขอ

หมายเหตุ: อัตราสูงสุดอาจต่ำกว่านี้ในช่วงที่มีการใช้งานสูง บาง Endpoints มีอัตราสูงสุดเพิ่มเติม [เรียนรู้เพิ่มเติมเกี่ยวกับอัตราสูงสุด]({link})

{limit} คำขอต่อวันสำหรับคีย์ API ทั้งหมดสำหรับผู้ใช้หรือกลุ่ม

{limit} คำขอต่อชั่วโมงสำหรับคีย์ API ทั้งหมดสำหรับผู้ใช้หรือกลุ่ม

{limit} คำขอต่อนาทีสำหรับคีย์ API ทั้งหมดสำหรับผู้ใช้หรือกลุ่ม

{limit} คำขอต่อวินาทีสำหรับคีย์ API ทั้งหมดสำหรับผู้ใช้หรือกลุ่ม

{limit} คำขอต่อนาทีต่อเจ้าของคีย์ API

{limit} คำขอต่อวันต่อผู้ใช้แอป

{limit} คำขอต่อชั่วโมงต่อผู้ใช้แอป

{limit} คำขอต่อนาทีต่อผู้ใช้แอป

{limit} คำขอต่อวินาทีต่อผู้ใช้แอป

{limit} คำขอต่อวินาทีต่อเจ้าของคีย์ API

ขอบเขตจะควบคุมสิทธิ์ที่ข้อมูลประจำตัวของคุณมี ข้อมูลประจำตัวของคุณจะเข้าถึงได้เฉพาะ Endpoints ที่ขอบเขตที่คุณเลือกไว้รองรับเท่านั้น

Endpoints รุ่นเสถียรพร้อมใช้งานในสภาพแวดล้อมจริงแล้ว และแทบจะไม่เกิดการเปลี่ยนแปลงที่ทำให้ใช้งานไม่ได้ตลอดอายุการใช้งาน

เป้าหมายนี้ช่วยให้คุณสามารถจำกัดการใช้คีย์ของคุณเข้าถึง{requiredParts}ที่เลือกไว้

เป้าหมายนี้ช่วยให้คุณสามารถจำกัดการใช้คีย์ของคุณเข้าถึง{requiredParts}และ{optionalParts}ที่เลือกไว้

ประเภทเป้าหมายนั้นใช้เพื่อจำกัดทรัพยากรที่ข้อมูลประจำตัวของคุณมีสิทธิ์ใช้งานได้ แม้ว่าบัญชีของคุณจะมีสิทธิ์ใช้งานทรัพยากรเพิ่มเติม แต่จะดำเนินการได้เฉพาะทรัพยากรที่เลือกไว้เท่านั้น ทั้งนี้ ในกรณีที่ขอบเขตไม่มีส่วนเป้าหมาย คุณจะดำเนินการกับทรัพยากรที่เกี่ยวข้องทั้งหมดได้

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

ยังไม่รองรับการลองใช้สำหรับ Endpoints ที่ต้องใช้คีย์ API หรือการยืนยันตัวตนด้วย OAuth 2.0

การยืนยันตัวตนด้วยคุกกี้ถูกปิดใช้งานสำหรับการดำเนินการที่มีความเสี่ยงสูงเพื่อความปลอดภัย

Endpoints ที่มีความเสี่ยงสูงนั้นละเอียดอ่อนมาก การลองใช้จึงถูกปิดใช้งานเพื่อความปลอดภัย

หมายเหตุ: ตัวอย่างโค้ดนี้ไม่มีส่วนหัวสำหรับการยืนยันตัวตน คุณอาจต้องเพิ่มส่วนหัวเพื่อใช้คำสั่งนี้

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

Endpoint ของ API นี้จัดอยู่ในประเภทความเสี่ยงสูง และอาจส่งผลกระทบต่อข้อมูลจริงหรือบัญชีผู้ใช้

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

โปรดลงชื่อเข้าใช้เพื่อใช้การยืนยันตัวตนด้วยคุกกี้

Endpoints ที่สามารถดึงข้อมูลได้นี้มีความเสี่ยงต่ำ โดยทั่วไปจะปลอดภัยสำหรับการทดสอบ

Endpoints ที่สามารถแก้ไขข้อมูลได้นี้มีความเสี่ยงปานกลาง ทดสอบด้วยความระมัดระวังโดยใช้บัญชีที่ไม่สำคัญ เนื่องจากอาจเป็นการเปลี่ยนแปลงถาวร

อย่าวางข้อความจากแหล่งอื่นที่นี่หรือส่งข้อมูลจากหน้านี้ให้ผู้อื่น เพื่อรักษาบัญชีของคุณให้ปลอดภัย

คุณกำลังจะทดสอบ Endpoints ของ API แบบเรียลไทม์โดยใช้ข้อมูลประจำตัวของบัญชีจริง

โปรดดำเนินการต่อเฉพาะในกรณีที่คุณเข้าใจผลกระทบในการเรียกใช้ API นี้ และตรวจสอบเอกสารประกอบ API อย่างรอบคอบก่อนทดสอบ

การเรียกใช้ API จะดำเนินการโดยใช้เซสชันที่ผ่านการตรวจสอบสิทธิ์แล้ว

ซึ่งเป็นการเรียกใช้ API จริง และอาจส่งผลกระทบต่อบัญชีหรือข้อมูลของคุณ

มีการจำกัดอัตราและมีข้อจำกัดอื่นๆ สำหรับ API

การดำเนินการบางส่วนอาจเป็นการแก้ไขหรือลบข้อมูล

Endpoint นี้มีการแทนที่ด้วย Endpoint ทางเลือกแนะนำเหล่านี้:

ต้องมีขอบเขตต่อไปนี้เพื่อเรียกใช้ Endpoint นี้ ดูข้อมูลเพิ่มเติม
เกี่ยวกับการสร้างคีย์ที่เหมาะสมได้ที่[จัดการคีย์ API]({apiKeyReferenceDocLink})

ดูข้อมูลเพิ่มเติมเกี่ยวกับการสร้างคีย์ได้ที่[จัดการคีย์ API]({apiKeyReferenceDocLink})

Endpoints ต่อไปนี้พร้อมใช้งานที่เส้นทางที่สัมพันธ์กับ URL หลัก

สตริงนี้มีรูปแบบ [FieldMask](/cloud/reference/types#fieldmask)

ค่า JSON จะเป็น `null`, `boolean`, `string`, `number`, `array` หรือ `object` ก็ได้

แอปพลิเคชัน OAuth 2.0 ของคุณต้องมีขอบเขตต่อไปนี้เพื่อใช้ Endpoint นี้ ดูข้อมูลเพิ่มเติมเกี่ยวกับวิธีลงทะเบียนแอปพลิเคชัน OAuth 2.0 ได้ที่[การลงทะเบียนและการตรวจสอบแอป]({oauth2ReferenceDocLink})

ดูข้อมูลเพิ่มเติมเกี่ยวกับวิธีลงทะเบียนแอปพลิเคชัน OAuth 2.0 ได้ที่[การลงทะเบียนและการตรวจสอบแอป]({oauth2ReferenceDocLink})

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

เนื้อหาคำขอเป็น

ต้องมีขอบเขตต่อไปนี้เพื่อเรียกใช้ Endpoint นี้

เส้นทางแหล่งข้อมูล

สตริงนี้มีรูปแบบ[ประทับเวลา](/cloud/reference/types#timestamp)

ต้องมีขอบเขตต่อไปนี้สำหรับแอปพลิเคชัน OAuth 2.0 ของคุณเพื่อใช้ Endpoint นี้ ดูข้อมูลเพิ่มเติมเกี่ยวกับวิธีลงทะเบียนแอปพลิเคชัน OAuth 2.0 ได้ที่[การลงทะเบียนและการตรวจสอบแอป]({oauth2ReferenceDocLink})

ไม่แนะนำ

คุณกำลังดูข้อมูลอ้างอิง Open Cloud โฉมใหม่

คุณเลือกไม่ใช้ข้อมูลอ้างอิง Open Cloud ใหม่

ดูบัญชีเรียกเก็บเงินค่าโฆษณาของคุณ

ดูแคมเปญโฆษณาของคุณและประสิทธิภาพของแคมเปญ

สร้าง อัปเดต และจัดการแคมเปญโฆษณาของคุณ

สิทธิ์นี้อนุญาตให้ดูข้อมูลเกี่ยวกับทรัพยากรของคุณ

สิทธิ์นี้อนุญาตให้อัปโหลดและอัปเดตทรัพยากรไปยัง Roblox

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

สิทธิ์นี้ให้สิทธิ์การเข้าถึงทรัพยากรแก่ผู้ใช้ทุกประเภท (รวมถึงกลุ่มและประสบการณ์) และทรัพยากรที่บัญชีของคุณสามารถเข้าถึง

การตั้งค่านี้จะอนุญาตให้คุณดูสถานะและผลลัพธ์ของงานตั้งค่าอวาตาร์ในนามของคุณได้โดยอัตโนมัติ

การตั้งค่านี้จะอนุญาตให้คุณสร้างและจัดการงานตั้งค่าอวาตาร์ในนามของคุณได้โดยอัตโนมัติ

อนุญาตให้ใช้ความสามารถในการอัปเดตเหรียญตราที่ผู้ใช้เป็นเจ้าของ

สิทธิ์นี้อนุญาตให้ดูข้อมูลเกี่ยวกับไอเท็มการค้าของคุณ

สิทธิ์นี้อนุญาตให้เปลี่ยนแปลงไอเท็มการค้าที่ซิงค์แล้วของคุณ

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

สิทธิ์นี้อนุญาตให้แก้ไขการเชื่อมต่อผู้ขายสินค้าของคุณได้

สิทธิ์นี้อนุญาตให้คุณดูข้อมูลเกี่ยวกับผลิตภัณฑ์บนร้านค้าครีเอเตอร์ของคุณได้

สิทธิ์นี้อนุญาตให้คุณแก้ไขข้อมูลเกี่ยวกับผลิตภัณฑ์บนร้านค้าครีเอเตอร์ของคุณได้

ซึ่งจะช่วยให้คุณดูข้อมูลเกี่ยวกับผลิตภัณฑ์บนร้านค้าครีเอเตอร์ของคุณได้

ซึ่งจะช่วยให้คุณแก้ไขข้อมูลเกี่ยวกับผลิตภัณฑ์บนร้านค้าครีเอเตอร์ของคุณได้

อนุญาตให้เข้าถึงเพื่อสร้างที่เก็บข้อมูลในนามของคุณ

อนุญาตให้เข้าถึงเพื่อลบที่จัดเก็บข้อมูลในนามของคุณ

อนุญาตให้เข้าถึงเพื่ออ่านรายการที่จัดเก็บข้อมูล

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

อนุญาตให้เข้าถึงเพื่อสร้างรายการในที่จัดเก็บข้อมูลของคุณ

อนุญาตให้เข้าถึงเพื่อทำเครื่องหมายรายการที่ระบุเพื่อลบ

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

อนุญาตให้เข้าถึงเพื่ออ่านรายการที่ระบุในที่เก็บข้อมูลของคุณ

อนุญาตให้เข้าถึงเพื่ออัปเดตค่า แอตทริบิวต์ และผู้ใช้ของรายการ

อนุญาตให้เข้าถึงเพื่อลบเวอร์ชันที่แก้ไขของรายการในที่จัดเก็บข้อมูลของคุณ

อนุญาตให้เข้าถึงเพื่อแสดงรายการเวอร์ชันที่แก้ไขของรายการในที่จัดเก็บข้อมูลของคุณ

อนุญาตให้เข้าถึงเพื่อดูรายละเอียดการกำหนดค่าสำหรับผลิตภัณฑ์นักพัฒนาของผู้ใช้ที่ได้รับอนุญาต

อนุญาตให้เข้าถึงเพื่อแก้ไขผลิตภัณฑ์นักพัฒนาของผู้ใช้ที่ได้รับอนุญาต

สิทธิ์นี้อนุญาตให้ดูข้อมูลเกี่ยวกับสภาพแวดล้อมในยูนิเวิร์สของคุณ

สิทธิ์นี้อนุญาตให้แก้ไขสภาพแวดล้อมในยูนิเวิร์สของคุณ

อนุญาตให้เข้าถึงเพื่อดูรายละเอียดการกำหนดค่าสำหรับบัตรผ่านเกมของผู้ใช้ที่ได้รับอนุญาต

อนุญาตให้เข้าถึงเพื่อแก้ไขบัตรผ่านเกมของผู้ใช้ที่ได้รับอนุญาต

อนุญาตให้เข้าถึงเพื่อดูข้อมูลฟอรัมชุมชนสำหรับบัญชีของคุณ

อนุญาตให้เข้าถึงเพื่อจัดการข้อมูลฟอรัมชุมชนสำหรับบัญชีของคุณ

สิทธิ์นี้อนุญาตให้ดูข้อมูลเกี่ยวกับชุมชนของคุณ

สิทธิ์นี้อนุญาตให้คุณจัดการคำขอเข้าร่วมชุมชนและอัปเดตบทบาทของสมาชิกชุมชนที่มีสถานะต่ำกว่าสำหรับบัญชีของคุณได้

อนุญาตให้คุณดูข้อมูลคุณสมบัติของอินสแตนซ์

อนุญาตให้คุณแก้ไขข้อมูลคุณสมบัติของอินสแตนซ์ (ปัจจุบันรองรับเฉพาะสคริปต์เท่านั้น)

สิทธิ์นี้อนุญาตให้ดูข้อมูลเกี่ยวกับคลังไอเท็มของคุณ

อนุญาตให้เข้าถึงเพื่อจัดการทรัพยากรของผู้ใช้

อนุญาตให้เข้าถึงเพื่อจัดการเหรียญตราของคุณ

อนุญาตให้เข้าถึงเพื่อจัดการเหรียญตราของคุณและใช้จ่าย Robux

อนุญาตให้เข้าถึงเพื่ออัปเดตเหรียญตราของผู้ใช้ที่ได้รับอนุญาต

อนุญาตให้เข้าถึงเพื่อจัดการผลิตภัณฑ์นักพัฒนาระบบของคุณ

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

อนุญาตให้เข้าถึงเพื่อเปิดหรือปิดการแจ้งเตือนสำหรับประสบการณ์ในนามของคุณ

อนุญาตให้เข้าถึงเพื่อจัดการบัตรผ่านของคุณ

อนุญาตให้เข้าถึงเพื่อจัดการชุมชนของคุณ

อนุญาตให้มีสิทธิ์ในการอ่านข้อมูลชุมชน

อนุญาตให้มีสิทธิ์ในการจัดการชุมชน

อนุญาตให้เข้าถึงเพื่ออ่านและเขียนตารางการแปลของคุณ

อนุญาตให้เข้าถึงเพื่อจัดการการทำงานร่วมกันเป็นทีมสำหรับประสบการณ์ทั้งหมดที่คุณเป็นเจ้าของ

อนุญาตให้เข้าถึงเพื่อจัดการประสบการณ์ของคุณและข้อมูลบางอย่างที่เกี่ยวข้องกับประสบการณ์ของคุณ (เช่น ข้อมูลการแปลภาษา)

อนุญาตให้เข้าถึงเพื่ออ่านข้อมูลการแปลประสบการณ์ของคุณ

อนุญาตให้เข้าถึงเพื่อแก้ไขการตั้งค่าการแปลประสบการณ์ของคุณ

อนุญาตให้เข้าถึงเพื่อจัดการบัญชีผู้ใช้ของคุณ

อนุญาตให้เข้าถึงเพื่อแก้ไขการตั้งค่าการแปลภาษาของผู้ใช้

อนุญาตให้คุณดูสถานะ บันทึก และแสดงผลลัพธ์ของงานดำเนินการในภาษา Luau สำหรับสถานที่ที่เชื่อมโยงได้

อนุญาตให้คุณสร้างงานดำเนินการใหม่ในภาษา Luau สำหรับสถานที่ที่เชื่อมโยงได้

อนุญาตให้เข้าถึงเพื่อล้างโครงสร้างข้อมูลทั้งหมดในยูนิเวิร์สแบบไม่ต้องรอให้ซิงค์ข้อมูล

อนุญาตให้เข้าถึงเพื่อสร้างไอเท็มใหม่ในคิว

อนุญาตให้เข้าถึงเพื่อลบไอเท็มที่อ่านแล้วออกจากด้านหน้าของคิว

อนุญาตให้เข้าถึงเพื่ออ่านไอเท็มที่ด้านหน้าของคิว

อนุญาตให้เข้าถึงเพื่ออ่านไอเท็มบนที่เก็บข้อมูลในหน่วยความจำของคุณ

อนุญาตให้เข้าถึงเพื่ออ่านไอเท็มบนแผนที่

อนุญาตให้เข้าถึงเพื่อสร้าง อัปเดต และลบไอเท็มบนแผนที่

การดำเนินการนี้จะอนุญาตให้ใช้ความสามารถในการเผยแพร่ข้อความในนามของผู้ใช้

สิทธิ์นี้อนุญาตให้ส่งการแจ้งเตือนจากประสบการณ์ของคุณไปยังผู้ใช้ได้

(เลิกใช้แล้ว) อนุญาตให้เข้าถึงเพื่ออ่านรายการในที่จัดเก็บข้อมูลที่เรียงตามลำดับ

(เลิกใช้แล้ว) อนุญาตให้เข้าถึงเพื่อสร้างรายการใหม่ในที่จัดเก็บข้อมูลที่เรียงตามลำดับ

อนุญาตให้เข้าถึงเพื่อแสดงรายการจากที่จัดเก็บข้อมูลที่เรียงตามลำดับ

อนุญาตให้เข้าถึงเพื่อสร้างรายการในที่จัดเก็บข้อมูลที่เรียงตามลำดับ

สิทธิ์นี้อนุญาตให้ลงข้อมูลลับที่เชื่อมโยงกับประสบการณ์ของคุณ

สิทธิ์นี้อนุญาตให้สร้างและอัปเดตข้อมูลลับที่เชื่อมโยงกับประสบการณ์ของคุณ

สิทธิ์นี้อนุญาตให้คุณส่งงานประเมินผลและดูผลลัพธ์เกี่ยวกับงาน

อนุญาตให้เข้าถึงเพื่ออ่านข้อมูลเกี่ยวกับผลิตภัณฑ์ที่คุณสมัครสมาชิก

การตั้งค่านี้จะอนุญาตให้คุณอ่านข้อมูลภาพขนาดย่อในนามของคุณได้

อนุญาตให้อ่านการวิเคราะห์เกมได้

อนุญาตให้ใช้ความสามารถในการอ่านข้อมูลเกี่ยวกับสถานที่

อนุญาตให้ใช้ความสามารถในการแก้ไขข้อมูลเกี่ยวกับสถานที่

อนุญาตให้เข้าถึงเพื่อเผยแพร่ประสบการณ์เวอร์ชันใหม่ไปยัง Roblox

อนุญาตให้ใช้ความสามารถในการอ่านข้อมูลประสบการณ์

อนุญาตให้เข้าถึงเพื่อแก้ไขประสบการณ์ของผู้ใช้ที่ได้รับอนุญาต

อนุญาตให้คุณดูข้อจำกัดของผู้ใช้ในประสบการณ์ได้

อนุญาตให้คุณแก้ไขข้อจำกัดของผู้ใช้ในประสบการณ์ได้

การตั้งค่านี้จะอนุญาตให้ดูการแจ้งเตือนที่ส่งไปยังบัญชีของคุณได้

อนุญาตให้ใช้ความสามารถในการอ่านสถานะ Premium และสถานะที่ยืนยันแล้วของผู้ใช้

สิทธิ์นี้อนุญาตให้คุณดูบัญชีโซเชียลของผู้ใช้ที่ได้รับอนุญาตได้

การดำเนินการนี้จะเปิดใช้งานฟังก์ชันการลงชื่อเข้าใช้แบบครั้งเดียว

การดำเนินการนี้จะอนุญาตให้เข้าถึงเพื่ออ่านข้อมูลโปรไฟล์ของคุณ