Partager via

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 les campagnes publicitaires promotionnelles ou obtenir une créativité existante. Une création peut être associée à une ou plusieurs lignes de livraison, même dans les campagnes publicitaires, à condition qu’elle représente toujours la même application.

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

Remarque

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 avec succès.

Prérequis

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

  • Si ce n’est pas déjà fait, remplissez toutes les conditions préalables relatives à l’API d’analyse du Windows Store.
  • Obtenir un jeton d’accès Azure AD à utiliser dans l’en-tête de requête 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 expiré, vous pouvez en obtenir un nouveau.

Demande

Ces méthodes ont les URI suivants.

Type de méthode URI de requête Description
POST https://manage.devcenter.microsoft.com/v1.0/my/promotion/creative Crée une nouvelle création créative.
GET https://manage.devcenter.microsoft.com/v1.0/my/promotion/creative/{creativeId} Obtient la création spécifiée par creativeId.

Remarque

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 au format porteur<jeton>.
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 requis d’un objet Creative .

Exemples de requête

L’exemple suivant montre comment appeler la méthode POST pour créer une création créative. Dans cet exemple, la valeur de contenu a été raccourcie pour la 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 une création.

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 pour la 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 quels champs sont en lecture seule (ce qui signifie qu’ils ne peuvent pas être modifiés dans la méthode PUT) et quels champs sont requis dans le corps de la demande pour la méthode POST.

Champ Type Description Lecture seule Default Obligatoire pour POST
id entier ID de la création. Oui Non
nom chaîne Nom de la création. Non Oui
content string Contenu de l’image créative, au format codé en Base64.

Notez que 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 avec succès.		 Non Oui
height entier La hauteur de la créativité. Non Oui
width entier Largeur de la créativité. Non Oui
landingUrl string Si vous utilisez un service de suivi de campagne 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 spécifié, 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 sera créée automatiquement). Non Oui
format string Format de publicité. Actuellement, la seule valeur prise en charge est Banner. Non Bannière Non
imageAttributes ImageAttributes Fournit des attributs pour la création. Non Oui
storeProductId string ID Store de l’application à laquelle cette campagne publicitaire est associée. Un exemple d’ID Store pour un produit est 9nblggh42cfd. Non Non

ImageAttributes (objet)

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