Publier votre premier contenu généré par les utilisateurs

​

Exigences

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

​

Au moyen des API

​

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é plutôt que des tickets de session pour appeler ces API. Vous pouvez apprendre à obtenir un jeton d’entité de titre dans le démarrage rapide des collections Postman.
• Le système UGC utilise Stockage Blob Azure pour stocker tout le contenu (fichiers et images) associé à l’UGC de votre titre. Pour téléverser le contenu, nous devons d’abord appeler l’API CreateUploadUrls, en transmettant les noms et les tailles des fichiers (en octets) pour créer les nouveaux blobs. Par exemple, si je voulais téléverser 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"
              }
          ]
      }
  }
  

​

Téléverser du contenu dans les blobs

​

Au moyen de Postman

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

​

Au moyen d’AzCopy

• Une autre option consiste à utiliser l’outil AzCopy. Vous pouvez télécharger l’outil et commencer à utiliser 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 les images ont été téléversé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 retourne 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 maintenant dans le catalogue brouillon! Tant que l’article UGC n’est pas publié, il ne peut pas être trouvé par une recherche 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 dans 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 dans 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 téléversent du contenu en même temps, ce processus peut prendre encore plus de temps. Vous pouvez vérifier l’état de la publication en appelant GetItemPublishStatus, en transmettant l’ID d’article (obtenu dans la réponse de CreateDraftItem). Il existe quelques états 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 l’article ne sera pas publié tant que le contenu fautif n’aura pas été modifié
  • Unknown : il s’agit de l’état par défaut, qui est retourné avant l’appel à PublishDraftItem sur l’article UGC
  • Canceled : une erreur interne s’est produite; veuillez essayer de publier l’article de nouveau (si vous voyez cet état à plusieurs reprises, veuillez communiquer avec l’équipe d’ingénierie de PlayFab)
• Une fois l’article UGC publié avec succès, vous pouvez le rechercher au moyen de SearchItems ou l’obtenir directement au moyen de GetItem si vous avez 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 dans la réponse de CreateDraftItem)
  • Copiez les données de l’article UGC (tout ce qui se trouve dans le 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 devrez créer un autre blob en appelant de nouveau CreateUploadUrls
  • Republiez l’article UGC en appelant PublishDraftItem

​

Au moyen de Game Manager

​

Créer l’article de catalogue brouillon

• Accédez à la page UGC en sélectionnant Economy > Catalog (v2).
• Sélectionnez New Item.
• Remplissez 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, téléversez le contenu approprié en sélectionnant le bouton Upload.
• Sélectionnez Save and publish.
• L’article UGC sera maintenant automatiquement créé comme article brouillon et publié dans le catalogue public; vous pourrez maintenant trouver cet article dans le tableau avec les autres articles UGC publiés.

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

​

Dépannage

• 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 devrez ajouter Game Item à la liste, ou changer le type de contenu pour 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