Share via

Implement user-generated content in your game

This article describes how to implement user-generated content in your game. For more information, be sure to review the pages in the See also section at the end of the article.

Implement user-generated content features by using Microsoft Azure PlayFab

  1. Authenticate the player: players must be authenticated with both Xbox services and PlayFab before they can use the features that rely on these services in your games.
  2. Use the CreateUploadUrls API to generate URLs for uploading user-generated content (UGC) files. For more information, see Publish your first user-generated content.
  3. Create a draft UGC item: call the CreateDraftItem API with the Type:ugc parameter. Draft items are designed to be reviewed and accessed by their creators or catalog reviewers before being moved to a published state.
  4. Get draft item IDs for a player: use the GetEntityDraftItems API. Title entities can call this API with the player ID in the Entity parameter. The API returns a list of draft items for that player. Only title entities can pass in an Entity parameter. Player entities can call the API without an Entity parameter. The API returns a list of draft items created by the calling player.
  5. Publish a UGC item: after an item is in draft, push it to a published state by using PublishDraftItem. Published UGC items are searchable and available publicly. Use the item Id returned from the CreateDraftItem response.
  6. Get the published status of a UGC item: use the item Id, to get the published status for an item in your UGC catalog by using the GetItemPublishStatus API.
  7. Do a simple search: after the publishing call succeeds, all players can access the itm via the public catalog. The SearchItems API executes a search against the published catalog (including UGC items) by using the provided parameters. The API returns a set of paginated results. The Filter, OrderBy, and Select fields use OData as the query standard.

See also

The PlayFab documentation is the best source of information. Use it as a primary source. For additional information, see the following articles and sample.

UGC is part of Azure PlayFab Economy, making Catalog Search, Catalog Settings, and Catalog Moderation essential for enabling UGC in your game. For additional information, see the following articles.