Inicio rápido de contenido generado por el usuario (UGC)

El propósito de esta guía es explicar cómo empezar rápidamente con UGC mediante llamadas directas de servicio a servicio. Le mostramos paso a paso cómo conectarse a los artículos de contenido de UGC en borrador, publicarlos y, después, buscarlos y encontrarlos.

Obtención de un token de entidad

UGC está diseñado para funcionar con entidades de PlayFab, por lo que el primer paso es obtener un token de entidad mediante LoginWithCustomID. En este ejemplo se muestra una llamada de servicio.

{
  "CustomId": "exampleUser",
  "CreateAccount": true,
  "TitleId": "DC7B"
}

Creación de direcciones URL de blob

El sistema de UGC usa Azure Blob Storage para almacenar todo el contenido (archivos e imágenes) asociado al UGC de su título. Para cargar el contenido, primero es necesario llamar a la API CreateUploadUrls, pasando los nombres de archivo y los tamaños (en bytes) para crear los nuevos blobs. Por ejemplo, si quisiera cargar un archivo de texto y una imagen PNG, pasaría lo siguiente en el cuerpo de la solicitud:

{
  "Files": [
    {
      "FileName": "HelloWorld.txt",
      "FileSize": 12
    },
    {
      "FileName": "PlayFabLogo.png",
      "FileSize": 20725
    }
  ]
}

La respuesta incluye un Id y una Url para cada elemento de contenido:

{
    "code": 200,
    "status": "OK",
    "data": {
        "UploadUrls": [
            {
                "Id": "[Content ID]",
                "Url": "[Content Url + '?' + Token]",
                "FileName": "HelloWorld.txt"
            },
            {
                "Id": "[Image ID]",
                "Url": "[Image Url + '?' + Token]",
                "FileName": "PlayFabLogo.png"
            }
        ]
    }
}

Creación de un artículo de UGC en borrador

Los artículos de UGC en “borrador” se crean llamando a la API CreateDraftItem con el parámetro "Type":"ugc". Los creadores pueden revisar los artículos en borrador y acceder a ellos antes de publicarlos. Para crear un artículo en borrador, necesita:

El EntityToken de la llamada anterior en el encabezado X-EntityToken.
El Entity.Id de la llamada anterior en el CreatorEntityKey.Id del artículo.
El TitleId del título en el sourceId del artículo.

Esta llamada tiene un aspecto similar al siguiente.

{
  "Item": {
   "Type": "ugc",
    "Title": {
      "NEUTRAL": "Neutral Title Test",
      "en-GB": "en-gb Title",
      "en-US": "en-us Title"
    },
    "Description": {
      "NEUTRAL": "Neutral Description Test",
      "en-GB": "en-gb Description",
      "en-US": "en-us Description"
    },
    "startDate": "2018-10-18T20:01:26.1520582Z"
  }
}

Esto devuelve el artículo en borrador creado con un Id. Guarde el Id para poder usarlo más adelante.

       "Item": {
            "SourceEntity": {
                "Id": "1184A",
                "Type": "title",
                "TypeString": "title"
            },
            "SourceEntityKey": {
                "Id": "1184A",
                "Type": "title",
                "TypeString": "title"
            },
            "Id": "44857e2b-c93b-4054-80be-7890028201ff",
            "Type": "ugc",
            "Title": {
              "NEUTRAL": "Neutral Title Test",
              "en-GB": "en-gb Title",
              "en-US": "en-us Title"
            },
          ...
        }

Obtención de los identificadores de los artículos en borrador de un jugador

Para obtener los identificadores de los artículos en borrador de un jugador concreto, se puede usar la API GetEntityDraftItems. Las entidades de título pueden llamar a esta API con el identificador del jugador en el parámetro Entity, y la API devuelve una lista de los artículos en borrador de ese jugador concreto. Solo las entidades de título pueden pasar un parámetro Entity. Las entidades de jugador pueden llamar a la API sin un parámetro Entity, y la API devuelve una lista de los artículos en borrador creados por el jugador que realiza la llamada.

{
  "Count": 2,
  "Entity": {
    "Id": "C88F55C6A734B1DC",
    "Type": "title_player_account",
    "TypeString": "title_player_account"
  }
}

Publicación de un artículo de UGC

Una vez que un artículo está en borrador, puede pasarlo al estado publicado mediante PublishDraftItem. Una vez publicado un artículo de UGC, se puede buscar y está disponible públicamente. Debe usar el Id del artículo devuelto en la respuesta de CreateDraftItem.

{
"Id": "44857e2b-c93b-4054-80be-7890028201ff"
}

Obtención del estado de publicación de un artículo de UGC

Con el Id del artículo, puede obtener el estado de publicación de un artículo de su catálogo de UGC mediante la API GetItemPublishStatus.

{
"Id": "44857e2b-c93b-4054-80be-7890028201ff"
}

Los valores posibles de Result de la publicación son los siguientes:

Unknown
Pending
Succeeded
Failed
Canceled

Volver a publicar un artículo actualiza el artículo publicado para que coincida con el artículo en borrador actual.

Realización de una búsqueda

Después de que la llamada de publicación se realice correctamente, todos los jugadores pueden acceder al artículo en el catálogo público. La API SearchItems ejecuta una búsqueda en el catálogo publicado (incluidos los artículos de UGC) con los parámetros proporcionados y devuelve un conjunto de resultados paginados. Los campos Filter, OrderBy y Select usan OData como estándar de consulta.

{
  "Search": "Test",
  "Count": 2
}

Consulte también

Publicación de su primer contenido generado por el usuario

​Inicio rápido de contenido generado por el usuario (UGC)

​Obtención de un token de entidad

​Creación de direcciones URL de blob

​Creación de un artículo de UGC en borrador

​Obtención de los identificadores de los artículos en borrador de un jugador

​Publicación de un artículo de UGC

​Obtención del estado de publicación de un artículo de UGC

​Realización de una búsqueda

​Consulte también