國家地區的本地化名稱。例如 "阿富汗"

支持的國家/地區列表。在發生錯誤時將為空。

請求實體以設置帳戶的ShowRobloxTranslations字段

要設置ShowRobloxTranslations字段的值

請求實體以為用戶設置支持的語言環境

以本地語言表示的支持語言環境名稱。例子 "英語"

具有用戶地區資訊的支持語言環境模型

語言環境是否啟用以獲得完整體驗

語言環境是否啟用以遊戲中的UGC

語言環境是否啟用以登記和登入

支持的語言環境列表。發生錯誤時將為空。

返回可用的Roblox.Locale.Api.SupportedLocale模型。

是否應向使用者顯示Roblox建議的翻譯。

可配置的密鑰，可允許對 Roblox 資源進行細粒度訪問。詳情請參見 https://create.roblox.com/docs/cloud/auth/api-keys。

x-api-key

表示 Roblox 用戶身份的瀏覽器 Cookie。切勿分享此內容。共享此內容將允許他人以您的身份登錄並盜取您的 Robux 和物品。我們不建議使用 Cookie 來調用端點。在可能的情況下，請使用帶有 x-api-key 標頭的 API 密鑰或 OAuth 2.0 進行身份驗證。

.ROBLOSECURITY

構建或授權應用程序以訪問 Roblox 資源。詳情請參見 https://create.roblox.com/docs/cloud/auth/oauth2-overview。

Roblox API。詳情請參見 https://create.roblox.com/docs/cloud/open-cloud。

Roblox API

locale

獲取按本地名稱排序的國家地區列表

displayValueLocale

獲取支持的地區列表，並附上用戶地區信息。

未經授權
0：此請求的授權被拒絕。

功能已暫時關閉
0：令牌驗證失敗

設置是否顯示Roblox建議的翻譯供用戶查看。

需要為用戶設置的支持地區代碼

設置用戶的支持地區。
null支持地區將清除用戶的支持地區（將用戶的支持地區設置為null）

獲取按本地名稱屬性排序的支持地區列表。

獲取用戶地區。如果用戶缺失，則返回http請求對象中的地區。

獲取用戶每個本地化位置支持的地區。本地化位置支持的地區是由國際團隊定義的需要獨立地區支持的頁面（或頁面組）。如果用戶為null，我們將嘗試返回適合用戶設備語言的地區。

locale.roblox.com

體驗

虛擬人偶

素材

範例與專案

引擎 API

開放式雲端 API

Studio

分析

平台

教學

創作者計畫

教育

課程

學習

此方法不同步且會傳回一個「Operation」，代表該操作的目前狀態。其中包含一個端點路徑，您可以輪詢以獲得實際回應和適用的中繼資料。詳情請參閱關於長期執行操作的[說明文件]({longRunningOperationsLink})。
            
以下部分描述操作完成時提供的回應和中繼資料物件。

Beta 測試終點已準備好公開使用。可能出現導致功能無法正常運作的變更，但機率不高。

這些開放式雲端文件頁面將於 2026 年 3 月 31 日移除。屆時，系統會自動將你重新導向至新版開放式雲端文件。{linkStart}瞭解詳情{linkEnd}

這些舊版開放式雲端頁面將於 2026 年 3 月 31 日移除，並重新導向至新頁面。{linkStart}瞭解詳情{linkEnd}

實驗端點已可供公開使用，但隨著 API 合約結束，可能會偶爾發生重大變更。

此終點可在體驗內透過 {httpServiceLinkStart}HttpService{httpServiceLinkEnd} 使用 API 金鑰呼叫。

建立資源時可設定此欄位，但可能無法在後續請求中修改。

建立資源時可設定這些欄位，但可能無法在後續請求中修改。

此欄位可在請求中提供，但永遠不會包含在回應中。

舊版本驗證方法。可用時，請務必使用 API 金鑰或 OAuth 2.0。

每個 API 金鑰：每個 IP 位址每 {periodInSeconds} 秒 {maxInPeriod} 個請求

無需驗證即可呼叫。通常會大幅降低速率限制。可用時，請務必使用 API 金鑰或 OAuth 2.0。

對於每個群組，只需提供架構中下列任一欄位，其餘可省略。

你隨時可以重新加入。{linkStart}歡迎提供回饋。{linkEnd}

你正在檢視舊版文件。{linkStart}歡迎提供回饋。{linkEnd}

你可以隨時選擇退出，並重新導向回舊版參考頁面。{linkStart}歡迎提供任何回饋。{linkEnd}

你正在檢視新版文件。{linkStart}歡迎提供回饋。{linkEnd}

此欄位可在回應中設定，但將在請求中被忽略。

注意：在高流量期間，速率限制可能會降低。部分端點有額外的速率限制。[深入瞭解速率限制]({link})。

使用者或群組所有 API 金鑰每日 {limit} 次要求數

使用者或群組所有 API 金鑰每小時 {limit} 次要求數

使用者或群組所有 API 金鑰每分鐘 {limit} 次要求數

使用者或群組所有 API 金鑰每秒 {limit} 次要求數

每位 API 金鑰擁有者每分鐘 {limit} 次要求數

每位應用程式使用者每日 {limit} 次要求數

每位應用程式使用者每小時 {limit} 次要求數

每位應用程式使用者每分鐘 {limit} 次要求數

每位應用程式使用者每秒 {limit} 次要求數

每位 API 金鑰擁有者每秒 {limit} 次要求數

範圍控制憑證的權限。憑證只能存取你選取的範圍所支援的端點。

穩定終點已準備好投入正式環境，在其生命週期中幾乎不會發生破壞性變更。

此目標可讓你將金鑰存取權限制為所選的{requiredParts}

此目標可讓你將金鑰存取權限制為所選的{requiredParts}和{optionalParts}

目標類型是用來限制憑證對於資源的權限。即使你的帳戶擁有其他資源的權限，也只能對所選資源執行操作。某些操作範圍不包含特定目標部分。在這種情況下，所有相關資源皆可操作。

對於使用者擁有的 API 金鑰，無需選擇宇宙的頂層部分。在這種情況下，你的 API 金鑰將可存取你所擁有的使用者體驗內容，以及你具備正確群組權限的所有群組體驗內容。

「立即試試」功能尚未支援需要 API 金鑰或 OAuth 2.0 驗證的端點

為了安全起見，Cookie 驗證在高風險操作中已停用。

關鍵風險端點極為敏感，為了安全起見，已停用「立即試試」功能

注意：此程式碼範例中不包含驗證標頭資訊。你可能需要為此指令新增驗證標頭，才能正常運作。

這是一個高風險端點，用以修改或刪除關鍵資料。測試時請格外小心。

此 API 端點已被歸類為高風險，且可能會影響即時資料或使用者帳號。

對於高風險 API 的驗證請求，可能會造成無法撤銷的變更。請在繼續之前仔細檢查請求參數。

這是一個低風險端點，用以擷取資料。測試這個端點通常是安全的。

這是一個中等風險端點，用以修改資料。請謹慎地使用非關鍵帳戶測試，因為變更可能是永久性的。

為了確保帳號安全，切勿從其他來源貼上文字，或將此頁面的資訊傳送給其他人。

你即將使用實際帳號憑證來測試已發布的 API 端點。

除非你了解即將進行的 API 呼叫可能涉及的後果，方可繼續操作。在測試之前，請仔細閱讀 API 文件。

API 呼叫將透過你已驗證的工作階段進行

這些皆為實際 API 呼叫，可能會影響你的帳號或資料

部分操作可能會修改或刪除資料

此終點已被這些建議的替代終點取代：

需要以下範圍才能呼叫此端點。若要了解更多
關於產生正確金鑰的資訊，請參閱[管理 API 金鑰]({apiKeyReferenceDocLink})。

若要了解更多關於產生金鑰的資訊，請參閱[管理 API 金鑰]({apiKeyReferenceDocLink})。

根據相對基本網址的路徑，可使用下列終點。

此字串的格式為 [FieldMask](/cloud/reference/types#fieldmask)。

JSON 值可為「null」、「boolean」、「string」、「number」、「array」或「object」。

若想使用此端點，您的 OAuth 2.0 應用程式需要以下範圍。有關如何註冊 OAuth 2.0 應用程式的更多資訊，請查看[應用程式註冊和審查]({oauth2ReferenceDocLink})。

若要了解更多關於如何註冊 OAuth 2.0 應用程式的資訊，請參閱[App 註冊與審核]({oauth2ReferenceDocLink})。

以下物件描述被接受或退回的負載。若要獲得更多關於物件使用時機的資訊，請查看個別終點。

需要以下範圍才能呼叫此端點。

資源路徑

此字串的格式為 [Timestamp](/cloud/reference/types#timestamp)。

若想使用此端點，您的 OAuth 2.0 應用程式需要以下範圍。有關如何註冊 OAuth 2.0 應用程式的更多資訊，請查看 [應用程式註冊和審查]（{oauth2ReferenceDocLink}）。

不推薦

你正在檢視新版 Open Cloud 參考資料。

你已選擇退出新版 Open Cloud 參考資料。

建立、更新並管理你的廣告活動。

這可以查看有關您資產的資訊。

這可以上傳和更新 Roblox 的資產。

這項操作可讓你查看主體（包括群組和體驗）的素材權限，以及帳號可存取的素材。

這會允許授予素材權限給您的帳號可存取的任何對象（包含群組和體驗）及素材。

這項操作可讓你代為檢視虛擬人偶自動設定工作的狀態和結果。

這項操作可讓你代為建立和管理虛擬人偶自動設定工作。

授予更新使用者所擁有之徽章的能力。

這會允許查看您商品的相關資訊。

這麼做可對已同步的商品進行變更。

此操作可讓你檢視商務聯絡對象的資訊。

這會允許對您的商務商家連結進行編輯。

這能讓您檢視您創作者商店商品的相關資訊。

這能讓您修改您創作者商店商品的相關資訊。

這項操作可以讓你查看創作者商店儲存項目的相關資訊。

這項操作可讓你修改創作者商店儲存項目的相關資訊。

授予代為建立資料存儲的存取權。

授予代為刪除資料存儲的權限。

授予讀取資料存儲清單的存取權。

授予為資料存儲拍攝快照的存取權。

授予在資料存儲中建立條目的存取權。

授予標記指定條目以進行刪除的存取權。

授予可列出資料存儲項目的存取權。

授予在資料存儲中讀取指定條目的存取權。

授予更新項目值、屬性和使用者的存取權。

授予可刪除資料存儲條目修訂版的存取權。

授予可列出資料存儲條目修訂版的存取權。

授予可讀取資料存儲條目修訂版的存取權。

授予檢視授權使用者開發者產品設定詳細資訊的權限。

授予編輯授權使用者開發者產品的權限。

這會允許查看您宇宙環境的相關資訊。

授予檢視授權使用者遊戲通行證設定詳細資訊的權限。

授予編輯授權使用者遊戲通行證的權限。

授予檢視帳號社群論壇資訊的權限。

授予管理帳號社群論壇資訊的權限。

這會允許查看您社群的相關資訊。

這能讓您管理自己帳號的社群加入申請和低階社群成員的角色更新。

允許你修改個體的屬性資料（目前僅支援指令碼）。

這可以查看有關您道具欄的資訊。

授予管理使用者資產的存取權。

授予管理您徽章和花費 Robux 的權限。

授予更新授權使用者徽章的權限。

授予管理您開發者產品的權限。

授予存取權限，以讀取你已開啟通知的體驗相關資訊。

授予存取權限，代你開啟或關閉體驗通知。

授予讀取與寫入您在地化表格的權限。

授予管理您擁有之所有體驗的團隊協作權限。

授予管理您的體驗及部分體驗相關資訊（例如：在地化資訊）的權限。

授予讀取您體驗之在地化資訊的權限。

授予修改您體驗在地化偏好的權限。

授予管理您使用者帳號的權限。

授予修改使用者在地化偏好的權限。

允許你檢視關聯地點的 Luau 執行任務狀態、紀錄和結果。

允許你為關聯地點建立新的 Luau 執行任務。

授予非同步清除宇宙中所有資料結構的存取權。

授予建立新佇列項目的存取權。

授予從佇列前端捨棄讀取項目的存取權。

授予從佇列前端讀取項目的權限。

授予讀取記憶存儲項目的存取權。

授予建立、更新和刪除地圖項目的存取權。

給予代替使用者發布訊息的能力。

這能讓您的體驗向使用者傳送通知。

（棄用）授予在已排序資料存儲中讀取條目清單的存取權。

（棄用）授予在已排序資料存儲中建立新條目的存取權。

授予從已排序資料存儲中列出條目的存取權。

授予在已排序資料存儲中建立條目的存取權。

此將允許列出與您的體驗相關的機密資料。

此將允許建立並更新與您的體驗相關的機密資料。

此權限可讓你提交評估工作，並檢視工作結果。

授予讀取您訂閱產品相關資訊的權限。

這項操作可讓你代為讀取縮圖資訊。

授予發佈新版本體驗到 Roblox 的權限。

授予編輯授權使用者體驗的權限。

讓您檢視體驗中的使用者限制。

讓您在體驗中編輯使用者限制。

這項操作將允許檢視傳送至你帳號的通知。

授予讀取權限，查看授權使用者的高級會員與驗證狀態。

此舉可以讓你查看授權使用者的社群帳號。

這將授予讀取您個人檔案資訊的權限。

此函式將允許時將會立刻傳回，但在能傳回值之前可以暫停呼叫自己的執行緒。

深入瞭解{linkStart}功能{linkEnd}。

Roblox 已不再支援或維護 {nameStart}name{nameEnd}。

Roblox 已不再支援或維護這項數學運算。

此成員未在物件瀏覽器出現，不應廣泛使用。

此成員只能透過指令列存取。從指令碼存取此成員將會導致錯誤。

此函式無法暫停呼叫自己的 Lua 執行緒。

在指令碼存取此成員將會導致錯誤。您可能可以從 Roblox Studio 的屬性視窗存取此成員。

此成員不再 Roblox Studio 的物件瀏覽器中。

您無法使用 Instance.new 建構式建立此類別的個體。

Roblox 不會跨越伺服器與用戶端界限而複製此成員。

Lua 程式碼無法存取此成員。您可能可以從 Roblox Studio 的屬性視窗變更其值。

此成員可從 OpenCloud Luau 執行任務存取。

此物件的複製行為取決於擁有的玩家。

此成員能透過指令列和外掛程式存取。從指令碼存取此成員將會導致錯誤。

此為唯讀成員。寫入此成員將會導致錯誤。

此為唯讀屬性，可以在未同步的執行緒讀取。嘗試寫入將會導致錯誤。

只有 Roblox CoreScript 可以存取此成員，Player 不可使用。

您可以安全地從多個執行緒對此屬性讀寫。

此類別為頂層 Singleton。使用 GetService 函式取得此類別的個體。

可在透過 {link1Start}RunService:BindToSimulation(){link1End} 綁定的回調中存取。支援回滾機制。請參閱{link2Start}伺服器授權{link2End}。

多個執行緒可以寫入此屬性，從未同步的執行緒讀取將有風險。

此函式在傳回結果前將會暫停呼叫自己的執行緒。此操作不會中斷其他指令碼。

locale.roblox.com

Localization

Metadata