Game API

Create Asset Candidate

POST

https://api.lootlocker.com/game/v1/player/assets/candidates

ugc

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.lootlocker.com/game/v1/player/assets/candidates' \
--header 'x-session-token: ' \
--header 'x-session-token;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "completed": true,
    "data": {
        "name": "{{$randomProductName}}",
        "kv_storage": [
            {
                "key": "velit",
                "value": "laborum"
            }
        ],
        "filters": [
            {
                "key": "anim sed veniam",
                "value": "tempor aliquip velit"
            }
        ],
        "data_entities": [
            {
                "name": "perspiciatis accusantium reprehenderit",
                "data": "proident sit consequat"
            }
        ]
    }
}'

Response Example

{
  "success": true,
  "asset_candidate": {
    "id": 1,
    "player_id": 1,
    "player_public_uid": "string",
    "asset_id": 1,
    "status": "INCOMPLETE",
    "review_feedback": "string",
    "data": {
      "name": "string",
      "kv_storage": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "filters": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "data_entities": [
        {
          "name": "string",
          "data": "string"
        }
      ],
      "context_id": 1
    },
    "files": [
      {
        "id": 1,
        "url": "http://example.com",
        "size": 1,
        "name": "string",
        "purpose": "PRIMARY_THUMBNAIL"
      }
    ],
    "primary_thumbnail": "http://example.com",
    "created_at": "string",
    "updated_at": "string"
  }
}

Request

Header Params

x-session-token

string

required

Example:

Body Params application/json

data

object

required

name

string

required

A name for the UGC item

context_id

integer

optional

The context_id if multiple are used in your game. Defaults to UGC context if omitted.

kv_storage

array [object {2}]

optional

This maps to the Storage functionality on Assets

filters

array [object {2}]

optional

data_entities

array [object {2}]

optional

This maps to Data Entities on Assets

completed

boolean

optional

Examples

Responses

🟢200OK

application/json

Body

success

boolean

required

asset_candidate

object

required

integer <uint64>

required

>= 1

player_id

integer <uint64>

required

The ID of the player who authered this UGC

>= 1

player_public_uid

string

required

The Public UID of the player who authered this UGC

asset_id

integer <uint64>

required

After promotion this holds a reference to the created Asset

>= 1

status

enum<string>

required

One of 4 statuses: INCOMPLETE, PENDING, APPROVED, DECLINED

Allowed values:

INCOMPLETEPENDINGAPPROVEDDECLINED

review_feedback

string | null

required

Feedback from review to display in game

data

object

required

files

array[object (File) {5}]

required

A list of all files associated with this UGC

primary_thumbnail

string <uri>

required

The URL for the primary thumbnail of the UGC

created_at

string

required

updated_at

string

required

Modified at 2024-11-14 15:30:39

List Asset Candidates

Add File to Asset Candidate