Publier votre premier contenu généré par l'utilisateur

Ce tutoriel vous guide dans la publication de contenu UGC avec du contenu, à la fois au moyen des API et de l’interface de Game Manager, en entrant plus dans le détail que le démarrage rapide.

​

Configuration requise

• Un compte de développeur PlayFab
• Un titre pour lequel l’UGC est activé

​

Via les API

Dans cette section, nous allons utiliser les collections Postman pour interagir avec les API UGC de PlayFab, mais vous pouvez utiliser n’importe lequel de nos SDK.

​

Créer des URL de blob

• Le système UGC fonctionne avec le modèle d’entité PlayFab ; nous devons donc utiliser des jetons d’entité au lieu de tickets de session pour appeler ces API. Vous pouvez découvrir comment obtenir un jeton d’entité de titre dans le démarrage rapide des collections Postman.
• Le système UGC utilise Azure Blob Storage pour stocker tout le contenu (fichiers et images) associé à l’UGC de votre titre. Pour charger le contenu, nous devons d’abord appeler l’API CreateUploadUrls, en transmettant les noms et tailles de fichiers (en octets) pour créer les nouveaux blobs. Par exemple, si je voulais charger un fichier texte et une image PNG, je transmettrais ce qui suit dans le corps de la requête :
  {
    "Files": [
      {
        "FileName": "HelloWorld.txt",
        "FileSize": 12
      },
      {
        "FileName": "PlayFabLogo.png",
        "FileSize": 20725
      }
    ]
  }
  
• La réponse inclut un Id et une Url pour chaque élément de contenu :
  {
      "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"
              }
          ]
      }
  }
  

​

Charger le contenu dans les blobs

Il existe plusieurs façons de charger votre contenu vers ces URL.

​

Via Postman

• Créez une requête PUT avec l’URL générée par l’appel à CreateUploadUrls en ajoutant comp: blob et x-ms-blob-type: blockblob comme en-têtes :
• Vous pouvez ensuite charger le fichier en sélectionnant binary comme type de corps :

​

Via AzCopy

• Une autre option consiste à utiliser l’outil AzCopy. Vous pouvez télécharger l’outil et bien démarrer avec AzCopy ici.
• Dans le terminal de votre choix, appelez azcopy avec les paramètres suivants :
  [relative path to azcopy.exe] copy [relative path to local content] [Url + '?' + Token]
  

​

Créer l’UGC brouillon

• Maintenant que les fichiers et images ont été chargés avec succès, vous pouvez appeler CreateDraftItem, en transmettant les URL du contenu et des images, pour créer votre premier article dans le catalogue brouillon :
  {
    "Item": {
      "Type": "ugc",
      "Title": {
        "NEUTRAL": "Hello World!"
      },
      "Description": {
        "NEUTRAL": "My first UGC item (with content!)"
      },
      "ContentType": "Game Item",
      "IsHidden": false,
      "Contents": [
        {
          "Id": "[Content ID]",
          "Url": "[Content Url]"
        }
      ],
      "Images": [
        {
          "Id": "[Image ID]",
          "Type": "Thumbnail",
          "Url": "[Image Url]"
        }
      ]
    },
    "Publish": false,
    "AllowOverwrite": false
  }
  

• La réponse renvoie les métadonnées que vous avez transmises, ainsi qu’un ID d’article :
  {
  "code": 200,
  "status": "OK",
  "data": {
      "Item": {
          ...
          "Id": "e5427509-1b72-4ee1-9e6c-03fc055a94f3",
          ...
      }
    }
  }
  
• L’article UGC brouillon existe désormais dans le catalogue brouillon ! Tant que l’article UGC n’est pas publié, il n’est pas possible de le rechercher dans le catalogue public. Vous pouvez trouver cet article UGC en appelant l’une des API suivantes :
  • GetDraftItem, en transmettant l’ID d’article obtenu à partir de la réponse de CreateDraftItem
  • GetDraftItems, en transmettant une liste d’ID d’articles connus
  • GetEntityDraftItems, en transmettant un ID d’entité et/ou le ContinuationToken de chaque réponse précédente pour parcourir la liste des articles brouillons page par page

• Lorsque vous êtes prêt à publier l’article UGC, appelez PublishDraftItem en transmettant l’ID d’article (obtenu à partir de la réponse de CreateDraftItem).
• Si votre article UGC contient plusieurs fichiers particulièrement volumineux, la publication de l’article peut prendre un certain temps, et lorsque de nombreux autres joueurs chargent du contenu simultanément, ce processus peut prendre encore plus de temps. Vous pouvez vérifier l’état de la publication en appelant GetItemPublishStatus et en transmettant l’ID d’article (obtenu à partir de la réponse de CreateDraftItem). Plusieurs états sont possibles :
  • Succeeded : l’article UGC a été publié avec succès
  • Pending : l’article UGC est toujours en cours de publication
  • Failed : la publication de l’article UGC a échoué et celui-ci ne sera pas publié tant que le contenu incriminé n’aura pas été modifié
  • Unknown : il s’agit de l’état par défaut, renvoyé avant l’appel à PublishDraftItem sur l’article UGC
  • Canceled : une erreur interne s’est produite ; veuillez réessayer de publier l’article (si cet état s’affiche plusieurs fois, contactez l’équipe d’ingénierie PlayFab)
• Une fois l’article UGC publié avec succès, vous pouvez le rechercher au moyen de SearchItems ou le récupérer directement au moyen de GetItem si vous disposez de l’ID d’article.
• Vous pouvez apporter des modifications à l’article UGC avant ou après la publication en procédant comme suit :
  • Appelez GetDraftItem en transmettant l’ID d’article (obtenu à partir de la réponse de CreateDraftItem)
  • Copiez les données de l’article UGC (tout le contenu du champ data)
  • Appelez UpdateDraftItem en transmettant les données modifiées de l’article UGC
  • Si vous souhaitez mettre à jour l’un des fichiers ou l’une des images, vous devez créer un autre blob en appelant à nouveau CreateUploadUrls
  • Republiez l’article UGC en appelant PublishDraftItem

​

Via Game Manager

Dans cette section, nous allons créer un article UGC entièrement dans Game Manager, sans aucun code !

​

Créer l’article de catalogue brouillon

• Accédez à la page UGC en sélectionnant Economy > Catalog (v2).
• Sélectionnez New Item.
• Renseignez les métadonnées appropriées pour votre article UGC :

  Nom du champ	Valeur
  Entity type	title_player_account
  Entity ID	[votre ID de joueur]
  Content type	Game Item
  Start date	[n’importe quelle date passée]
  Title	{ "NEUTRAL": "Hello World!" }
  Description	{ "NEUTRAL": "My first UGC item (with content!)" }

  
• Dans les sections Files et Images, chargez le contenu approprié en sélectionnant le bouton Upload.
• Sélectionnez Save and publish.
• L’article UGC est désormais automatiquement créé en tant qu’article brouillon et publié dans le catalogue public ; vous pouvez maintenant trouver cet article dans le tableau avec les autres articles UGC publiés.

• Si vous souhaitez apporter des modifications à l’article UGC publié, procédez comme suit :
  • Sélectionnez l’article UGC publié dans le tableau
  • Effectuez les modifications appropriées
  • Sélectionnez Save and publish

​

Résolution des problèmes

• Invalid Request - The content type ‘Game Item’ isn’t supported.
  • Si des types de contenu ont été spécifiés dans la configuration de votre titre (au moyen de GetCatalogConfig/UpdateCatalogConfig ou dans Game Manager sous l’onglet Economy Settings), vous devez ajouter Game Item à la liste ou remplacer le type de contenu par un type déjà pris en charge par votre titre
• Invalid Request - This title isn’t configured to use this service.
  • L’UGC est actuellement désactivé pour votre titre ; vous pouvez l’activer en mettant à jour la configuration de votre titre (au moyen de GetCatalogConfig/UpdateCatalogConfig, dans Game Manager sous l’onglet Economy Settings, ou en accédant à l’onglet Economy > Catalog (Preview) et en sélectionnant Enable)

​

Étapes suivantes

Vous disposez maintenant d’articles UGC publiés dans votre catalogue ! Vous pouvez utiliser SearchItems pour créer des expériences de découverte de contenu pour vos joueurs.