*Este conteúdo é traduzido por IA (Beta) e pode conter erros. Para ver a página em inglês, clique aqui.

Place

Representa um local do Roblox.

Atributos

pathstring

O caminho de recursos do local.

Formato: universes/{universe_id}/places/{place_id}.

createTimestring
Apenas saída

O horário em que o local foi criado. Esta cadeia de caracteres é formatada como um Timestamp.

updateTimestring
Apenas saída

O horário em que o local foi atualizado. Esta cadeia de caracteres é formatada como um Timestamp.

displayNamestring

O nome do local.

descriptionstring

A descrição do local.

serverSizenumber

O número máximo de usuários permitidos em um único servidor.

URL base
https://apis.roblox.com
O recurso Place
{

  "path": "universes/123/places/123",

  "createTime": "2023-07-05T12:34:56Z",

  "updateTime": "2023-07-05T12:34:56Z",

  "displayName": "ROBLOX Battle [OPEN]",

  "description": "OPEN SOURCE! \n Feel free to check out how we made this game and ask us about it!",

  "serverSize": "integer"

}

Place

Get Place

GET /cloud/v2/universes/{universe_id}/places/{place_id}

Obtém o local especificado.

SolicitaçãoParâmetros de endereço
universe_idstring
Obrigatório

O ID do universo.

place_idstring
Obrigatório

O ID do local.

RespostaPlace
GET /cloud/v2/universes/{universe_id}/places/{place_id}
curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/places/{place_id}' \

  -H 'x-api-key: {your-api-key}'
Resposta
{

  "path": "universes/123/places/123",

  "createTime": "2023-07-05T12:34:56Z",

  "updateTime": "2023-07-05T12:34:56Z",

  "displayName": "ROBLOX Battle [OPEN]",

  "description": "OPEN SOURCE! \n Feel free to check out how we made this game and ask us about it!",

  "serverSize": "integer"

}

Place

Update Place

PATCH /cloud/v2/universes/{universe_id}/places/{place_id}

Atualiza o local especificado.

Escopos
universe.place:write
SolicitaçãoParâmetros de endereço
universe_idstring
Obrigatório

O ID do universo.

place_idstring
Obrigatório

O ID do local.

Parâmetros da consulta
updateMaskstring

A lista de campos para atualização. Esta cadeia de caracteres está formatada como um FieldMask.

Requisitar corpoPlace
RespostaPlace
PATCH /cloud/v2/universes/{universe_id}/places/{place_id}
curl -L -X PATCH 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/places/{place_id}?updateMask={string}' \

  -H 'x-api-key: {your-api-key}' \

  -H 'Content-Type: application/json' \

  --data '{

  "displayName": "ROBLOX Battle [OPEN]",

  "description": "OPEN SOURCE! \n Feel free to check out how we made this game and ask us about it!",

  "serverSize": "integer"

}'
Resposta
{

  "path": "universes/123/places/123",

  "createTime": "2023-07-05T12:34:56Z",

  "updateTime": "2023-07-05T12:34:56Z",

  "displayName": "ROBLOX Battle [OPEN]",

  "description": "OPEN SOURCE! \n Feel free to check out how we made this game and ask us about it!",

  "serverSize": "integer"

}