Player Custom Metadata

You can add your own name-value pairs to any player.

Set/Replace Player Custom Metadata

[PUT]/v2/players/player_id/metadata{  
   "name1":"value1",
   "name2":"value2",
   "name3":"value3",
   . 
 . 
 . 
 "name100":"value100"
}

Modify Custom Metadata

[PATCH]/v2/players/player_id/metadata{  
   "name1":"value1",
   "name2":"value2",
   "name3":"value3",
   . 
 . 
 . 
 "name100":"value100"
}

Get Custom Metadata

[GET]/v2/players/player_id/metadata

Delete All Custom Metadata for Player

[DELETE]/v2/players/player_id/metadata

Delete A Single Custom Metadatum for Player

[PATCH]/v2/players/player_id/metadata
{
   "name":"null"
}

Route Attributes

The following table describes all attributes that can be expressed through the route.

Route Attribute Description
player_id

The ID of the player.

Type: String

Default: None

Example: /players/IzNnllMjphu2XF3_UgPROoCi9B2BwtSg

Examples

This example creates custom metadata for the IzNnllMjphu2XF3_UgPROoCi9B2rtWs player:

[PUT]/v2/players/IzNnllMjphu2XF3_UgPROoCi9B2rtWs/metadata
{
   "skin": "branded"
}

Backlot returns a response similar to the following:

{

}
Note:

Try out the code samples using your account credentials in the Ooyala Scratchpad. For information about using the Scratchpad, see Practice Making Requests with the Scratchpad. To launch the scratchpad, go to Ooyala API Scratchpad.

Was this article helpful?