Gérer les campagnes publicitaires

Utilisez ces méthodes dans l’API de promotions du Microsoft Store pour créer, modifier et obtenir des campagnes publicitaires promotionnelles pour votre application. Chaque campagne que vous créez à l’aide de cette méthode peut être associée à une seule application.

Notez que vous pouvez également créer et gérer des campagnes publicitaires à l’aide de l’Espace partenaires et des campagnes que vous créez par programmation sont accessibles dans l’Espace partenaires. Pour plus d’informations sur la gestion des campagnes publicitaires dans l’Espace partenaires, consultez Créer une campagne publicitaire pour votre application.

Lorsque vous utilisez ces méthodes pour créer ou mettre à jour une campagne, vous appelez généralement une ou plusieurs des méthodes suivantes pour gérer les lignes de livraison, cibler des profils et des créations associées à la campagne. Pour plus d’informations sur la relation entre les campagnes, les lignes de livraison, les profils de ciblage et les créatifs, consultez Exécuter des campagnes publicitaires à l’aide des services du Microsoft Store.

• Gérer les lignes de distribution pour les campagnes publicitaires
• Gérer les profils de ciblage pour les campagnes publicitaires
• Gérer les créations pour les campagnes publicitaires

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.

  Notez que dans le cadre des conditions préalables, veillez à créer au moins une campagne publicitaire payante dans l’Espace partenaires et à ajouter au moins un instrument de paiement pour la campagne publicitaire dans l’Espace partenaires. Les lignes de remise des campagnes publicitaires que vous créez à l’aide de cette API facturent automatiquement l’instrument de paiement par défaut choisi dans la page Campagnes publicitaires dans l’Espace partenaires.

• 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.

En-tête

Paramètres

La méthode GET permettant d’interroger les campagnes publicitaires prend en charge les paramètres de requête facultatifs suivants.

Corps de la demande

Les méthodes POST et PUT nécessitent un corps de requête JSON avec les champs requis d’un objet Campagne et tous les champs supplémentaires que vous souhaitez définir ou modifier.

Exemples de requête

L’exemple suivant montre comment appeler la méthode POST pour créer une campagne publicitaire.

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

{
    "name": "Contoso App Campaign",
    "storeProductId": "9nblggh42cfd",
    "configuredStatus": "Active",
    "objective": "DriveInstalls",
    "type": "Community"
}

L’exemple suivant montre comment appeler la méthode GET pour récupérer une campagne publicitaire spécifique.

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

L’exemple suivant montre comment appeler la méthode GET pour interroger un ensemble de campagnes publicitaires, triées par date de création.

GET https://manage.devcenter.microsoft.com/v1.0/my/promotion/campaign?storeProductId=9nblggh42cfd&fetch=100&skip=0&campaignSetSortColumn=createdDateTime HTTP/1.1
Authorization: Bearer <your access token>

Response

Ces méthodes retournent un corps de réponse JSON avec un ou plusieurs objets Campaign , selon la méthode que vous avez appelée. L’exemple suivant illustre un corps de réponse pour la méthode GET pour une campagne spécifique.

{
    "Data": {
        "id": 31043481,
        "name": "Contoso App Campaign",
        "createdDate": "2017-01-17T10:12:15Z",
        "storeProductId": "9nblggh42cfd",
        "configuredStatus": "Active",
        "effectiveStatus": "Active",
        "effectiveStatusReasons": [
            "{\"ValidationStatusReasons\":null}"
        ],
        "labels": [],
        "objective": "DriveInstalls",
        "type": "Paid",
        "lines": [
            {
                "id": 31043476,
                "name": "Contoso App Campaign - Paid Line"
            }
        ]
    }
}

Objet Campaign

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.

Rubriques connexes

• Exécuter des campagnes publicitaires à l’aide des services Microsoft Store
• Gérer les lignes de distribution pour les campagnes publicitaires
• Gérer les profils de ciblage pour les campagnes publicitaires
• Gérer les créations pour les campagnes publicitaires
• Obtenir les données relatives aux performances de la campagne publicitaire