Gestire elementi creativi
Utilizza questi metodi nell'API delle promozioni di Microsoft Store per caricare le tue creatività personalizzate da utilizzare nelle campagne pubblicitarie promozionali o per ottenere una creatività esistente. Una creatività può essere associata a una o più linee di consegna, anche tra campagne pubblicitarie, a condizione che rappresenti sempre la stessa app.
Per ulteriori informazioni sulla relazione tra creatività e campagne pubblicitarie, linee di consegna e profili di targeting, vedere Esegui campagne pubblicitarie utilizzando i servizi di Microsoft Store.
Nota
Quando utilizzi questa API per caricare la tua creatività, la dimensione massima consentita per la tua creatività è 40 KB Se invii un file della creatività più grande di questo, questa API non restituirà un errore, ma la campagna non verrà creata correttamente.
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.
- 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/creative |
Crea un nuovo elemento creativo. |
GET | https://manage.devcenter.microsoft.com/v1.0/my/promotion/creative/{creativeId} |
Ottiene la creatività specificata da creativeId. |
Nota
Questa API attualmente non supporta un metodo PUT.
Intestazione
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. |
Corpo della richiesta
Il metodo POST richiede un corpo della richiesta JSON con i campi obbligatori di un oggetto creativo.
Esempi di richiesta
L'esempio seguente dimostra come chiamare il metodo POST per creare una creatività. In questo esempio, il valore delcontenutoè stato ridotto per essere più conciso.
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'esempio seguente dimostra come chiamare il metodo GET per recuperare una creatività.
GET https://manage.devcenter.microsoft.com/v1.0/my/promotion/creative/106851 HTTP/1.1
Authorization: Bearer <your access token>
Response
Questi metodi restituiscono un corpo della risposta JSON con un oggettoCreativo che contiene informazioni sulla creatività creata o recuperata. Nell'esempio seguente viene illustrato un corpo della risposta per questi metodi. In questo esempio, il valore delcontenutoè stato ridotto per essere più conciso.
{
"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"
}
}
Oggetto creativo
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 creatività. | Sì | No | |
name | string | Il nome della creatività. | No | Sì | |
content | string | Il contenuto dell'immagine della creatività, in formato con codifica Base64. Nota: La dimensione massima consentita per la creatività è 40 KB. Se invii un file della creatività più grande di questo, questa API non restituirà un errore, ma la campagna non verrà creata correttamente. |
No | Sì | |
height | integer | L'altezza della creatività. | No | Sì | |
width | integer | La larghezza della creatività. | No | Sì | |
landingUrl | string | Se utilizzi un servizio di monitoraggio delle campagne come AppsFlyer, Kochava, Tune o Vungle per misurare l'analisi delle installazioni per la tua app, assegna l'URL di monitoraggio in questo campo quando chiami il metodo POST (se specificato, questo valore deve essere un URI valido ). Se non utilizzi un servizio di monitoraggio delle campagne, ometti questo valore quando chiami il metodo POST (in questo caso, questo URL verrà creato automaticamente). | No | Sì | |
format | string | Il formato dell'annuncio. Attualmente, l'unico valore supportato è Banner. | No | Banner | No |
imageAttributes | ImageAttributes | Fornisce gli attributi per la creatività. | No | Sì | |
storeProductId | string | Lo Store ID per l'app a cui è associata questa campagna pubblicitaria. Un esempio di ID negozio per un prodotto è 9nblggh42cfd. | No | No |
Oggetto ImageAttributes
Campo | Tipo | Descrizione | Sola lettura | Valore predefinito | Obbligatorio per POST |
---|---|---|---|---|---|
imageExtension | string | Uno dei seguenti valori: PNG o JPG. | No | Sì |