Reference API Roblox

Engine API

Website

Related

Reference API Roblox

PolicyService

Helps you query information regarding policy compliance for players around the world based on age range, location, and platform type.

This class is not replicated. Its interface does not cross the network boundary.
This class is not creatable. Instances of this class cannot be created with Instance.new.
This class is a service. It is a singleton that may be acquired with GetService.
Memory categoryInstances
Tags: [NotCreatable, Service, NotReplicated]

Member index 5

HistoryMember
652CanViewBrandProjectAsync(player: Player, brandProjectId: string): bool
462GetPolicyInfoForPlayerAsync(player: Instance): Dictionary
491GetPolicyInfoForServerRobloxOnlyAsync(): Dictionary
inherited from Instance
731Archivable: bool
731Capabilities: SecurityCapabilities
731IsInSandbox: bool
731Name: string
731Parent: Instance
731PredictionMode: PredictionMode
731Sandboxed: bool
731UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
707GetDescendants(): Instances
486GetFullName(): string
706GetStyled(name: string, selector: string?): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
698QueryDescendants(selector: string): Instances
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
731children(): Instances
731clone(): Instance
731destroy(): null
731findFirstChild(name: string, recursive: bool = false): Instance
731getChildren(): Instances
731isDescendantOf(ancestor: Instance): bool
731remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
731childAdded(child: Instance)
inherited from Object
731ClassName: string
731className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
731isA(className: string): bool
647Changed(property: string)

Description

PolicyService helps you query information regarding policy compliance for players around the world based on age range, location, and platform type.

History 17

Members 5

CanViewBrandProjectAsync

Parameters (2)
playerPlayer
brandProjectIdstring
Returns (1)
bool

Determines if a user can see brand project assets inside your experience. This method lets you work with brands to only show commercial assets to brand-compliant audiences.

To use CanViewBrandProjectAsync, you must use a brand project ID provided by Roblox. To request a brand project ID, contact us.

You must call this method on a server-side Script and wrap it in a pcall().

This function yields. It will block the calling thread until completion.
Thread safetyUnsafe

History 1

Tags: [Yields]

GetPolicyInfoForPlayerAsync

Parameters (1)
playerInstance
Returns (1)
Dictionary

Returns policy information about a player based on geolocation, age group, and platform. The structure of the returned dictionary is as follows:

NameTypeRequired forDescription
AreAdsAllowedBooleanAny experience that includes immersive ads.When true, the player might see immersive ads within an experience.
ArePaidRandomItemsRestrictedBooleanAny experience that has paid random items.When true, the player can not interact with paid random item generators, either via in‑experience currency bought with Robux or Robux directly.
IsContentSharingAllowedBooleanAny feature in the experience that enables users to create content (e.g. text, images, video, audio) that other users can see in the experience or allows user to share content within experiences.When true, the player can use features related to sharing UGC within an experience, such as uploading a screen capture, sharing a video, or posting an image to a content feed that other users can see.
IsEligibleToPurchaseCommerceProductBooleanAny experience that wants to sell commerce products.When true, the player is eligible to purchase commerce products within an experience.
IsEligibleToPurchaseSubscriptionBooleanAny experience that wants to sell subscriptions.When true, the player is eligible to purchase subscriptions within an experience.
IsPaidItemTradingAllowedBooleanAny experience that allows users to purchase virtual items that they can trade with other players.When true, the player can trade virtual items that they purchased with in-experience currency or Robux.
IsPhotoToAvatarAllowedBooleanAny experience that uses the Photo-to-Avatar APIs.When true, the player is permitted by policy to use the Photo-to-Avatar API `Class.AvatarCreationService:PromptSelectAvatarGenerationImageAsync()`. This flag reflects age (for example, users under 13) and regional restrictions, which are evaluated server-side. Check it before calling Photo-to-Avatar APIs to avoid policy-related errors. Note that a true value does not by itself guarantee the prompt will succeed: camera and photo-library availability is checked separately on the player's device, so calls can still fail on platforms where camera access is unavailable.
IsSubjectToChinaPoliciesBooleanAny experience that is available in China.When true, an experience should enforce compliance changes. See this forum post for more information.
AllowedExternalLinkReferencesArrayNot required.This is a legacy field. It always returns an empty array.
IsEndlessContentLoadAllowedBooleanAny experience that includes a feature where content loads automatically and endlessly as the user scrolls, such as a feed, providing an endless flow of media content without requiring the user to engage in any specific interaction such as manual "load more" actions or separate pagination.When true, the player can use features with endless content loading within an experience.
IsEndlessContentAutoplayAllowedBooleanAny experience that contains media content (video or audio) that automatically and endlessly plays without requiring user interaction or initiation, for example clicking a play button.When true, the player can use features within an experience that automatically and endlessly play media content.

Exceptions

Like any async call, this method needs to be wrapped in pcall() and error-handled properly. A full list of possible error messages and their reasons is:

MessageReason
Instance was not a playerThe player parameter is not a Player instance.
Players not foundInternal error that the Players object is missing.
This method cannot be called on the client for a non-local playerThis method cannot be called on the client for a non-local Player.
GetPolicyInfoForPlayerAsync is called too many timesInternal error that GetPolicyInfoForPlayerAsync() is called more than 100 (current setting) times before an HTTP response comes back.

See also LocalizationService:GetCountryRegionForPlayerAsync() which returns a country/region code string according to the player's client IP geolocation.

This function yields. It will block the calling thread until completion.
Thread safetyUnsafe

History 2

Tags: [Yields]

GetPolicyInfoForServerRobloxOnlyAsync

Parameters (0)
No parameters.
Returns (1)
Dictionary
This function yields. It will block the calling thread until completion.
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 1

Tags: [Yields]

Settings