Konfigurowalny klucz, który pozwala na szczegółowy dostęp do zasobów Roblox. Zobacz https://create.roblox.com/docs/cloud/auth/api-keys, aby uzyskać więcej informacji.

x-api-key

Ciastko przeglądarki, które reprezentuje tożsamość użytkownika Roblox. NIE DZIEL SIĘ TYM. Dzielenie się tym pozwoli komuś zalogować się jako Ty i ukraść Twoje Robux i przedmioty. Nie zalecamy używania ciastek do wywoływania końcówek. Gdy to możliwe, używaj kluczy API z nagłówkiem x-api-key lub OAuth 2.0 zamiast tego do uwierzytelniania.

.ROBLOSECURITY

Twórz lub autoryzuj aplikacje, aby uzyskać dostęp do zasobów Roblox. Zobacz https://create.roblox.com/docs/cloud/auth/oauth2-overview, aby uzyskać więcej informacji.

API Roblox. Zobacz https://create.roblox.com/docs/cloud/open-cloud po więcej szczegółów.

Roblox API

universeId

Pierwsza data w zakresie, określona jako yyyy-MM-dd.

startDate

Ostatnia data w zakresie, określona jako yyyy-MM-dd.

endDate

1: Nieprawidłowe IdUniwersum
2: NieprawidłowaDataPoczątkowa
3: NieprawidłowaDataKońcowa
4: NieprawidłowyZakresDat
5: Zabronione
6: ZbytWieleDni

0: Autoryzacja została odmówiona dla tego żądania.

Pobiera historię wypłat za zaangażowanie dla konkretnego uniwersum i danego zakresu dat, określonego przez daty początkowe i końcowe.

engagementpayouts.roblox.com

Projekty

Awatar

Zasoby

Przykłady i projekty

Interfejs API silnika

Otwarty interfejs API

Studio

Analityka

Platforma

Samouczki

Programy dla twórców

Edukacyjne

Kursy

Edukacja

Uwierzytelnianie za pomocą klucza interfejsu API.

Jest to metoda asynchroniczna, która zwraca deskryptor „Operation”, odpowiadający bieżącemu stanowi operacji. Zawiera punkt końcowy, który można wybrać przy użyciu funkcji poll, aby otrzymać rzeczywistą odpowiedź i nadające się do użycia metadane. Więcej informacji na temat operacji długotrwałych zawiera [dokumentacja]({longRunningOperationsLink}).
            
W poniższych sekcjach opisano odpowiedzi i obiekty w postaci metadanych, które zostają podane po ukończeniu operacji.

Punkty końcowe beta są gotowe do użytku publicznego. Zmiany wywołujące przerwy są możliwe, ale rzadkie.

Te strony dokumentacji Open Cloud zostaną usunięte 31 marca 2026 r. Wtedy nastąpi automatyczne przekierowanie do nowej dokumentacji Open Cloud. {linkStart}Dowiedz się więcej{linkEnd}

Te stare strony dotyczące Open Cloud zostaną usunięte, a użytkownicy zostaną przekierowani 31 marca 2026 r. {linkStart}Dowiedz się więcej{linkEnd}

Eksperymentalne punkty końcowe są gotowe do publicznego użycia, ale mogą czasami ulegać zmianom powodującym niezgodność w miarę finalizowania kontraktu API.

Ten punkt końcowy można wywołać w ramach interfejsu użytkownika za pośrednictwem usługi {httpServiceLinkStart}HttpService{httpServiceLinkEnd} przy użyciu klucza interfejsu API.

To pole może być skonfigurowane podczas tworzenia zasobu, ale może nie być modyfikowane przez kolejne żądania.

Te pola mogą być skonfigurowane podczas tworzenia zasobu, ale nie mogą być modyfikowane przez kolejne żądania.

To pole może być podane w żądaniach, ale nigdy nie będzie uwzględniane w odpowiedziach.

Starsza metoda uwierzytelniania. Zawsze wybieraj klucz interfejsu API lub OAuth 2.0, jeśli są dostępne.

Na klucz API: żądanie {maxInPeriod} co {periodInSeconds} s na adres IP

Nie wymaga uwierzytelnienia do wywołania. Zazwyczaj ma znacznie obniżone limity żądań. Zawsze używaj klucza interfejsu API lub protokołu OAuth 2.0, jeśli są dostępne.

Dla każdego grupowania należy podać tylko jedno z następujących pól w schemacie, pozostałe można wykluczyć.

W każdej chwili możesz ponownie ją włączyć. {linkStart}Prześlij opinię.{linkEnd}

Wyświetlasz starą dokumentację. {linkStart}Prześlij opinię.{linkEnd}

W każdej chwili możesz zrezygnować z tej opcji i powrócić do stron ze starą dokumentacją. {linkStart}Prześlij opinię.{linkEnd}

Wyświetlasz zaktualizowaną dokumentację. {linkStart}Prześlij opinię.{linkEnd}

To pole może być skonfigurowane do użycia w odpowiedziach, ale będzie ignorowane w żądaniach.

Uwaga: limity częstotliwości wysyłania żądań mogą być niższe w okresach dużego ruchu. Niektóre punkty końcowe mają dodatkowe limity częstotliwości wysyłania żądań. [Więcej informacji o limitach częstotliwości wysyłania żądań]({link}).

Liczba żądań na dzień dla wszystkich kluczy interfejsu API na użytkownika lub grupę: {limit}

Liczba żądań na godzinę dla wszystkich kluczy interfejsu API na użytkownika lub grupę: {limit}

Liczba żądań na minutę dla wszystkich kluczy interfejsu API na użytkownika lub grupę: {limit}

Liczba żądań na sekundę dla wszystkich kluczy interfejsu API na użytkownika lub grupę: {limit}

Liczba żądań na minutę na każdego właściciela klucza interfejsu API: {limit}

Liczba żądań na dzień na każdego użytkownika aplikacji: {limit}

Liczba żądań na godzinę na każdego użytkownika aplikacji: {limit}

Liczba żądań na minutę na każdego użytkownika aplikacji: {limit} 

Liczba żądań na sekundę na każdego użytkownika aplikacji: {limit}

Liczba żądań na sekundę na każdego właściciela klucza interfejsu API: {limit}

Zakresy służą do kontroli uprawnień, które przysługują Twoim poświadczeniom. Twoje poświadczenia mogą uzyskiwać dostęp wyłącznie do punktów końcowych, które są obsługiwane przez wybrane przez Ciebie zakresy.

Stabilne punkty końcowe są gotowe do użycia w środowisku produkcyjnym i niemal nigdy nie przechodzą zmian, które mogłyby spowodować niezgodność w trakcie ich działania.

Ten cel pozwala Ci ograniczyć dostęp Twojego klucza do wybranych {requiredParts}

Ten cel pozwala Ci ograniczyć dostęp Twojego klucza do wybranych {requiredParts} i {optionalParts}

Typy celów służą do ograniczania zasobów, do których masz uprawnienia zgodnie ze swoimi danymi dostępu. Działania mogą być podejmowane wyłącznie na wybranych zasobach, nawet jeżeli Twoje konto ma uprawnienia do dodatkowych zasobów. Niektóre zakresy nie mają wskazanych typów celów. W takich przypadkach działania mogą być podejmowane na wszystkich odpowiednich zasobach.

W przypadku kluczy API należących do użytkownika nie trzeba wybierać części najwyższego poziomu uniwersum. W takim przypadku klucz API będzie miał dostęp do wszystkich Twoich środowisk należących do użytkownika i środowisk należących do grupy, do których masz odpowiednie uprawnienia grupowe.

Funkcja „Wypróbuj” nie jest jeszcze obsługiwana w odniesieniu do punktów końcowych wymagających klucza API lub uwierzytelniania OAuth 2.0

Ze względów bezpieczeństwa uwierzytelnianie za pomocą plików cookie jest wyłączone w przypadku operacji o wysokim ryzyku.

Punkty końcowe o krytycznym poziomie ryzyka są niezwykle wrażliwe, dlatego funkcja „Wypróbuj” jest wyłączona ze względów bezpieczeństwa

Uwaga: nagłówki uwierzytelniające nie są uwzględnione w tym przykładzie kodu. Aby to polecenie działało, może być konieczne dodanie nagłówka uwierzytelniającego.

Jest to punkt końcowy o wysokim poziomie ryzyka, który może modyfikować lub usuwać dane krytyczne. Podczas testowania należy zachować szczególną ostrożność.

Ten punkt końcowy API został sklasyfikowany jako WYSOKIE RYZYKO i może mieć wpływ na opublikowane dane lub konta użytkowników.

Uwierzytelnione żądania do interfejsów API wysokiego ryzyka mogą wprowadzać zmiany, których nie da się cofnąć. Przed kontynuowaniem dokładnie sprawdź parametry swojego żądania.

Zaloguj się, aby użyć uwierzytelniania za pomocą plików cookie

Jest to punkt końcowy o niskim poziomie ryzyka, który pobiera dane. Na ogół można go bezpiecznie testować.

Jest to punkt końcowy o średnim poziomie ryzyka, który modyfikuje dane. Testuj ostrożnie przy użyciu kont o niekrytycznym znaczeniu, ponieważ zmiany mogą być trwałe.

Aby zapewnić bezpieczeństwo konta, nigdy nie wklejaj tutaj tekstu z innych źródeł ani nigdzie nie wysyłaj informacji z tej strony.

Za chwilę przetestujesz aktywne punkty końcowe interfejsu API przy użyciu rzeczywistych danych logowania do konta.

Przejdź dalej tylko wtedy, gdy rozumiesz konsekwencje wywołań interfejsu API, które zamierzasz wykonać. Przed rozpoczęciem testów dokładnie zapoznaj się z dokumentacją interfejsu API.

Wywołania interfejsu API będą wykonywane przy użyciu Twojej uwierzytelnionej sesji.

Są to rzeczywiste wywołania interfejsu API, które mogą mieć wpływ na Twoje konto lub dane.

Obowiązują limity w zakresie częstotliwości wykonywania wywołań i inne ograniczenia dotyczące interfejsu API.

Niektóre operacje mogą powodować modyfikację lub usunięcie danych.

Ten punkt końcowy został zastąpiony przez następując polecane punkty końcowe:

Aby wywołać ten punkt końcowy, wymagane są następujące zakresy. Aby uzyskać więcej
informacji na temat generowania odpowiednich kluczy, zobacz [Zarządzaj kluczami API]({apiKeyReferenceDocLink}).

Aby uzyskać więcej informacji na temat generowania kluczy, zobacz [Zarządzaj kluczami API]({apiKeyReferenceDocLink}).

Następujące punkty końcowe są dostępne za pośrednictwem ścieżek odnoszących się do podstawowego adresu URL.

Ten ciąg jest sformatowany jako [FieldMask](/cloud/reference/types#fieldmask).

Wartość JSON może być typu „null”, „boolean”, „string”, „number”, „array” lub „object”.

Do umożliwienia aplikacji OAuth 2.0 użycia tego punktu końcowego wymagane są następujące zakresy. Więcej informacji na temat rejestrowania aplikacji OAuth 2.0 można znaleźć w obszarze [Rejestracja i omówienie aplikacji]({oauth2ReferenceDocLink}).

Aby uzyskać więcej informacji na temat rejestracji aplikacji OAuth 2.0, zobacz [Rejestracja i weryfikacja aplikacji]({oauth2ReferenceDocLink}).

Następujące obiekty opisują ładunki, które są przyjmowane lub zwracane. Więcej informacji na temat tego, kiedy te obiekty są w użyciu, można znaleźć w poszczególnych punktach końcowych.

Do wywołania tego punktu końcowego wymagane są następujące zakresy.

Ścieżki do zasobów

Ten ciąg jest sformatowany jako [Timestamp](/cloud/reference/types#timestamp).

Niepolecane

Wyświetlasz zaktualizowaną dokumentację Open Cloud.

Zrezygnowano z korzystania z nowej dokumentacji Open Cloud.

Wyświetl swoje konta rozliczeniowe do reklam.

Wyświetlaj swoje kampanie reklamowe i ich wyniki.

Twórz, aktualizuj i zarządzaj kampaniami reklamowymi.

Umożliwia to wyświetlanie informacji na temat Twoich zasobów.

Umożliwia to przesyłanie i aktualizowanie zasobów na platformie Roblox.

Umożliwia to przyznawanie uprawnień do wyświetlania zasobów podmiotom (w tym grupom i projektom) oraz do zasobów, do których Twoje konto ma dostęp.

Umożliwia to przyznawanie uprawnień do zasobów dowolnym podmiotom (w tym grupom i projektom) oraz do zasobów, do których Twoje konto ma dostęp.

Umożliwia to wyświetlanie statusu i wyników zadań automatycznej konfiguracji awatarów w Twoim imieniu.

Umożliwia to tworzenie zadań automatycznej konfiguracji awatarów i zarządzanie nimi w Twoim imieniu.

Umożliwia aktualizowanie odznak należących do użytkownika.

Umożliwia wyświetlanie informacji na temat Twoich komercyjnych przedmiotów.

Umożliwia wprowadzanie zmian w Twoich zsynchronizowanych komercyjnych przedmiotach.

Umożliwia to przeglądanie informacji na temat połączeń z kontami sprzedawców.

Umożliwia edytowanie Twoich połączeń z kontem sprzedawcy.

Umożliwia to wyświetlanie informacji o Twoich produktach ze Sklepu twórcy.

Umożliwia to modyfikowanie informacji o Twoich produktach ze Sklepu twórcy.

Umożliwia to wyświetlanie informacji o zapisanych elementach ze Sklepu twórcy.

Umożliwia to modyfikowanie informacji o zapisanych elementach ze Sklepu twórcy.

Przyznaje dostęp do tworzenia magazynów danych w Twoim imieniu.

Przyznaje dostęp do usuwania magazynów danych w Twoim imieniu.

Przyznaje dostęp do odczytywania listy magazynów danych.

Przyznaje dostęp do tworzenia migawki Twoich magazynów danych.

Przyznaje dostęp do tworzenia wpisów w Twoich magazynach danych.

Przyznaje dostęp do oznaczania określonych wpisów do usunięcia.

Przyznaje dostęp do wyświetlania listy wpisów w magazynie danych.

Przyznaje dostęp do odczytywania określonych wpisów w Twoich magazynach danych.

Przyznaje dostęp do aktualizowania wartości, atrybutów i użytkowników wpisu.

Przyznaje dostęp do usuwania wersji wpisów w magazynie danych.

Przyznaje dostęp do wyświetlania listy wersji wpisów w magazynie danych.

Przyznaje dostęp do odczytywania wersji wpisów w magazynie danych.

Przyznaje dostęp do wyświetlania szczegółów konfiguracji produktów deweloperskich autoryzowanego użytkownika.

Przyznaje dostęp do edytowania produktów deweloperskich autoryzowanego użytkownika.

Umożliwia to wyświetlanie informacji na temat środowisk w Twoim uniwersum.

Umożliwia to edytowanie środowisk w Twoim uniwersum.

Przyznaje dostęp do wyświetlania szczegółów konfiguracji przepustek do gry autoryzowanego użytkownika.

Przyznaje dostęp do edytowania przepustek do gry autoryzowanego użytkownika.

Przyznaje dostęp do wyświetlania informacji o forach społeczności związanych z Twoim kontem.

Przyznaje dostęp do zarządzania informacjami o forach społeczności związanych z Twoim kontem.

Umożliwia to wyświetlanie informacji na temat Twoich społeczności.

Umożliwia zarządzanie prośbami o dołączenie do społeczności i aktualizacjami ról członków społeczności o niższej randze na Twoim koncie.

Umożliwia wyświetlenie danych właściwości instancji.

Umożliwia modyfikowanie danych właściwości instancji (obecnie obsługuje tylko skrypty).

Umożliwia wyświetlanie informacji o Twoim wyposażeniu.

Przyznaje dostęp do zarządzania zasobami użytkownika.

Przyznaje dostęp do zarządzania Twoimi odznakami.

Przyznaje dostęp do zarządzania Twoimi odznakami i wydawaniem Robuxów.

Przyznaje dostęp do aktualizowania odznak autoryzowanego użytkownika.

Przyznaje dostęp do zarządzania Twoimi produktami deweloperskimi.

Przyznaje dostęp do odczytywania informacji o projektach, dla których masz włączone powiadomienia.

Przyznaje dostęp do włączania i wyłączania powiadomień o projektach w Twoim imieniu.

Przyznaje dostęp do zarządzania Twoimi przepustkami.

Przyznaje dostęp do zarządzania Twoimi społecznościami.

Przyznaje uprawnienie do odczytywania informacji dotyczących społeczności.

Przyznaje uprawnienia do zarządzania społecznościami.

Przyznaje dostęp do odczytywania i zapisywania Twoich tabel dotyczących lokalizacji

Przyznaje dostęp do zarządzania współpracą zespołową w odniesieniu do wszystkich projektów, które posiadasz.

Przyznaje dostęp do zarządzania Twoimi projektami i niektórymi informacjami związanymi z Twoimi projektami (np. informacjami dotyczącymi lokalizacji).

Przyznaje dostęp do odczytywania informacji dotyczących lokalizacji Twoich projektów.

Przyznaje dostęp do modyfikowania preferencji dotyczących lokalizacji Twoich projektów.

Przyznaje dostęp do zarządzania Twoim kontem użytkownika.

Przyznaje dostęp do modyfikowania preferencji dotyczących lokalizacji użytkowników.

Umożliwia przeglądanie statusu, dzienników i wyników zadań wykonawczych Luau dla skojarzonego miejsca.

Umożliwia tworzenie nowych zadań wykonawczych Luau dla skojarzonego miejsca.

Umożliwia asynchroniczne czyszczenie wszystkich struktur danych w uniwersum.

Przyznaje dostęp do tworzenia nowych elementów kolejki.

Przyznaje dostęp do odrzucania odczytanych elementów z początku kolejki.

Przyznaje dostęp do odczytywania elementów znajdujących się na początku kolejki.

Przyznaje dostęp do odczytywania elementów Twojego magazynu pamięci.

Przyznaje dostęp do odczytywania elementów mapy.

Przyznaje dostęp do tworzenia, aktualizowania i usuwania elementów mapy.

Umożliwia to publikowanie wiadomości w imieniu użytkowników.

Umożliwia wysyłanie powiadomień z projektu do użytkowników.

(Przestarzałe) Przyznaje dostęp do odczytu listy wpisów w uporządkowanym magazynie danych.

(Przestarzałe) Przyznaje dostęp do tworzenia nowego wpisu w uporządkowanym magazynie danych.

Przyznaje dostęp do wyświetlania listy wpisów z uporządkowanego magazynu danych.

Przyznaje dostęp do tworzenia wpisów w uporządkowanym magazynie danych.

Umożliwia to wyświetlenie listy obiektów tajnych związanych z projektem.

Umożliwia to tworzenie i aktualizowanie obiektów tajnych związanych z projektem.

To uprawnienie umożliwia przesyłanie zadania oceny i wyświetlanie jego wyniku.

Przyznaje dostęp do odczytywania informacji o Twoich produktach objętych subskrypcją.

Umożliwia to odczytywanie informacji miniatur w Twoim imieniu.

Umożliwia odczytywanie statystyk dotyczących gry.

Umożliwia odczytywanie informacji dotyczących miejsca.

Umożliwia edytowanie informacji dotyczących miejsca.

Przyznaje dostęp do publikowania nowych wersji projektów na platformie Roblox.

Umożliwia odczytywanie informacji dotyczących projektu.

Przyznaje dostęp do edytowania projektów autoryzowanego użytkownika.

Umożliwia wyświetlenie ograniczeń dotyczących użytkowników w projekcie.

Umożliwia edytowanie ograniczeń dotyczących użytkowników w projekcie.

Umożliwia to wyświetlanie powiadomień wysyłanych na Twoje konto.

Umożliwia odczytywanie statusu poziomu premium i weryfikacji autoryzowanego użytkownika.

Umożliwia wyświetlanie kont społecznościowych autoryzowanego użytkownika.

Umożliwia to korzystanie z funkcji jednokrotnego logowania.

Przyznaje to dostęp do odczytywania informacji dotyczących Twojego profilu.

Jeśli to możliwe ta funkcja zwraca wartość natychmiast, ale jako wynik może podawać wątek, który ją wywołał, do momentu zwrócenia wartości.

Dowiedz się więcej o {linkStart}możliwościach{linkEnd}.

{nameStart}nazwa{nameEnd} nie jest już obsługiwana ani utrzymywana na platformie Roblox.

Ten punkt końcowy nie jest już obsługiwany ani utrzymywany na platformie Roblox.

To działanie matematyczne nie jest już obsługiwane ani utrzymywane na platformie Roblox.

Ten członek nie jest widoczny w wyszukiwarce obiektów i nie jest przeznaczony do powszechnego użycia.

Ten członek jest dostępny tylko za pośrednictwem paska poleceń. Próba uzyskania dostępu do tego członka poprzez skrypty powoduje wystąpienie błędu.

Ta funkcja nie może wstrzymać wątku Lua, który ją wywołał.

Próba uzyskania dostępu do tego członka poprzez skrypty powoduje wystąpienie błędu. Możesz spróbować uzyskać dostęp do tego członka poprzez okno właściwości aplikacji Roblox Studio.

Ten członek nie jest widoczny w przeglądarce obiektów w aplikacji Roblox Studio.

Nie możesz utworzyć instancji tej klasy, używając polecenia Instance.new constructor.

Platforma Roblox nie replikuje tego członka poza jego granicę serwer-klient.

Kod Lua nie może uzyskać dostępu do tego członka. Możliwe, że uda ci się zmienić jego wartość w oknie właściwości w aplikacji Roblox Studio.

Ten członek jest dostępny z poziomu zadań środowiska wykonawczego OpenCloud Luau.

Zachowanie replikacyjne tego obiektu jest zależne od gracza, który jest jego właścicielem.

Ten członek jest dostępny za pośrednictwem paska poleceń i dodatków plug-in. Próba uzyskania dostępu do tego członka poprzez skrypty powoduje wystąpienie błędu.

Członek tylko do odczyty. Próba zapisu związana z tym członkiem powoduje wystąpienie błędu.

Ta właściwość jest tylko do odczytu i można ją bezpiecznie odczytywać w niezsynchronizowanych wątkach. Próba jej zapisania powoduje wystąpienie błędu.

Dostępne są alternatywne punkty końcowe, które go zastępują.

Ten członek jest dostępny tylko w ramach skryptów CoreScript.

Tylko skrypty Roblox CoreScript mogą mieć dostęp do tego członka i nie może być używany przez graczy.

Tę właściwość można bezpiecznie odczytywać i zapisywać w ramach wielu wątków.

Ta klasa to przypadek wyjątkowy najwyższego poziomu. Pobierz instancję tej klasy przy użyciu funkcji GetService.

Dostęp jest możliwy w ramach wywołań zwrotnych powiązanych za pośrednictwem {link1Start}RunService:BindToSimulation(){link1End}. Uczestniczy w przywracaniu. Patrz: {link2Start}uprawnienia serwera{link2End}.

Większa liczba wątków może spowodować zapisanie w tej właściwości, a zatem odczytywanie niezsynchronizowanych wątków może być niebezpieczne.

Ta funkcja wstrzymuje wątek Lua, który ją wywołał, do momentu zwrócenia wyniku. Nie powoduje to przerwania działania innych skryptów.

engagementpayouts.roblox.com

Universes