path

query

List Data Stores

Takes a new snapshot of the data stores in an experience.

 After a snapshot, the next write to every key in the experience will
 create a versioned backup of the previous data, regardless of the time of
 the last write.

 In effect, all data current at the time of the snapshot is guaranteed to be
 available as a versioned backup for at least 30 days.

 Snapshots can be taken once per UTC day, per experience. If the latest
 snapshot was taken within the same UTC day, this operation is a no-op and
 the time of the latest snapshot will be returned.

 For more information on using snapshots, see the [Data Stores]
 (https://create.roblox.com/docs/cloud-services/data-stores#snapshots)
 Engine guide.

Snapshot Data Stores

DataStore

AcceptGroupJoinRequestRequest

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
 Fields available for update: colors, body_assets, other_assets, scale

AvatarBody

The resource path of the AvatarBody.
 Format: avatar-bodies/{avatar_body}

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}

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

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

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}

purchasingUser

fulfillmentGroups

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

purchasePlace

context

createTime

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. |

errorReason

Receipt listing post-execution information.

AvatarMarketplaceOrder_Receipt

Total number of items successfully purchased so far.

purchasedItemsCount

Total robux spent on items successfully purchased.

totalSpentRobux

BodyAssets

Dynamic head consisting of multiple assets

Colors of all body parts in format of Color Hex Code, E.g. "#FFFFFF" (white)
 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

BodyColors

headColor

torsoColor

rightArmColor

leftArmColor

rightLegColor

leftLegColor

Represent scale factors of different aspects of an avatar 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

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

Represents a product in the Creator Store.

CreatorStoreProduct

The resource path of the Creator Store product.

 Format: creator-store-products/{creator_store_product}

The base price of the product. For more information, see
 [Money](/cloud/reference/types#money). Each product type (such as
 `pluginAssetId`) supports a set of specific prices. Currently, only USD is
 supported.

 The actual purchase price is based on this base price, but often differs
 slightly due to locale-specific considerations.

 Set this to zero to make the product free.

basePrice

The effective purchase price for the user, after factoring in
 locale-specific considerations.

purchasePrice

Whether the product is considered published, from the seller's perspective.

published

Restrictions applied to the product. A product can have multiple
 restrictions active at one time.

Possible values:

  | Value | Description |
  | --- | --- |
  | RESTRICTION_UNSPECIFIED | Unspecified restriction. |
  | SOLD_ITEM_RESTRICTED | The item being sold has been restricted by Roblox Details may be available by looking up that item directly. |
  | SELLER_TEMPORARILY_RESTRICTED | The product is restricted because the seller's account is temporarily restricted by Roblox. |
  | SELLER_PERMANENTLY_RESTRICTED | The product is restricted because the seller's account is permanently restricted by Roblox. |
  | SELLER_NO_LONGER_ACTIVE | The product is restricted because the seller's account was deleted or is otherwise no longer active. |

restrictions

Whether the product is purchasable.

 For this value to be true, `published` must be true and `restrictions` must
 be empty.

purchasable

userSeller

groupSeller

The Creator Store product is a model with this asset ID.

modelAssetId

The Creator Store product is a plugin with this asset ID.

 Supported base prices in USD: 0, 4.99, 5.99, 6.99, 7.99, 8.99, 9.99,
 10.99, 11.99, 12.99, 13.99, 14.99, 15.99, 16.99, 17.99, 18.99, 19.99,
 24.99, 29.99, 34.99, 39.99, 44.99, 49.99, 59.99, 69.99, 79.99, 89.99,
 99.99, 149.99, 199.99, 249.99

pluginAssetId

The Creator Store product is an audio file with this asset ID.

audioAssetId

The Creator Store product is a decal with this asset ID.

decalAssetId

The Creator Store product is a mesh part with this asset ID.

meshPartAssetId

The Creator Store product is a video with this asset ID.

videoAssetId

The Creator Store product is a font family with this asset ID.

fontFamilyAssetId

The resource path of the data store.
 Format: universes/{universe}/data-stores/{data_store}

The timestamp when the data store was created.

The ID of the data store. Matches the last segment of the path.

DataStoreEntry

The resource path of the data store entry.
 Format:
 universes/{universe}/data-stores/{data_store}/entries/{data_store_entry}
 Format:
 universes/{universe}/data-stores/{data_store}/scopes/{data_store_scope}/entries/{data_store_entry}

The timestamp when the data store entry was created.

The revision ID of the data store entry.

 A new revision is committed whenever the entry is changed in any way.

 The format is an arbitrary string.
 Example: "foo"

revisionId

The timestamp when the revision was created.

revisionCreateTime

The state of the data store entry.

Possible values:

  | Value | Description |
  | --- | --- |
  | STATE_UNSPECIFIED | The default value. This value is used if the state is omitted. |
  | ACTIVE | The default state of a newly created data store entry. |
  | DELETED | The data store entry is marked as deleted. At some point in the future, it will be permanently deleted. |

state

This checksum is computed by the server based on the value of other
 fields, and may be sent on update and delete requests (and potentially
 on certain custom methods) to ensure the client has an up-to-date
 value before proceeding.

etag

value

The resource ID of the entry.

 This matches the last segment of the resource path, and is provided
 only for convenience.

users

An arbitrary set of attributes associated with the entry.

attributes

Represents a subdivision of entries within a data store.

 Scopes are optional, and their usage is discouraged. When scope is
 omitted in the URI path, the default scope "global" is used.

 When the scope is "global", the resource path omits scope. That is, the
 `path` of an entry with `"global"` scope is of the form
 `"universes/1234/data-stores/5678/entries/my-entry"`.

 Use of the collection wildcard (`-`) as a scope name is discouraged;
 listing entries in just that scope is not supported. See
 ListDataStoreEntries for more information.

DataStore

Attributes

DataStore

List Data Stores
Beta

DataStore

Snapshot Data Stores
Beta

DataStore

Attributes

DataStore

List Data StoresBeta

DataStore

Snapshot Data StoresBeta

List Data Stores
Beta

Snapshot Data Stores
Beta