Verwalten von Werbemitteln

  • Artikel

Verwenden Sie diese Methoden in der Microsoft Store-Werbungs-API, um Ihre eigenen benutzerdefinierten Werbemittel hochzuladen, um sie in Werbekampagnen zu verwenden oder eine vorhandene Werbemittel zu erhalten. Ein Werbemittel kann einer oder mehreren Lieferpositionen zugeordnet werden, auch über Anzeigenkampagnen hinweg, vorausgesetzt, sie stellt immer dieselbe App dar.

Weitere Informationen zur Beziehung zwischen Werbemittel und Anzeigenkampagnen, Lieferpositionen und Zielgruppenprofilen finden Sie unter Ausführen von Anzeigenkampagnen mit Microsoft Store-Diensten.

Hinweis

Wenn Sie diese API zum Hochladen Ihrer eigenen Werbemittel verwenden, beträgt die maximal zulässige Größe für Ihr Kreatives 40 KB. Wenn Sie eine kreative Datei übermitteln, die größer ist, gibt diese API keinen Fehler zurück, die Kampagne wird jedoch nicht erfolgreich erstellt.

Voraussetzungen

Um diese Methoden zu verwenden, müssen Sie zuerst folgendes tun:

Anforderung

Diese Methoden weisen die folgenden URIs auf.

Methodentyp Anforderungs-URI Beschreibung
POST https://manage.devcenter.microsoft.com/v1.0/my/promotion/creative Erstellt eine neue Kreative.
GET https://manage.devcenter.microsoft.com/v1.0/my/promotion/creative/{creativeId} Ruft die von creativeId angegebene Werbemittel ab.

Hinweis

Diese API unterstützt derzeit keine PUT-Methode.

Header Typ Beschreibung
Autorisierung Zeichenfolge Erforderlich. Das Azure AD-Zugriffstoken im Formular Bearer<-Token>.
Nachverfolgungs-ID GUID Optional. Eine ID, die den Anruffluss nachverfolgt.

Anforderungstext

Die POST-Methode erfordert einen JSON-Anforderungstext mit den erforderlichen Feldern eines Creative-Objekts .

Beispiele für Anforderungen

Im folgenden Beispiel wird veranschaulicht, wie die POST-Methode aufgerufen wird, um ein Kreatives zu erstellen. In diesem Beispiel wurde der Inhaltswert aus Platzgründen gekürzt.

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

Im folgenden Beispiel wird veranschaulicht, wie die GET-Methode aufgerufen wird, um eine Werbemittel abzurufen.

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

Antwort

Diese Methoden geben einen JSON-Antworttext mit einem Creative-Objekt zurück, das Informationen zu dem Kreativen enthält, das erstellt oder abgerufen wurde. Im folgenden Beispiel wird ein Antworttext für diese Methoden veranschaulicht. In diesem Beispiel wurde der Inhaltswert aus Platzgründen gekürzt.

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

Creative-Objekt

Die Anforderungs- und Antworttexte für diese Methoden enthalten die folgenden Felder. Diese Tabelle zeigt, welche Felder schreibgeschützt sind (d. h., sie können nicht in der PUT-Methode geändert werden) und welche Felder im Anforderungstext für die POST-Methode erforderlich sind.

Feld Typ Beschreibung Schreibgeschützt Standard Erforderlich für POST
id integer Die ID des Kreativen. Ja Nein
name Zeichenfolge Der Name des Kreativen. No Ja
content Zeichenfolge Der Inhalt des kreativen Bilds im Base64-codierten Format.

Hinweis : Die maximal zulässige Größe für Ihr Creative beträgt 40 KB. Wenn Sie eine kreative Datei übermitteln, die größer ist, gibt diese API keinen Fehler zurück, die Kampagne wird jedoch nicht erfolgreich erstellt.		 No Ja
height integer Die Höhe des Kreativen. No Ja
width integer Die Breite des Kreativen. No Ja
landingUrl Zeichenfolge Wenn Sie einen Kampagnenverfolgungsdienst wie AppsFlyer, Kochava, Tune oder Vungle zum Messen der Installationsanalysen für Ihre App verwenden, weisen Sie Ihre Tracking-URL in diesem Feld zu, wenn Sie die POST-Methode aufrufen (sofern angegeben, muss dieser Wert ein gültiger URI sein). Wenn Sie keinen Kampagnenverfolgungsdienst verwenden, lassen Sie diesen Wert aus, wenn Sie die POST-Methode aufrufen (in diesem Fall wird diese URL automatisch erstellt). No Ja
format Zeichenfolge Das Anzeigenformat. Derzeit ist der einzige unterstützte Wert Banner. No Banner No
imageAttributes ImageAttributes Stellt Attribute für die Werbemittel bereit. No Ja
storeProductId Zeichenfolge Die Store-ID für die App, der diese Anzeigenkampagne zugeordnet ist. Eine Beispiel-Store-ID für ein Produkt ist 9nblggh42cfd. No No

ImageAttributes-Objekt

Feld Typ Beschreibung Schreibgeschützt Standardwert Erforderlich für POST
imageExtension Zeichenfolge Einer der folgenden Werte: PNG oder JPG. No Ja