Gets an instance and its property data.

 The maximum supported response data size is 500,000 bytes. If this limit is
 exceeded, the returned `Operation` will be completed with an error result
 that has an error code of `422`.

path

Get Instance

Updates an instance's property data.

 When updating a `Script` instance's source property, the maximum supported
 property size is 200,000 bytes after UTF-8 encoding.

query

Update Instance

Lists an instance's children.

 The maximum supported response data size is 500,000 bytes. If this limit is
 exceeded, the returned `Operation` will be completed with an error result
 that has an error code of `422`.

List Instance Children

string

Instance

AcceptGroupJoinRequestRequest

Represents a quota for an asset-related action.
 For example, a user can have 10 usage out of 100 capacity for a 1 month
 period.

AssetQuota

The resource path of the asset quota.

 Format: `users/{user_id}/asset-quotas/{asset_quota_id}`

Type of quota.

Possible values:

  | Value | Description |
  | --- | --- |
  | QUOTA_TYPE_UNSPECIFIED | The default quota type. |
  | RATE_LIMIT_UPLOAD | Rate limit on how often one can upload an asset. |
  | RATE_LIMIT_CREATOR_STORE_DISTRIBUTE | Rate limit on how often one can distribute an asset on the creator store. |

quotaType

The asset type the quota is for.

Possible values:

  | Value | Description |
  | --- | --- |
  | ASSET_TYPE_UNSPECIFIED | Default AssetType. |
  | ASSET_TYPE_IMAGE | Image |
  | ASSET_TYPE_TSHIRT | Tshirt |
  | ASSET_TYPE_AUDIO | Audio |
  | ASSET_TYPE_MESH | Mesh |
  | ASSET_TYPE_LUA | Lua |
  | ASSET_TYPE_HAT | Hat |
  | ASSET_TYPE_PLACE | Place |
  | ASSET_TYPE_MODEL | Model |
  | ASSET_TYPE_SHIRT | Classic Shirt |
  | ASSET_TYPE_PANTS | Classic Pants |
  | ASSET_TYPE_DECAL | Decal |
  | ASSET_TYPE_HEAD | Head |
  | ASSET_TYPE_FACE | Face |
  | ASSET_TYPE_GEAR | Gear |
  | ASSET_TYPE_ANIMATION | Animation |
  | ASSET_TYPE_TORSO | Torso |
  | ASSET_TYPE_RIGHT_ARM | Right Arm |
  | ASSET_TYPE_LEFT_ARM | Left Arm |
  | ASSET_TYPE_LEFT_LEG | Left Leg |
  | ASSET_TYPE_RIGHT_LEG | Right Leg |
  | ASSET_TYPE_YOUTUBE_VIDEO | YouTube Video |
  | ASSET_TYPE_APP | App |
  | ASSET_TYPE_CODE | Code |
  | ASSET_TYPE_PLUGIN | Plugin |
  | ASSET_TYPE_SOLID_MODEL | Solid Model |
  | ASSET_TYPE_MESH_PART | Mesh Part |
  | ASSET_TYPE_HAIR_ACCESSORY | Hair Accessory |
  | ASSET_TYPE_FACE_ACCESSORY | Face Accessory |
  | ASSET_TYPE_NECK_ACCESSORY | Neck Accessory |
  | ASSET_TYPE_SHOULDER_ACCESSORY | Shoulder Accessory |
  | ASSET_TYPE_FRONT_ACCESSORY | Front Accessory |
  | ASSET_TYPE_BACK_ACCESSORY | Back Accessory |
  | ASSET_TYPE_WAIST_ACCESSORY | Waist Accessory |
  | ASSET_TYPE_CLIMB_ANIMATION | Climb Animation |
  | ASSET_TYPE_DEATH_ANIMATION | Death Animation |
  | ASSET_TYPE_FALL_ANIMATION | Fall Animation |
  | ASSET_TYPE_IDLE_ANIMATION | Idle Animation |
  | ASSET_TYPE_JUMP_ANIMATION | Jump Animation |
  | ASSET_TYPE_RUN_ANIMATION | Run Animation |
  | ASSET_TYPE_SWIM_ANIMATION | Swim Animation |
  | ASSET_TYPE_WALK_ANIMATION | Walk Animation |
  | ASSET_TYPE_POSE_ANIMATION | Pose Animation |
  | ASSET_TYPE_LOCALIZATION_TABLE_MANIFEST | Localization Table Manifest |
  | ASSET_TYPE_LOCALIZATION_TABLE_TRANSLATION | Localization Table Translation |
  | ASSET_TYPE_EMOTE_ANIMATION | Emote Animation |
  | ASSET_TYPE_VIDEO | Video |
  | ASSET_TYPE_TEXTURE_PACK | Texture Pack |
  | ASSET_TYPE_TSHIRT_ACCESSORY | Tshirt Accessory |
  | ASSET_TYPE_SHIRT_ACCESSORY | Shirt Accessory |
  | ASSET_TYPE_PANTS_ACCESSORY | Pants Accessory |
  | ASSET_TYPE_JACKET_ACCESSORY | Jacket Accessory |
  | ASSET_TYPE_SWEATER_ACCESSORY | Sweater Accessory |
  | ASSET_TYPE_SHORTS_ACCESSORY | Shorts Accessory |
  | ASSET_TYPE_LEFT_SHOE_ACCESSORY | Left Shoe Accessory |
  | ASSET_TYPE_RIGHT_SHOE_ACCESSORY | Right Shoe Accessory |
  | ASSET_TYPE_DRESS_SKIRT_ACCESSORY | Dress Skirt Accessory |
  | ASSET_TYPE_FONT_FAMILY | Font Family |
  | ASSET_TYPE_FONT_FACE | Font Face |
  | ASSET_TYPE_MESH_HIDDEN_SURFACE_REMOVAL | Mesh Hidden Surface Removal |
  | ASSET_TYPE_EYEBROW_ACCESSORY | Eyebrow Accessory |
  | ASSET_TYPE_EYELASH_ACCESSORY | Eyelash Accessory |
  | ASSET_TYPE_MOOD_ANIMATION | Mood Animation |
  | ASSET_TYPE_DYNAMIC_HEAD | Dynamic Head |
  | ASSET_TYPE_CODE_SNIPPET | Code Snippet |
  | ASSET_TYPE_ADS_VIDEO | Ads Video |

assetType

usage

capacity

The period of time the quota is for.

Possible values:

  | Value | Description |
  | --- | --- |
  | PERIOD_UNSPECIFIED | The default period. |
  | MONTH | Month. |
  | DAY | Day. |

period

The time the usage will reset for this quota.

usageResetTime

AvatarAsset represents an body part asset or accessory that belongs to a
 body. Need to be in sync with avatar-core source definition:
 https://github.rbx.com/Roblox/avatar-core/blob/master/protos/roblox/avatarcore/outfits/v1beta1/outfits.proto#L27

AvatarAsset

Asset ID.

 Format: "assets/123"

 Note: This resource path refers to apis.roblox.com/assets.  That is,
 the full URI of the asset might look like
 "apis.roblox.com/assets/v1/assets/123".

asset

Metadata that describes how the asset should be equipped within body.

AvatarAsset_AssetPosition

X adjustment of the modified position in studs.

y adjustment of the modified position in studs.

Z adjustment of the modified position in studs.

Accessory refinement property, allowing consumers to control how much an
 asset is rotated with respect to its default orientation.

AvatarAsset_AssetRotation

Accessory refinement property, allowing consumers to control how much an
 asset is scaled with respect to its default size.

AvatarAsset_AssetScale

Total scale multiplier of accessory (deprecated).

scale

Metadata that describes how the asset should be equipped on an avatar.

AvatarAsset_Meta

Layered clothing property, allowing consumers to track business-logic
 difference between backwards-incompatible structure revisions.

layeredClothingVersion

order

Puffiness Controls how much underlying clothing items inflate the current
 clothing item. Range: -1 ~ 1

puffiness

Position controls how the asset has its position adjusted relative to its
 default location

position

Rotation controls how much an asset is rotated with respect to its
 default orientation

rotation

Scale controls how much an asset is scaled with respect to its default
 size.

Represents an avatar body -- outfit that consists of multiple bodypart
 assets. The body is created in experience

AvatarBody

The resource path of the avatar body.

 Format: `avatar-bodies/{avatar_body_id}`

name

colors

bodyAssets

bodyScale

otherAssets

Body type

Possible values:

  | Value | Description |
  | --- | --- |
  | PLAYER_AVATAR_TYPE_UNSPECIFIED | default value, unspecified (invalid) avatar type |
  | PLAYER_AVATAR_TYPE_R6 | represents R6 avatar type |
  | PLAYER_AVATAR_TYPE_R15 | represents R15 avatar type |

avatarType

Operation Id
 go/aip/not-precedent: This is a short-term solution to meet Expedition time
 constraints that will only be exposed to Engine-side internal code. Methods
 using this resource will never be exposed through API Gateway while this
 field exists.

operationId

Represents the process of creating a new avatar in the system. The resource
 manages the lifecycle of avatar creation, from initial submission to
 finalization, including the addition of necessary items.

AvatarCreation

The resource path of the avatar creation.

 Format: `avatar-creations/{avatar_creation_id}`

The name of the avatar being created. This will be the final name for the
 avatar. Must be non-empty. Has a maximum limit of 50 characters.

displayName

The description of the avatar being created. This will be the final
 description for the avatar. Has a maximum limit of 1000 characters.

description

The creation state of the avatar creation.
 Creation is a two steps process where you create and finalized
 the creation by adding the assets later through AddItems call.

Possible values:

  | Value | Description |
  | --- | --- |
  | CREATION_STATE_UNSPECIFIED | Default value. |
  | CREATION_STATE_INITIALIZED | Creation is initialized. |
  | CREATION_STATE_PENDING | Creation is in progress. |
  | CREATION_STATE_SUCCEEDED | Creation is succeeded. |
  | CREATION_STATE_FAILED | Creation is failed. |

creationState

The moderation state of the Avatar Body.

Possible values:

  | Value | Description |
  | --- | --- |
  | MODERATION_STATE_UNSPECIFIED | Default value. |
  | MODERATION_STATE_PENDING | Moderation is in progress. |
  | MODERATION_STATE_APPROVED | Moderation is approved. |
  | MODERATION_STATE_REJECTED | Moderation is rejected. |

moderationState

The reason of creation failure.

Possible values:

  | Value | Description |
  | --- | --- |
  | CREATION_FAILURE_REASON_UNSPECIFIED | Default value. |
  | CREATION_FAILURE_REASON_VALIDATION_FAILED | Avatar content validation is failing. |

creationFailureReason

Full body including head, torso, arms and legs.

body

head

The creation context when the avatar is created in an experience.

experienceCreationContext

Represents the token that allows creators to expose functionality to users
 for creating avatar items within an experience.

AvatarCreationToken

The resource path of the avatar creation token.

 Format:
 `universes/{universe_id}/avatar-creation-tokens/{avatar_creation_token_id}`

The name of the AvatarCreationToken.

 Must be non-empty. Has a maximum limit of 50 characters.

The description of the AvatarCreationToken.

 Must be non-empty. Has a maximum limit of 1000 characters.

user

The AvatarCreationToken is group-created.

group

The item type of the AvatarCreationToken.

itemType

The UTC timestamp at which the  was created.

createTime

The dynamic price configuration of the AvatarCreationToken.

dynamicPrice

The sale mode of the AvatarCreationToken.

 It'll always be on sale by default unless the user
 or group owner is missing the requirements.

Possible values:

  | Value | Description |
  | --- | --- |
  | SALE_MODE_UNSPECIFIED | Unspecified sale mode. |
  | ON_SALE | The AvatarCreationToken is on sale. |
  | OFF_SALE | The AvatarCreationToken is off sale. |

saleMode

The off sale reasons of the AvatarCreationToken.

 The list will be empty if the AvatarCreationToken is on sale.

Possible values:

  | Value | Description |
  | --- | --- |
  | OFF_SALE_REASON_UNSPECIFIED | Unspecified off sale reason. |
  | MISSING_ID_VERIFICATION | The creator is missing id verification. |
  | CREATION_ACCESS_BLOCKED | The creator's creation access is blocked. |
  | MISSING_PREMIUM_SUBSCRIPTION_TIER | The creator is missing premium subscription tier. |
  | GROUP_OWNER_MISSING_PREMIUM_SUBSCRIPTION_TIER | The group owner is missing premium subscription tier. |

offSaleReasons

When the actual price is different with the expected price, the operation
 will fail.

expectedCreationCosts

The costs to create an AvatarCreationToken

AvatarCreationToken_CreationCosts

Creation fee in Robux when creating an AvatarCreationToken.

 Creation fees are not refunded.

creationFeeRobux

Creation advance in Robux to be paid upfront at the time of creation.

 Roblox will rebate this advance back to the creator as user
 purchase creations authorized by this AvatarCreationToken.

creationAdvanceRobux

The dynamic price configuration to set an amount above the price floor
 or set the lowest price you're willing to sell.

AvatarCreationToken_DynamicPrice

The AvatarCreationToken will never be priced below this amount.

minimumPriceRobux

The price relative to the price floor.

 For example, inputting '5' will price your item 5 Robux above the price
 floor, unless you have specified a minimum price.

priceOffsetRobux

Current price of the item in Robux based on the dynamic price floor,
 minimum price, and price offset calculation.

currentPriceRobux

AvatarCreationToken_ItemType

Represents an asset.

Possible values:

  | Value | Description |
  | --- | --- |
  | ASSET_TYPE_UNSPECIFIED | Unspecified AssetType. |
  | HAT | Hat. |
  | HAIR_ACCESSORY | Hair Accessory. |
  | FACE_ACCESSORY | Face Accessory. |
  | NECK_ACCESSORY | Neck Accessory. |
  | SHOULDER_ACCESSORY | Shoulder Accessory. |
  | FRONT_ACCESSORY | Front Accessory. |
  | BACK_ACCESSORY | Back Accessory. |
  | WAIST_ACCESSORY | Waist Accessory. |
  | TSHIRT_ACCESSORY | Tshirt Accessory. |
  | SHIRT_ACCESSORY | Shirt Accessory. |
  | PANTS_ACCESSORY | Pants Accessory. |
  | JACKET_ACCESSORY | Jacket Accessory. |
  | SWEATER_ACCESSORY | Sweater Accessory. |
  | SHORTS_ACCESSORY | Shorts Accessory. |
  | DRESS_SKIRT_ACCESSORY | Dress Skirt Accessory. |

Represents a bundle.

Possible values:

  | Value | Description |
  | --- | --- |
  | BUNDLE_TYPE_UNSPECIFIED | Unspecified BundleType. |
  | BODY | Body. |
  | DYNAMIC_HEAD | Dynamic Head. |

bundleType

AvatarAsset represents an asset that belongs to an avatar.

AvatarCreation_AvatarAsset

Represents the body of avatars which includes assets for the head, arms,
 legs, and torso.

AvatarCreation_Body

assets

outfitId

bundleId

AvatarCreation_BodyAssets

torso

rightArm

leftArm

rightLeg

leftLeg

hairAccessory

Represent scale factors of different aspects of an avatar body.

AvatarCreation_BodyScale

Determines by what factor the height (top-to-bottom distance) is scaled.
 Range 0.9-1.05.

heightScale

Determines by what factor the width (left-to-right distance) is
 scaled. Range: 0.7-1.0

widthScale

Determines by what factor the Head is scaled. Range 0.95-1.0

headScale

Determines how wide (0) or narrow (1) a Humanoid rig. Range 0.0-1.0

proportion

Determines by which the shape of a Humanoid rig is interpolated. Range
 0.0-1.0

bodyType

The creation context required for creating an avatar within an experience.

 This holds information such as the AvatarCreationToken and
 the expected price of the AvatarCreationToken.

AvatarCreation_ExperienceCreationContext

The path of the AvatarCreationToken.

 Format:
 "universes/{universe_id}/avatar-creation-tokens/{avatar_creation_token_id}"

avatarCreationToken

The expected price of AvatarCreationToken in Robux.

 When the actual price of AvatarCreationToken is different with the
 expected price, the operation will fail.

expectedPriceRobux

Represents the head of avatars which includes assets for the head, eyebrow,
 and eyelash.

AvatarCreation_Head

AvatarCreation_HeadAssets

dynamicHead

eyebrowAccessory

eyelashAccessory

Represents an order in the Avatar Marketplace.

AvatarMarketplaceOrder

The resource path of the avatar marketplace order.

 Format: `avatar-marketplace-orders/{avatar_marketplace_order_id}`

purchasingUser

fulfillmentGroups

Place the order was made in, if it was made in a place.

purchasePlace

context

Fulfillment state of the whole order.

Possible values:

  | Value | Description |
  | --- | --- |
  | UNKNOWN | Default value. |
  | PENDING | Pending fulfillment. |
  | RESERVED | Items to be purchased are finalized, but not yet fully fulfilled. |
  | SUCCEEDED | Successfully fulfilled. |
  | FAILED | Failed. |

status

receipt

An encrypted batch purchase authentication token that is required when
 making in-experience purchases. This is only used by the first-party use
 case of purchasing collectibles in-experience via Game Engine
 PromptPurchase. The token is fetched from backends by RCC and passed back
 to the Roblox Client to include here into the Order creation request to
 prove the purchase was authorized by the experience creator. As a UML
 Sequence Diagram:
   participant User
   participant Client
   participant RCC
   participant OrdersApi
   participant Collectibles
   User -> RCC: Completed Quest, trigger PromptBulkPurchase
   RCC -> Collectibles: GenerateBatchPurchaseAuthToken
   RCC -> Client: PromptBulkPurchase w/ AuthToken
   Client -> User: Show Purchase Prompt
   User -> Client: Approve purchase
   Client -> OrdersApi: CreateOrder w/ AuthToken + User Auth

batchPurchaseAuthToken

Contextual information, generally used for logging.

AvatarMarketplaceOrder_Context

Product surface where the order was made, eg. game_engine or
 shopping_cart.

Possible values:

  | Value | Description |
  | --- | --- |
  | UNKNOWN | Default value. |
  | OAUTH_APP | OAuth 3rd party application. |
  | GAME_ENGINE | Game engine. |
  | SHOPPING_CART_WEB | Shopping cart on web. |

productSurface

Groups of line items to fulfill together.

AvatarMarketplaceOrder_FulfillmentGroup

Strategy to use to fulfill the items in this group.

Possible values:

  | Value | Description |
  | --- | --- |
  | UNKNOWN | Default value. |
  | BEST_EFFORT | Best effort, some line items may fail without failing the whole group. |

strategy

List of line items in the fulfillment group.

lineItems

Status of the fulfillment group.

Possible values:

  | Value | Description |
  | --- | --- |
  | UNKNOWN | Default value. |
  | PENDING | Pending fulfillment. |
  | RESERVED | Items to be purchased are finalized, but not yet fully fulfilled. |
  | SUCCEEDED | Successfully fulfilled. |
  | FAILED | Failed. |

AvatarMarketplaceOrder_LineItem

ID of the product to purchase if it is a Collectible.

collectibleProductId

ID of the product to purchase in the VirtualEconomy system.

virtualEconomyProductId

Instance ID for a Limited 1.0 item (aka UserAssetId).

limitedV1InstanceId

Agreed price on the item. Transcoded as string in JSON.

agreedPriceRobux

ID of the asset being purchased if it is an asset.

assetId

ID of the bundle being purchased if it is a Bundle.

Status of the line item.

Possible values:

  | Value | Description |
  | --- | --- |
  | UNKNOWN | Default value. |
  | PENDING | Pending fulfillment. |
  | RESERVED | Items to be purchased are finalized, but not yet fully fulfilled. |
  | SUCCEEDED | Successfully fulfilled. |
  | FAILED | Failed. |

Reason for the error, if the status is an error status.

Possible values:

  | Value | Description |
  | --- | --- |
  | UNKNOWN | Unset or unknown. |
  | INTERNAL | Internal error. |
  | INSUFFICIENT_ROBUX | Insufficient robux. |
  | QUOTA_EXCEEDED | Purchase quota exceeded for the user or product. |
  | INVALID_REQUEST | Request is invalid. |
  | INVALID_PRODUCT_TYPE | Product type is invalid or unsupported. |
  | NOT_FOR_SALE | Product is not for sale. |
  | NOT_AVAILABLE_FOR_PURCHASER | Product is not available for purchase by the purchaser. |
  | PRICE_MISMATCH | Price provided does not match the product price. |
  | SOLD_OUT | Product is sold out. |
  | PURCHASE_PLACE_INVALID | The place specified by `purchase_place` is not valid for this purchase. |
  | PURCHASER_IS_SELLER | The purchaser is the same as the seller, which is not allowed for resales. |
  | EXPERIENCE_VERIFICATION_ERROR | Could not verify the user is in the given experience for an in-experience purchase. |
  | QUANTITY_LIMIT_EXCEEDED | Quantity limit per-user exceeded. |
  | MISSING_PURCHASE_AUTH_TOKEN | Purchase authentication token is needed but is missing. |
  | INVALID_PURCHASE_AUTH_TOKEN | Provided purchase authentication token is invalid. |
  | ALREADY_OWNED | Purchaser already owns this item. |
  | INSUFFICIENT_MEMBERSHIP | Purchaser does not have the necessary premium membership to purchase this item at this price. |
  | ACCOUNT_RESTRICTED | Purchaser's account is restricted. |

Instance

属性

Instance

Get Instance
Beta

Instance

Update Instance
Beta

Instance

List Instance Children
Beta

Instance

属性

Instance

Get InstanceBeta

Instance

Update InstanceBeta

Instance

List Instance ChildrenBeta

Get Instance
Beta

Update Instance
Beta

List Instance Children
Beta