Gestire campagne pubblicitarie

Utilizza questi metodi nell' API delle promozioni di Microsoft Store per creare, modificare e ottenere campagne pubblicitarie promozionali per la tua app. Ogni campagna creata utilizzando questo metodo può essere associata a una sola app.

NotaPuoi anche creare e gestire campagne pubblicitarie utilizzando il Centro partner ed è possibile accedere alle campagne create a livello di codice nel Centro partner. Per ulteriori informazioni sulla gestione delle campagne pubblicitarie nel Centro per i partner, vedere Crea una campagna pubblicitaria per la tua app.

Quando utilizzi questi metodi per creare o aggiornare una campagna, in genere richiami anche uno o più dei seguenti metodi per gestire il profilo di targeting, delle linee di consegna, e creativi associati alla campagna. Per ulteriori informazioni sulla relazione tra campagne, linee di consegna, profili di targeting e creatività, vedere Esegui campagne pubblicitarie utilizzando i servizi di Microsoft Store.

Prerequisiti

Per usare questi metodi, è prima di tutto necessario eseguire queste operazioni:

  • Se non è già stato fatto, completare tutti i prerequisiti per l'API Promozioni di Microsoft Store.

    Nota Come parte dei prerequisiti, assicurati di creare almeno una campagna pubblicitaria a pagamento nel Centro partner e di aggiungere almeno uno strumento di pagamento per la campagna pubblicitaria nel Centro per i partner. Le linee di consegna per le campagne pubblicitarie create utilizzando questa API fattureranno automaticamente lo strumento di pagamento predefinito scelto nella pagina di Ad campaignsnel Partner Center.

  • Ottenere un token di accesso di Azure AD da usare nell'intestazione della richiesta per questi metodi. Dopo aver ottenuto un token di accesso, questo sarà disponibile per 60 minuti prima della scadenza. Dopo la scadenza del token, è possibile ottenerne uno nuovo.

Richiesta

Questi metodi hanno gli URI seguenti.

Tipo di metodo URI della richiesta Descrizione
POST https://manage.devcenter.microsoft.com/v1.0/my/promotion/campaign Crea una nuova campagna pubblicitaria.
PUT https://manage.devcenter.microsoft.com/v1.0/my/promotion/campaign/{campaignId} Modifica la campagna pubblicitaria specificata da campaignId.
GET https://manage.devcenter.microsoft.com/v1.0/my/promotion/campaign/{campaignId} Ottiene la campagna pubblicitaria specificata da campaignId.
GET https://manage.devcenter.microsoft.com/v1.0/my/promotion/campaign Query per campagne pubblicitarie. Vedere la sezione dei Parametri per i parametri di query supportati.
Intestazione Type Descrizione
Autorizzazione stringa Obbligatorio. Token di accesso di Azure AD nel formato Token di<connessione>.
ID tracciabilità GUID (Facoltativo). ID che tiene traccia del flusso di chiamata.

 

Parametri

Il metodo GET per eseguire query sulle campagne pubblicitarie supporta i seguenti parametri di query facoltativi.

Nome Tipo Descrizione
skip int Il numero di righe da ignorare nella query. Utilizzare questo parametro per sfogliare i set di dati. Ad esempio, fetch=10 e skip=0 recupera le prime 10 righe di dati, top=10 e skip=10 recupera le successive 10 righe di dati e così via.
fetch int Il numero di righe di dati da restituire nella richiesta.
campaignSetSortColumn string Ordina gli oggetti Campagna nel corpo della risposta in base al campo specificato. La sintassi è CampaignSetSortColumn=field, dove il campo dei parametri può essere una delle seguenti stringhe:

  • id
  • createdDateTime

L'impostazione predefinita è createdDateTime.

isDescending Booleano Ordina gli oggetti Campagna nel corpo della risposta in ordine discendente o crescente.
storeProductId string Utilizza questo valore per restituire solo le campagne pubblicitarie associate all'app con l'oggetto specificato Store ID. Un esempio di ID negozio per un prodotto è 9nblggh42cfd.
label string Utilizza questo valore per restituire solo le campagne pubblicitarie che includono l'etichetta specificatanell'oggetto Campagna .

Corpo della richiesta

I metodi POST e PUT richiedono un corpo della richiesta JSON con i campi obbligatori di un oggetto Campagna ed eventuali campi aggiuntivi che desideri impostare o modificare.

Esempi di richiesta

L'esempio seguente mostra come chiamare il metodo POST per creare una campagna pubblicitaria.

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'esempio seguente mostra come chiamare il metodo GET per recuperare una campagna pubblicitaria specifica.

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

L'esempio seguente mostra come chiamare il metodo GET per eseguire una query su un insieme di campagne pubblicitarie, ordinate in base alla data di creazione.

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

Questi metodi restituiscono un corpo della risposta JSON con uno o più oggettiCampagna a seconda del metodo chiamato. L'esempio seguente dimostra un corpo della risposta per il metodo GET per una campagna specifica.

{
    "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"
            }
        ]
    }
}

Oggetto della campagna

I corpi di richiesta e risposta per questi metodi contengono i campi seguenti. Questa tabella mostra quali campi sono di sola lettura (ovvero non possono essere modificati nel metodo PUT) e quali campi sono necessari nel corpo della richiesta per il metodo POST.

Campo Tipo Descrizione Sola lettura Predefinita Obbligatorio per POST
ID. integer L'ID della campagna pubblicitaria. No
name string Il nome della campagna pubblicitaria. No
configuredStatus string Uno dei seguenti valori che specifica lo stato della campagna pubblicitaria specificata dallo sviluppatore:
  • Attive
  • Non attiva
No Attivo
effectiveStatus string ìUno dei seguenti valori che specifica lo stato effettivo della campagna pubblicitaria in base alla convalida del sistema:
  • Attive
  • Non attiva
  • in lavorazione
No
effectiveStatusReasons array Uno o più dei seguenti valori che specificano il motivo dello stato effettivo della campagna pubblicitaria:
  • AdCreativesInactive
  • BillingFailed
  • AdLinesInactive
  • ValidationFailed
  • Non riuscito
No
storeProductId string Lo Store ID per l'app a cui è associata questa campagna pubblicitaria. Un esempio di ID negozio per un prodotto è 9nblggh42cfd.
Etichette array Una o più stringhe che rappresentano le etichette personalizzate per la campagna. Queste etichette possono essere utilizzate per cercare e codificare le campagne. No Null No
type string Uno dei seguenti valori che specifica il tipo di campagna:
  • Pagato
  • House
  • Community
obiettivo string Uno dei seguenti valori che specifica l'obiettivo della campagna:
  • DriveInstall
  • DriveReengagement
  • DriveInAppPurchase
No DriveInstall
lines array Uno o più oggetti che identificano le linee di consegna associate alla campagna pubblicitaria.. Ogni oggetto di questo campo consiste in un id e nome del campo che specifica l'ID e il nome della riga di consegna. No No
createdDate string La data e l'ora di creazione della campagna pubblicitaria, nel formato ISO 8601. No