Verwalten von Anzeigenkampagnen

  • Artikel

Verwenden Sie diese Methoden in der Microsoft Store-Werbungs-API , um Werbekampagnen für Ihre App zu erstellen, zu bearbeiten und abzurufen. Jede Kampagne, die Sie mit dieser Methode erstellen, kann nur einer App zugeordnet werden.

Hinweis : Sie können Anzeigenkampagnen auch mithilfe von Partner Center erstellen und verwalten, und Auf Kampagnen, die Sie programmgesteuert erstellen, kann im Partner Center zugegriffen werden. Weitere Informationen zum Verwalten von Anzeigenkampagnen im Partner Center finden Sie unter Erstellen einer Anzeigenkampagne für Ihre App.

Wenn Sie diese Methoden zum Erstellen oder Aktualisieren einer Kampagne verwenden, rufen Sie in der Regel auch eine oder mehrere der folgenden Methoden auf, um die Lieferpositionen, zielgruppenbezogenen Profile und Werbemittel zu verwalten, die der Kampagne zugeordnet sind. Weitere Informationen zur Beziehung zwischen Kampagnen, Lieferpositionen, Zielgruppenprofilen und Werbemittel finden Sie unter Ausführen von Anzeigenkampagnen mit Microsoft Store-Diensten.

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/campaign Erstellt eine neue Anzeigenkampagne.
PUT https://manage.devcenter.microsoft.com/v1.0/my/promotion/campaign/{campaignId} Bearbeitet die von campaignId angegebene Anzeigenkampagne.
GET https://manage.devcenter.microsoft.com/v1.0/my/promotion/campaign/{campaignId} Ruft die von campaignId angegebene Anzeigenkampagne ab.
GET https://manage.devcenter.microsoft.com/v1.0/my/promotion/campaign Abfragen für Anzeigenkampagnen. Im Abschnitt "Parameter" finden Sie die unterstützten Abfrageparameter.
Header Typ Beschreibung
Autorisierung Zeichenfolge Erforderlich. Das Azure AD-Zugriffstoken im Formular Bearer<-Token>.
Nachverfolgungs-ID GUID Optional. Eine ID, die den Anruffluss nachverfolgt.

 

Parameter

Die GET-Methode zum Abfragen von Anzeigenkampagnen unterstützt die folgenden optionalen Abfrageparameter.

Name Typ Beschreibung
skip int Die Anzahl der Zeilen, die in der Abfrage übersprungen werden sollen. Verwenden Sie diesen Parameter, um Datensätze zu durchlaufen. Beispielsweise ruft fetch=10 und skip=0 die ersten 10 Datenzeilen ab, top=10 und skip=10 ruft die nächsten 10 Datenzeilen ab usw.
Abrufen int Die Anzahl der Datenzeilen, die in der Anforderung zurückgegeben werden sollen.
campaignSetSortColumn Zeichenfolge Sortiert die Kampagnenobjekte im Antworttext nach dem angegebenen Feld. Die Syntax ist "CampaignSetSortColumn=field", wobei der Feldparameter eine der folgenden Zeichenfolgen sein kann:

  • id
  • createdDateTime

Der Standardwert ist createdDateTime.
isDescending Boolean Sortiert die Kampagnenobjekte im Antworttext in absteigender oder aufsteigender Reihenfolge.
storeProductId Zeichenfolge Verwenden Sie diesen Wert, um nur die Anzeigenkampagnen zurückzugeben, die der App mit der angegebenen Store-ID zugeordnet sind. Eine Beispiel-Store-ID für ein Produkt ist 9nblggh42cfd.
label Zeichenfolge Verwenden Sie diesen Wert, um nur die Anzeigenkampagnen zurückzugeben, die die angegebene Bezeichnung im Campaign-Objekt enthalten.

Anforderungstext

Die POST- und PUT-Methoden erfordern einen JSON-Anforderungstext mit den erforderlichen Feldern eines Campaign-Objekts und allen zusätzlichen Feldern, die Sie festlegen oder ändern möchten.

Beispiele für Anforderungen

Im folgenden Beispiel wird veranschaulicht, wie die POST-Methode aufgerufen wird, um eine Anzeigenkampagne zu erstellen.

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

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

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

Im folgenden Beispiel wird veranschaulicht, wie die GET-Methode aufgerufen wird, um eine Reihe von Anzeigenkampagnen abzufragen, sortiert nach dem Erstellungsdatum.

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>

Antwort

Diese Methoden geben je nach aufgerufener Methode einen JSON-Antworttext mit einem oder mehreren Kampagnenobjekten zurück. Im folgenden Beispiel wird ein Antworttext für die GET-Methode für eine bestimmte Kampagne veranschaulicht.

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

Campaign-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 der Anzeigenkampagne. Ja Nein
name Zeichenfolge Der Name der Anzeigenkampagne. No Ja
configuredStatus Zeichenfolge Einer der folgenden Werte, der den Status der vom Entwickler angegebenen Anzeigenkampagne angibt:
  • Aktiv
  • Inaktiv
 No Aktiv Ja
effectiveStatus Zeichenfolge Einer der folgenden Werte, der den effektiven Status der Anzeigenkampagne basierend auf der Systemüberprüfung angibt:
  • Aktiv
  • Inaktiv
  • Processing
 Ja No
effectiveStatusReasons array Mindestens einer der folgenden Werte, die den Grund für den effektiven Status der Anzeigenkampagne angeben:
  • AdCreativesInactive
  • BillingFailed
  • AdLinesInactive
  • ValidationFailed
  • Fehler
 Ja No
storeProductId Zeichenfolge Die Store-ID für die App, der diese Anzeigenkampagne zugeordnet ist. Eine Beispiel-Store-ID für ein Produkt ist 9nblggh42cfd. Ja Ja
Bezeichnungen array Eine oder mehrere Zeichenfolgen, die benutzerdefinierte Bezeichnungen für die Kampagne darstellen. Diese Bezeichnungen werden zum Suchen und Kategorisieren von Kampagnen verwendet. No null No
Typ Zeichenfolge Einer der folgenden Werte, der den Kampagnentyp angibt:
  • Bezahlt
  • Haus
  • Community
 Ja Ja
objective Zeichenfolge Einer der folgenden Werte, der das Ziel der Kampagne angibt:
  • DriveInstall
  • DriveReengagement
  • DriveInAppPurchase
 No DriveInstall Ja
lines array Mindestens ein Objekt, das die Lieferpositionen identifiziert, die der Anzeigenkampagne zugeordnet sind. Jedes Objekt in diesem Feld besteht aus einem ID - und Namensfeld , das die ID und den Namen der Lieferposition angibt. No No
CreatedDate Zeichenfolge Das Datum und die Uhrzeit der Erstellung der Anzeigenkampagne im ISO 8601-Format. Ja No