Gérer des contenus créatifs

  • Article

Utilisez ces méthodes dans l’API de promotions du Microsoft Store pour charger vos propres créations personnalisées à utiliser dans des campagnes publicitaires promotionnelles ou obtenir un créatif existant. Un créateur peut être associé à une ou plusieurs lignes de distribution, même dans les campagnes publicitaires, à condition qu’il représente toujours la même application.

Pour plus d’informations sur la relation entre les campagnes publicitaires créatives et les campagnes publicitaires, les lignes de distribution et les profils de ciblage, consultez Exécuter des campagnes publicitaires à l’aide des services du Microsoft Store.

Notes

Lorsque vous utilisez cette API pour charger votre propre création, la taille maximale autorisée pour votre création est de 40 Ko. Si vous envoyez un fichier créatif supérieur à celui-ci, cette API ne retourne pas d’erreur, mais la campagne ne sera pas créée correctement.

Prérequis

Pour utiliser ces méthodes, vous devez d’abord effectuer les opérations suivantes :

  • Si vous ne l’avez pas déjà fait, remplissez tous les prérequis pour l’API de promotions du Microsoft Store.
  • Obtenez un jeton d’accès Azure AD à utiliser dans l’en-tête de demande pour ces méthodes. Une fois que vous avez récupéré le jeton d’accès, vous avez 60 minutes pour l’utiliser avant qu’il n’expire. Une fois le jeton arrivé à expiration, vous pouvez en obtenir un nouveau.

Requête

Ces méthodes ont les URI suivants.

Type de méthode URI de demande Description
POST https://manage.devcenter.microsoft.com/v1.0/my/promotion/creative Crée un nouveau créatif.
GET https://manage.devcenter.microsoft.com/v1.0/my/promotion/creative/{creativeId} Obtient le créatif spécifié par creativeId.

Notes

Cette API ne prend actuellement pas en charge une méthode PUT.

En-tête Type Description
Autorisation string Obligatoire. Jeton d’accès Azure AD sous la formeJeton> du porteur<.
ID de suivi GUID facultatif. ID qui effectue le suivi du flux d’appels.

Corps de la demande

La méthode POST nécessite un corps de requête JSON avec les champs obligatoires d’un objet Creative .

Exemples de demande

L’exemple suivant montre comment appeler la méthode POST pour créer un créatif. Dans cet exemple, la valeur de contenu a été raccourcie par souci de concision.

POST https://manage.devcenter.microsoft.com/v1.0/my/promotion/creative HTTP/1.1
Authorization: Bearer <your access token>

{
  "name": "Contoso App Campaign - Creative 1",
  "content": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEAAQABAAD/2wBDAAgGB...other base64 data shortened for brevity...",
  "height": 80,
  "width": 480,
  "imageAttributes":
  {
    "imageExtension": "PNG"
  }
}

L’exemple suivant montre comment appeler la méthode GET pour récupérer un créatif.

GET https://manage.devcenter.microsoft.com/v1.0/my/promotion/creative/106851  HTTP/1.1
Authorization: Bearer <your access token>

response

Ces méthodes retournent un corps de réponse JSON avec un objet Creative qui contient des informations sur la création créée ou récupérée. L’exemple suivant illustre un corps de réponse pour ces méthodes. Dans cet exemple, la valeur de contenu a été raccourcie par souci de concision.

{
    "Data": {
        "id": 106126,
        "name": "Contoso App Campaign - Creative 2",
        "content": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEAAQABAAD/2wBDAAgGB...other base64 data shortened for brevity...",
        "height": 50,
        "width": 300,
        "format": "Banner",
        "imageAttributes":
        {
          "imageExtension": "PNG"
        },
        "storeProductId": "9nblggh42cfd"
    }
}

Objet créatif

Les corps de requête et de réponse pour ces méthodes contiennent les champs suivants. Ce tableau indique les champs en lecture seule (ce qui signifie qu’ils ne peuvent pas être modifiés dans la méthode PUT) et les champs requis dans le corps de la demande pour la méthode POST.

Champ Type Description Lecture seule Default Obligatoire pour POST
id entier ID du créateur. Oui Non
name string Nom du créateur. Non Oui
contenu string Contenu de l’image créative, au format encodé en Base64.

Note La taille maximale autorisée pour votre création est de 40 Ko. Si vous envoyez un fichier créatif supérieur à celui-ci, cette API ne retourne pas d’erreur, mais la campagne ne sera pas créée correctement.		 Non Oui
height entier La hauteur du créatif. Non Oui
width entier Largeur du créatif. Non Oui
landingUrl string Si vous utilisez un service de suivi des campagnes tel que AppsFlyer, Kochava, Tune ou Vungle pour mesurer l’analytique d’installation de votre application, affectez votre URL de suivi dans ce champ lorsque vous appelez la méthode POST (si elle est spécifiée, cette valeur doit être un URI valide). Si vous n’utilisez pas de service de suivi de campagne, omettez cette valeur lorsque vous appelez la méthode POST (dans ce cas, cette URL est créée automatiquement). Non Oui
format string Format de la publicité. Actuellement, la seule valeur prise en charge est Banner. Non Bannière Non
imageAttributes ImageAttributes Fournit des attributs pour le créatif. Non Oui
storeProductId string ID du Store pour l’application à laquelle cette campagne publicitaire est associée. Un exemple d’ID de magasin pour un produit est 9nblggh42cfd. Non Non

Objet ImageAttributes

Champ Type Description Lecture seule Valeur par défaut Obligatoire pour POST
imageExtension string Une des valeurs suivantes : PNG ou JPG. Non Oui