Freigeben über

Anzeigenkampagnen verwalten

Verwenden Sie diese Methoden in der Microsoft Store-Werbungs-API, um Werbeanzeigenkampagnen 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 mit Partner Center erstellen und verwalten. Kampagnen, die Sie programmgesteuert erstellen, können im Partner Center aufgerufen 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 Profilezu verwalten, und Werbemittel, die der Kampagne zugeordnet sind. Weitere Informationen zur Beziehung zwischen Kampagnen, Lieferlinien, Zielgruppenprofilen und Werbemitteln finden Sie unter Durchführen von Werbekampagnen unter Verwendung von Microsoft Store-Diensten.

Voraussetzungen

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

  • Falls Sie es noch nicht getan haben, erfüllen Sie alle Voraussetzungen für die Microsoft Store-Werbeaktionen-API.

    Beachten Sie Als Teil der Voraussetzungen müssen Sie sicherstellen, dass Sie mindestens eine kostenpflichtige Anzeigenkampagne im Partner Center erstellen und mindestens ein Zahlungsmittel für die Anzeigenkampagne im Partner Center hinzufügen. Lieferpositionen für Anzeigenkampagnen, die Sie mit dieser API erstellen, werden automatisch über das gewählte Standardzahlungsinstrument abgerechnet, das auf der Seite Anzeigenkampagnen im Partner Center ausgewählt ist.

  • Rufen Sie ein Azure AD-Zugriffstoken ab, um es im Anforderungsheader für diese Methoden zu verwenden. Nachdem Sie ein Zugriffstoken abgerufen haben, müssen Sie es 60 Minuten verwenden, bevor es abläuft. Nachdem das Token abgelaufen ist, können Sie eine neue abrufen.

Anfrage

Diese Methoden weisen die folgenden URIs auf.

Methodentyp Anforderungs-URI BESCHREIBUNG
SENDEN https://manage.devcenter.microsoft.com/v1.0/my/promotion/campaign Erstellt eine neue Anzeigenkampagne.
PLATZIEREN https://manage.devcenter.microsoft.com/v1.0/my/promotion/campaign/{campaignId} Bearbeitet die Anzeigenkampagne, die durch campaignIdangegeben ist.
ERHALTEN/Bekommen https://manage.devcenter.microsoft.com/v1.0/my/promotion/campaign/{campaignId} Ruft die durch campaignIdangegebene Anzeigenkampagne ab.
ERHALTEN/Bekommen https://manage.devcenter.microsoft.com/v1.0/my/promotion/campaign Anfragen für Anzeigenkampagnen. Informationen zu den unterstützten Abfrageparametern finden Sie im Abschnitt Parameter.
Kopfzeile Typ BESCHREIBUNG
Autorisierung Schnur Erforderlich. Das Azure AD-Zugriffstoken in der Form Bearer<token>.
Sendungsverfolgungs-ID Globale eindeutige Kennung (GUID) Wahlfrei. Eine ID, die den Anruffluss nachverfolgt.

 

Die Parameter

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

Name Typ BESCHREIBUNG
hüpfen INT Die Anzahl der Zeilen, die in der Abfrage übersprungen werden sollen. Verwenden Sie diesen Parameter, um durch Datensätze zu blättern. 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.
KampagneSortierspalteSetzen Schnur Sortiert die Kampagne Objekte im Antworttext nach dem angegebenen Feld. Die Syntax ist CampaignSetSortColumn=field, wobei das Feld Parameter eine der folgenden Zeichenfolgen sein kann:

  • id
  • ErstellungsdatumUhrzeit

Der Standardwert ist createdDateTime.
istAbsteigend Boolescher Typ (Boolean) Sortiert die Kampagne Objekte im Antworttext in absteigender oder aufsteigender Reihenfolge.
Produkt-ID im Geschäft Schnur Verwenden Sie diesen Wert, um nur die Anzeigenkampagnen zurückzugeben, die der App mit der angegebenen Store-IDzugeordnet sind. Eine Beispiel-Store-ID für ein Produkt ist 9nblggh42cfd.
Etikett Schnur Verwenden Sie diesen Wert, um nur die Anzeigenkampagnen zurückzugeben, die die angegebene Bezeichnung im Campaign-Objekt enthalten.

Anfragekörper

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 anfordern

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 einen JSON-Antwortkörper mit einem oder mehreren Campaign-Objekten zurück, abhängig von der aufgerufenen Methode. 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"
            }
        ]
    }
}

Kampagnenobjekt

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 Nur Lesen Standard Erforderlich für POST
id Integer Die ID der Werbekampagne. Ja Nein
Name Schnur Der Name der Anzeigenkampagne. Nein Ja
konfigurierter Status Schnur Einer der folgenden Werte, der den Status der vom Entwickler angegebenen Anzeigenkampagne angibt:
  • Aktiv
  • Inaktiv
 Nein Aktiv Ja
effectiveStatus Schnur Einer der folgenden Werte, der den effektiven Status der Anzeigenkampagne basierend auf der Systemüberprüfung angibt:
  • Aktiv
  • Inaktiv
  • Verarbeitung
 Ja Nein
Wirksamkeitsstatusgründe Array Mindestens einer der folgenden Werte, die den Grund für den effektiven Status der Anzeigenkampagne angeben:
  • AdCreativesInactive
  • BillingFailed
  • AdLinesInactive
  • ValidationFailed-
  • Fehler
 Ja Nein
Produkt-ID im Geschäft Schnur Die Store-ID der App, mit der diese Anzeigenkampagne verbunden ist. Eine Beispiel-Store-ID für ein Produkt ist 9nblggh42cfd. Ja Ja
etiketten Array Eine oder mehrere Zeichenfolgen, die benutzerdefinierte Bezeichnungen für die Kampagne repräsentieren. Diese Bezeichnungen werden zum Suchen und Kategorisieren von Kampagnen verwendet. Nein NULL Nein
Typ Schnur Einer der folgenden Werte, der den Kampagnentyp angibt:
  • Kostenpflichtige
  • Haus
  • Gemeinschaft
 Ja Ja
Ziel Schnur Einer der folgenden Werte, der das Ziel der Kampagne angibt:
  • DriveInstall-
  • AntriebWiederengagement
  • Drive-In-App-Kauf
 Nein DriveInstall Ja
Linien Array Ein oder mehrere Objekte, die die Lieferpositionen identifizieren, die der Anzeigenkampagne zugeordnet sind. Jedes Objekt in diesem Feld besteht aus einer ID und Namen Feld, das die ID und den Namen der Lieferposition angibt. Nein Nein
Erstellungsdatum Schnur Das Datum und die Uhrzeit der Erstellung der Anzeigenkampagne im ISO 8601-Format. Ja Nein