Gérer les lignes de livraison

Utilisez ces méthodes dans l’API de promotions du Microsoft Store pour créer une ou plusieurs lignes de livraison pour acheter l’inventaire et distribuer vos publicités pour une campagne publicitaire promotionnelle. Pour chaque ligne de livraison, vous pouvez définir le ciblage, définir le prix de votre offre et déterminer le montant que vous souhaitez dépenser en définissant un budget et en liant les créations que vous souhaitez utiliser.

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

Notez avant de pouvoir créer des lignes de remise pour les campagnes publicitaires à l’aide de cette API, vous devez d’abord créer une campagne publicitaire payante à l’aide de la page Campagnes publicitaires dans l’Espace partenaires, et vous devez ajouter au moins un instrument de paiement sur cette page. Une fois cette opération effectuée, vous serez en mesure de créer des lignes de remise facturables pour les campagnes publicitaires à l’aide de cette API. Les campagnes publicitaires que vous créez à l’aide de l’API facturent automatiquement l’instrument de paiement par défaut choisi dans la page Campagnes publicitaires dans l’Espace partenaires.

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.

  Remarque

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

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 de ligne de remise 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 ligne de remise.

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

{
    "name": "Contoso App Campaign - Paid Line",
    "configuredStatus": "Active",
    "startDateTime": "2017-01-19T12:09:34Z",
    "endDateTime": "2017-01-31T23:59:59Z",
    "bidAmount": 0.4,
    "dailyBudget": 20,
    "targetProfileId": {
        "id": 310021746
    },
    "creatives": [
        {
            "id": 106851
        }
    ],
    "campaignId": 31043481,
    "minMinutesPerImp ": 1
}

L’exemple suivant montre comment appeler la méthode GET pour récupérer une ligne de remise.

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

Response

Ces méthodes retournent un corps de réponse JSON avec un objet de ligne de remise qui contient des informations sur la ligne de remise créée, mise à jour ou récupérée. L’exemple suivant illustre un corps de réponse pour ces méthodes.

{
    "Data": {
        "id": 31043476,
        "name": "Contoso App Campaign - Paid Line",
        "configuredStatus": "Active",
        "effectiveStatus": "Active",
        "effectiveStatusReasons": [
            "{\"ValidationStatusReasons\":null}"
        ],
        "startDateTime": "2017-01-19T12:09:34Z",
        "endDateTime": "2017-01-31T23:59:59Z",
        "createdDateTime": "2017-01-17T10:28:34Z",
        "bidType": "CPM",
        "bidAmount": 0.4,
        "dailyBudget": 20,
        "targetProfileId": {
            "id": 310021746
        },
        "creatives": [
            {
                "id": 106126
            }
        ],
        "campaignId": 31043481,
        "minMinutesPerImp ": 1,
        "pacingType ": "SpendEvenly",
        "currencyId ": 732
    }
}

Objet de ligne de remise

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 quels champs sont requis dans le corps de la requête pour les méthodes POST ou PUT.

Rubriques connexes

• Exécuter des campagnes publicitaires à l’aide des services Microsoft Store
• Gérer 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