Gerenciar sua presença na [Loja do Creator](/production/creator-store). [Criar](#Cloud_CreateCreatorStoreProduct) e [atualizar](#Cloud_UpdateCreatorStoreProduct) listagens de produtos para seus ativos, e [pesquisar na caixa de ferramentas](#Toolbox_SearchCreatorStoreAssets) por ativos usando vários filtros.


O tipo de áudio (Música ou Efeito Sonoro).

A duração do arquivo de áudio em segundos.

Parâmetros de filtro de pesquisa específicos de áudio.

Tipos de áudio para incluir (por exemplo, Música, Efeito Sonoro)

A duração máxima para áudio em segundos. Se incluído, deve ser maior ou igual a 1.

A duração mínima para áudio em segundos. Se incluído, deve ser maior ou igual a 0.

Modelo de solicitação para exclusão em massa de saves

Uma lista de saves que estão sendo excluídos

Modelo de resposta para operação de exclusão em massa de saves

Número de saves que foram excluídos com sucesso

Modelo de requisição para criar um salvamento.

Coleções personalizadas não são suportadas atualmente.
Este campo deve ser omitido.

Depreciado: Consulte as propriedades 'userId' e 'groupId' em vez disso.
O tipo e ID do criador. Ex: user/123 ou group/456.

O ID do Grupo. Necessário se o ativo for de propriedade de um grupo.

Este valor existe apenas para criadores baseados em grupo e representa o ID do usuário do criador que atualizou o ativo pela última vez.

Este valor existe apenas para criadores baseados em grupo e representa o nome do criador que atualizou o ativo pela última vez.

O ID do Usuário do criador. Necessário se o ativo for de propriedade de um usuário individual.

Representação de um ativo da loja do criador.

Representa as capacidades que um modelo possui (por exemplo, sandboxing).
Presente apenas para tipos de ativos de modelo; AMRS a inclui na resposta quando disponível.

Controla se o modelo será protegido ao ser inserido quando tiver scripts.

Representa um produto na loja do criador. Este recurso é usado para gerenciar
distribuição e preços de ativos na loja do criador.

O produto da loja do criador é um arquivo de áudio com este ID de ativo.

O produto da loja do criador é uma decalque com este ID de ativo.

O produto da loja do criador é uma família de fontes com este ID de ativo.

O grupo Roblox que está vendendo o produto.

O produto da loja do criador é uma parte de malha com este ID de ativo.

O produto da loja do criador é um modelo com este ID de ativo.

O caminho do recurso do produto da loja do criador.

Formato: `creator-store-products/{creator_store_product_id}`

O produto da loja do criador é um plugin com este ID de ativo.

Preços base suportados em 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

Se o vendedor pretende distribuir o produto da loja do criador no
Criador Store. Um vendedor pode ter a intenção de distribuir um produto, mas devido
a algumas restrições no vendedor ou produto da loja do criador subjacente, o
produto pode não estar disponível para compra. Ver
`restrictions` e `purchasable` para mais detalhes.

Se o produto é comprável.

Para que este valor seja verdadeiro, `published` deve ser verdadeiro e `restrictions` devem
estar vazias. Se este valor for falso, o produto pode não ser adquirido por nenhum
usuário.

Restrições aplicadas ao produto. Um produto pode ter múltiplas
restrições ativas ao mesmo tempo.

Valores possíveis:

  | Valor | Descrição |
  | --- | --- |
  | RESTRICTION_UNSPECIFIED | Restrição não especificada. |
  | SOLD_ITEM_RESTRICTED | O item vendido foi restrito pela Roblox. Detalhes podem estar disponíveis ao pesquisar esse item diretamente. |
  | SELLER_TEMPORARILY_RESTRICTED | O produto está restrito porque a conta do vendedor foi temporariamente restrita pela Roblox. |
  | SELLER_PERMANENTLY_RESTRICTED | O produto está restrito porque a conta do vendedor foi permanentemente restrita pela Roblox. |
  | SELLER_NO_LONGER_ACTIVE | O produto está restrito porque a conta do vendedor foi excluída ou não está mais ativa. |

O usuário Roblox que está vendendo o produto.

O produto da loja do criador é um vídeo com este ID de ativo.

Representa um número decimal em uma forma semelhante à notação científica.

Exemplos:
 - 17            === `{significand: 17   exponent: 0} (ou apenas {significand:
   17})`
 - -0.005        === `{significand: -5   exponent: -3}`
 - 33.5 milhões  === `{significand: 335  exponent: 5}`
 - 11/8 (1.375)  === `{significand: 1375 exponent: -3}`

Observe que o alcance de um Decimal excede o de um `número` JSON (double), assim como
o de um `decimal64`.

Representa a posição do ponto decimal dentro do significante.

Quando o expoente é 0, o valor do Decimal é simplesmente o valor do
`significand`.

Quando o expoente é maior que 0, representa o número de zeros em excesso após os dígitos significativos.

Quando o expoente é menor que 0, representa quantos dos dígitos significativos
(e zeros iniciais implícitos, conforme necessário) vêm após o ponto decimal.

Modelo de requisição para excluir um salvamento.

Modelo de resposta para obter salvamentos.

O número total de salvamentos que correspondem à consulta.

Um registro de salvamento, hidratado com os detalhes do ativo.

Representa a contagem de vários tipos de instâncias dentro de um ativo.
Veja [Instance](https://create.roblox.com/docs/reference/engine/classes/Instance).

Capacidades de script para o ativo (sandboxing)

A quantidade de tipos de instância do estúdio no modelo.
Veja [Instance](https://create.roblox.com/docs/reference/engine/classes/Instance).
Esses são divididos em tipos específicos, como MeshPart, Part, Script,
Tool, Animation, etc.

O resumo das malhas dentro do modelo, se existirem.

A quantidade de scripts que estão no modelo.

Uma lista dos tipos de instâncias de modelo. Veja Toolbox.Service.Models.Internal.InstanceCounts e [Instance](https://create.roblox.com/docs/reference/engine/classes/Instance) para mais detalhes.

Parâmetros de filtro de pesquisa específicos do modelo.

Se incluído, exclui ativos com esses subtipos.

Isso filtra para que os seguintes tipos de [Instance](https://create.roblox.com/docs/reference/engine/classes/Instance) sejam incluídos no modelo.

Se incluído, procure ativos apenas com esses subtipos.

Representa uma quantia de dinheiro com seu tipo de moeda.

Exemplos:
 - Cinco dólares americanos === `{currency_code: "USD" quantity: {significand: 5}}`

Um código de moeda.

Este pode ser um código de moeda de três letras definido no ISO 4217.

APIs podem definir códigos de moeda adicionais que não estão incluídos na norma ISO
4217 (por exemplo, moedas virtuais ou criptomoedas). Estes
devem começar com `X-`, a fim de distingui-los de possíveis códigos futuros
ISO 4217. Por exemplo, `"USD"` é o código ISO 4217 para dólar dos Estados Unidos.

Representa de qual gráfico de música extrair entradas, se houver.

Fornece um resumo das características da malha de um objeto, como contagens de triângulos e vértices.

O número total de triângulos na malha do objeto.

O número total de vértices na malha do objeto.

A quantidade de scripts que estão no plugin.

IDs de ativos de pré-visualização agrupados para um item, separados por tipo de mídia.

Lista ordenada de ids de ativos de pré-visualização de imagem.

Lista ordenada de ids de ativos de pré-visualização de vídeo.

Contém informações sobre correção de consulta para uma busca.

A correção de ortografia sugerida para a consulta de busca original.

Facetas que já estão aplicadas à busca.

As facetas não utilizadas e ainda disponíveis.

A categoria pela qual as salvaguardas devem ser organizadas.

Representa os valores do tipo de áudio que serão exibidos corretamente na UI do Swagger.

Isto representa um "subconjunto" das opções de Toolbox.Service.CategoryType e representa o conjunto completo
de "categorias" (ou tipos de ativos) que podem ser pesquisadas a partir da API de pesquisa da toolbox.

Modelo de solicitação para pesquisar ativos da Creator Store.

Filtros de pesquisa específicos de áudio.

Palavras-chave adicionais para consultas.

O ID do grupo do criador. Apenas um de 'userId' e 'groupId' pode estar presente em uma consulta.

O arquivo de imagem a ser pesquisado. A imagem deve estar codificada em base64 para ser usada na pesquisa. Apenas um de 'query' e 'image' pode estar presente em uma consulta.

Se os resultados devem incluir apenas ativos criados por criadores verificados.

O número de ativos a serem retornados. Não pode ser maior que 100.

O preço máximo do ativo em centavos. Se incluído, deve ser maior ou igual a 0.

O preço mínimo do ativo em centavos. Se incluído, deve ser maior ou igual a 0.

Filtros de pesquisa específicos de modelo.

O número da página a ser recuperada, começando de 0. Apenas um de 'pageNumber' e 'pageToken' pode estar presente em uma consulta.

O identificador para a página de resultados de pesquisa desejada. Apenas um de 'pageNumber' e 'pageToken' pode estar presente em uma consulta.

Os termos de pesquisa usados para filtrar os resultados. Apenas um de 'query' e 'image' pode estar presente em uma consulta.

O tipo de ativo a ser pesquisado. Opcional quando Toolbox.Service.SearchCreatorStoreAssetsRequest.CategoryPath
resolve para um tipo de ativo; caso contrário, é obrigatório.

Indica quais campos serão preenchidos na resposta.

A categoria pela qual os resultados da pesquisa devem ser ordenados.

A direção da ordenação dos resultados da pesquisa.

Identificador de faixa de natação opcional (por exemplo, "tendência", "essencial", "preços").

O ID do usuário do criador. Apenas um de 'userId' e 'groupId' pode estar presente em uma consulta.

A resposta para o endpoint SearchCreatorStoreAssets.

A lista de ativos da Creator Store retornados pela consulta de pesquisa.

A palavra-chave filtrada que foi usada para buscar ativos, se aplicável.

O token da página para visualizar a próxima página de resultados.

Informações sobre correção de consulta, se uma correção estava disponível para a consulta de pesquisa.

As facetas aplicadas e disponíveis de uma consulta.

O número total de resultados para a consulta de pesquisa dada.

Esta visualização controla quais campos são preenchidos na resposta da pesquisa. Uma visualização mais leve
resultará em tempos de resposta mais rápidos e maior confiabilidade.

A categoria para classificar os resultados da pesquisa.

Representa a direção em que classificar os resultados

Representação de um ativo de efeito sonoro.

Caminho da categoria do ativo, se existir.
ex: "3d__characters"

ID do universo caso o ativo tenha sido criado dentro de um universo específico.

Os IDs dos ativos de pré-visualização agrupados por tipo de ativo.

O tempo em que o ativo foi atualizado pela última vez.

As informações do produto da loja do criador do ativo.

Se o ativo pode ou não ser comprado na Loja do Criador.

O preço do ativo, incluindo o código da moeda.

A porcentagem do total de votos que foram votos positivos

Uma chave configurável que permite acesso granular aos recursos do Roblox. Consulte https://create.roblox.com/docs/cloud/auth/api-keys para mais informações.

x-api-key

Um cookie de navegador que representa a identidade de um usuário do Roblox. NÃO COMPARTILHE ISSO. Compartilhar isso permitirá que alguém faça login como você e roube seu Robux e itens. Não recomendamos o uso de cookies para chamar endpoints. Quando possível, use chaves de API com o cabeçalho x-api-key ou OAuth 2.0 em vez disso para autenticação.

.ROBLOSECURITY

Construa ou autorize aplicativos para acessar recursos do Roblox. Consulte https://create.roblox.com/docs/cloud/auth/oauth2-overview para mais informações.

A API do Roblox. Veja https://create.roblox.com/docs/cloud/open-cloud para mais detalhes.

API do Roblox

Adiciona um produto da Loja do Criador. Use este método apenas se seu produto nunca
foi distribuído na Loja do Criador; caso contrário, use o método `PATCH` para
atualizar o produto.

CreatorStoreProduct

creator-store-product:write

creator_store_product_id

creator-store-product:read

updateMask

Se definido como verdadeiro, e o produto da loja do criador não for encontrado, um produto da loja do criador
será criado. Nessa situação, `update_mask` é ignorado.

allowMissing

targetType

targetId

Coleções personalizadas não são suportadas atualmente. Este campo deve ser omitido.

collectionName

creator-store-save:write

O ID do ativo para filtrar. Se fornecido, targetType também deve ser fornecido.

sortBy

sortDirection

limit

O número da página a retornar, começando de 1

page

keyword

hideOwnedAssets

creator-store-save:read

Deletar saves em massa.
Máximo de 5000 saves por requisição.

Obter detalhes de um único ativo da Loja do Criador.

O ID do ativo para recuperar os detalhes.

Obter Detalhes do Ativo da Loja do Criador

O tipo de ativo a ser pesquisado. Opcional quando categoryPath estiver presente na solicitação; caso contrário, é obrigatório.

searchCategoryType

Os termos de pesquisa usados para filtrar os resultados.

query

Ao pesquisar modelos, os subtipos associados aos resultados da pesquisa.

modelSubTypes

Ao pesquisar modelos, os subtipos não associados aos resultados da pesquisa.

excludedModelSubTypes

Depreciado: Consulte as propriedades 'userId' e 'groupId'. O tipo e ID do criador. Ex: "user/123" ou "group/456"

creator

userId

groupId

pageToken

pageNumber

maxPageSize

A direção de ordenação dos resultados da pesquisa.

sortCategory

Ao pesquisar áudio, a duração mínima dos ativos de áudio. Se incluído, deve ser maior ou igual a 0.

audioMinDurationSeconds

Ao pesquisar áudio, a duração máxima dos ativos de áudio. Se incluído, deve ser maior ou igual a 0.

audioMaxDurationSeconds

Ao pesquisar áudio, o nome do artista dos ativos de áudio.

audioArtist

Ao pesquisar áudio, o nome do álbum dos ativos de áudio.

audioAlbum

Ao pesquisar por áudio, o tipo dos ativos de áudio.

audioTypes

Ao pesquisar por modelos, isso filtra que os seguintes tipos de [Instance](https://create.roblox.com/docs/reference/engine/classes/Instance) estão incluídos no modelo.

includedInstanceTypes

includeOnlyVerifiedCreators

minPriceCents

maxPriceCents

Palavras-chave adicionais para consultar.

facets

As tags usadas para filtrar os resultados.

categoryPath

searchView

musicChartType

Indica de qual faixa de natação filtrar.

swimlane

Creator Store

Experiências

Avatar

Ativos

Amostras e projetos

API de motor

API de nuvem aberta

Studio

Dados analíticos

Plataforma

Tutoriais

Programas de Criador

Educação

Cursos

Aprender

Este método é assíncrono e retorna uma "Operação", que representa o estado atual da operação. Ele contém um caminho de endpoint que você pode solicitar para obter a resposta real e os metadados aplicáveis. Veja o [documentation]({longRunningOperationsLink}) em operações de longo prazo para obter mais informações.
            
As seções a seguir descrevem os objetos de resposta e metadados que são fornecidos quando uma operação se completa.

Pontos de extremidade beta estão prontos para uso público. Alterações  danosas são possíveis mas raras.

Estas páginas de documentação do Open Cloud serão removidas em 31 de março de 2026. A partir dessa data, vamos redirecionar você automaticamente para a nova documentação do Open Cloud. {linkStart}Saiba mais{linkEnd}.

Estas páginas antigas da Open Cloud serão removidas e redirecionadas em 31 de março de 2026. {linkStart}Saiba mais{linkEnd}.

Os endpoints experimentais estão prontos para uso público, mas podem sofrer alterações ocasionais à medida que o contrato da API é finalizado.

Este endpoint pode ser chamado na experiência por meio do {httpServiceLinkStart}HttpService{httpServiceLinkEnd} com uma chave API.

Este campo pode ser definido ao criar um recurso, mas não pode ser modificado por solicitações subsequentes.

Esses campos podem ser definidos ao criar um recurso, mas não podem ser modificados por solicitações subsequentes.

Este campo pode ser fornecido em solicitações, mas nunca será incluído em respostas.

Método de autenticação legado. Sempre prefira usar a chave API ou OAuth 2.0 quando disponível.

Por chave de API: {maxInPeriod} solicitações a cada {periodInSeconds} segundos por endereço IP

Não requer autenticação para ser chamado. Costuma ter limites de taxa significativamente reduzidos. Sempre prefira usar a chave API ou OAuth 2.0 quando disponível.

Para cada agrupamento, apenas um dos seguintes campos no esquema deve ser fornecido; o restante pode ser excluído.

Você pode voltar a qualquer momento. {linkStart}Deixe um comentário.{linkEnd}

Você está visualizando os documentos antigos. {linkStart}Deixe um comentário.{linkEnd}

Você pode desativar a qualquer momento e seguir de volta para as páginas de referência antigas. {linkStart}Deixe um comentário.{linkEnd}

Você está visualizando os documentos renovados. {linkStart}Deixe um comentário.{linkEnd}

Este campo pode ser definido como respostas, mas será ignorado em solicitações.

Nota: Os limites de taxa podem ser menores durante períodos de alto tráfego. Alguns pontos de extremidade têm limites de taxa adicionais. [Saiba mais sobre os limites da taxa]({link}).

{limit} solicitações por segundo em todas as chaves API para um usuário ou grupo

{limit} solicitações por hora em todas as chaves API para um usuário ou grupo

{limit} solicitações por segundo em todas as chaves de API para um usuário ou grupo

{limit} solicitações por minuto por proprietário de chave API

{limit} solicitações por dia por usuário do aplicativo

{limit} solicitações por hora por usuário do aplicativo

{limit} solicitações por minuto por usuário do aplicativo

{limit} solicitações por segundo por usuário do aplicativo

{limit} solicitações por segundo por proprietário de chave API

Escopos controlam quais permissões suas credenciais tem. Suas credenciais só podem acessar os endpoints suportados pelos escopos selecionados.

Os endpoints estáveis estão prontos para uso em produção e quase nunca sofrerão alterações significativas durante sua vida útil.

Este alvo permite limitar o acesso da chave às {requiredParts} selecionadas

Este alvo permite limitar o acesso da chave aos {requiredParts} selecionados e {optionalParts}

Os tipos de destino são usados para restringir os recursos para os quais suas credenciais têm permissões. Apenas os recursos selecionados podem ser acionados, mesmo que sua conta tenha permissões para recursos adicionais. Alguns escopos não têm partes de destino. Nesses casos, todos os seus recursos relevantes podem ser acionados.

A parte de nível superior do universo não precisa ser selecionada para chaves API que pertencem ao usuário. Nesse caso, sua chave API terá acesso a todas as suas experiências que pertencem ao usuário ou ao grupo para as quais você tem as permissões de grupo corretas.

A função Try It Out ainda não é suportada com endpoints que exigem chave API ou autenticação OAuth 2.0

Por segurança, a autenticação de cookies está desabilitada para operações de alto risco.

Os endpoints de risco crítico são extremamente sensíveis, por isso, a função Try It Out está desativada por motivos de segurança

Observação: este exemplo de código não inclui cabeçalhos de autenticação. Pode ser necessário adicionar um cabeçalho de autenticação para que este comando funcione.

Este é um endpoint de alto risco que pode modificar ou excluir dados críticos. Tenha muito cuidado ao testar.

Este endpoint de API foi classificado como ALTO RISCO e pode afetar dados em operação ou contas de usuário.

Solicitações autenticadas para APIs de alto risco podem resultar em alterações que não podem ser desfeitas. Revise os parâmetros da sua solicitação cuidadosamente antes de prosseguir.

Entre na sua conta para usar a autenticação de cookies

Este é um endpoint de baixo risco que recupera dados. Geralmente, é seguro para testes.

Este é um endpoint de risco médio que modifica dados. Teste com cuidado com contas que não tenham grande importância, pois as alterações podem ser permanentes.

Para manter sua conta segura, nunca cole texto de outras fontes aqui ou envie informações desta página para outras pessoas.

Você está prestes a testar endpoints de API em operação usando suas credenciais de conta reais.

Prossiga apenas se você estiver ciente das consequências das chamadas de API que você está prestes a fazer. Revise a documentação da API cuidadosamente antes de fazer os testes.

As chamadas de API serão feitas usando sua sessão autenticada

Essas chamadas de API são reais e podem afetar sua conta ou dados

Limites de taxa e outras restrições de API se aplicam

Algumas ações podem modificar ou excluir dados

Este endpoint foi substituído por estes endpoints alternativos recomendados:

Os seguintes escopos são necessários para chamar este endpoint. Para mais
informações sobre como gerar chaves adequadas, consulte [Gerenciar chaves API]({apiKeyReferenceDocLink}).

Para mais informações sobre como gerar chaves, consulte [Gerenciar chaves de API]({apiKeyReferenceDocLink}).

Os seguintes endpoints estão disponíveis em caminhos relativos à URL base.

Esta cadeia de caracteres está formatada como um [FieldMask](/cloud/reference/types#fieldmask).

Um valor JSON pode ser `null`, `boolean`, `string`, `number`, `array`, ou `object`.

Os seguintes escopos são necessários para que seu aplicativo OAuth 2.0 use este endpoint. Para obter mais informações sobre como registrar um aplicativo OAuth 2.0, consulte [Registro e revisão de aplicativos]({oauth2ReferenceDocLink}).

Para mais informações sobre como registrar um aplicativo OAuth 2.0, consulte [Registro e revisão de aplicativos]({oauth2ReferenceDocLink}).

Os seguintes objetos descrevem payloads que são aceitos ou retornados. Veja cada endpoint para mais informações sobre quando esses objetos são usados.

Os seguintes escopos são necessários para chamar este endpoint.

Caminhos de recursos

Esta cadeia de caracteres é formatada como um [Timestamp](/cloud/reference/types#timestamp).

Os seguintes escopos são necessários para que sua aplicação OAuth 2.0 use este endpoint. Para obter mais informações sobre como registrar um aplicativo OAuth 2.0, consulte [Registro e revisão do aplicativo]({oauth2ReferenceDocLink}).

Creator Store

Assets

Não recomendado