Verwalten von Anzeigenkampagnen

  • Artikel

Verwenden Sie diese Methoden in der Microsoft Store-Werbe-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 in Partner Center finden Sie unter Erstellen einer Anzeigenkampagne für Ihre App.

Wenn Sie diese Methoden verwenden, um eine Kampagne zu erstellen oder zu aktualisieren, rufen Sie in der Regel auch eine oder mehrere der folgenden Methoden auf, um die Übermittlungslinien, Zielprofile und Kreativen zu verwalten, die der Kampagne zugeordnet sind. Weitere Informationen zur Beziehung zwischen Kampagnen, Lieferlinien, Zielgruppenprofilen und Kreativen finden Sie unter Ausführen von Anzeigenkampagnen mit Microsoft Store-Diensten.

Voraussetzungen

Um diese Methoden verwenden zu können, müssen Sie zunächst die folgenden Schritte ausführen:

  • Wenn Sie dies noch nicht getan haben, müssen Sie alle Voraussetzungen für die Microsoft Store-Promotions-API erfüllen.

    Hinweis Stellen Sie im Rahmen der Voraussetzungen sicher, dass Sie mindestens eine kostenpflichtige Anzeigenkampagne in Partner Center erstellen und mindestens ein Zahlungsinstrument für die Anzeigenkampagne in Partner Center hinzufügen. Übermittlungspositionen für Anzeigenkampagnen, die Sie mit dieser API erstellen, werden automatisch das auf der Seite Anzeigenkampagnen im Partner Center ausgewählte Standardzahlungsinstrument in Rechnung gestellt.

  • Rufen Sie ein Azure AD-Zugriffstoken ab, das im Anforderungsheader für diese Methoden verwendet werden soll. Nachdem Sie ein Zugriffstoken erhalten haben, haben Sie 60 Minuten Zeit, es zu verwenden, bevor es abläuft. Wenn das Token abgelaufen ist, können Sie ein neues abrufen.

Anforderung

Diese Methoden verfügen über die folgenden URIs.

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 durch campaignId angegebene Anzeigenkampagne.
GET https://manage.devcenter.microsoft.com/v1.0/my/promotion/campaign/{campaignId} Ruft die durch campaignId angegebene Anzeigenkampagne ab.
GET https://manage.devcenter.microsoft.com/v1.0/my/promotion/campaign Abfragen für Anzeigenkampagnen. Die unterstützten Abfrageparameter finden Sie im Abschnitt Parameter .
Header type BESCHREIBUNG
Authorization Zeichenfolge Erforderlich. Das Azure AD-Zugriffstoken im Format Bearertoken<>.
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 große Datensätze durchzublättern. Beispielsweise werden mit fetch=10 und skip=0 die ersten 10 Datenzeilen abgerufen, top=10 und skip=10 die nächsten 10 Datenzeilen usw.
fetch INT Die Anzahl der Datenzeilen, die in der Anforderung zurückgegeben werden sollen.
campaignSetSortColumn Zeichenfolge Sortiert die Campaign-Objekte im Antworttext nach dem angegebenen Feld. Die Syntax lautet CampaignSetSortColumn=field, wobei der Field-Parameter eine der folgenden Zeichenfolgen sein kann:

  • id
  • createdDateTime

Der Standardwert ist createdDateTime.
isDescending Boolean Sortiert die Campaign-Objekte 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.

Anforderungsbeispiele

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 mindestens einem Campaign-Objekt 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"
            }
        ]
    }
}

Kampagnenobjekt

Die Anforderungs- und Antworttexte für diese Methoden enthalten die folgenden Felder. Diese Tabelle zeigt, welche Felder schreibgeschützt sind (was bedeutet, dass sie in der PUT-Methode nicht geändert werden können) 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. Nein Ja
konfiguriertStatus Zeichenfolge Einer der folgenden Werte, der die status der vom Entwickler angegebenen Anzeigenkampagne angibt:
  • Aktiv
  • Inaktiv
 Nein Aktiv Ja
effectiveStatus Zeichenfolge Einer der folgenden Werte, der die effektive status der Anzeigenkampagne basierend auf der Systemvalidierung angibt:
  • Aktiv
  • Inaktiv
  • Verarbeitung
 Ja Nein
effectiveStatusReasons array Mindestens einer der folgenden Werte, die den Grund für die effektive status der Anzeigenkampagne angeben:
  • AdCreativesInactive
  • BillingFailed
  • AdLinesInactive
  • ValidationFailed
  • Fehler
 Ja Nein
storeProductId Zeichenfolge Die Store-ID für die App, mit der diese Anzeigenkampagne verknüpft ist. Eine Beispiel-Store-ID für ein Produkt ist 9nblggh42cfd. Ja Ja
Bezeichnungen array Mindestens eine Zeichenfolge, die benutzerdefinierte Bezeichnungen für die Kampagne darstellt. Diese Bezeichnungen werden zum Suchen und Markieren von Kampagnen verwendet. Nein NULL Nein
type Zeichenfolge Einer der folgenden Werte, der den Kampagnentyp angibt:
  • Kostenpflichtig
  • Haus
  • Community
 Ja Ja
Ziel Zeichenfolge Einer der folgenden Werte, der das Ziel der Kampagne angibt:
  • DriveInstall
  • DriveReengagement
  • DriveInAppPurchase
 Nein 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 Übermittlungszeile angibt. Nein Nein
createdDate Zeichenfolge Das Datum und die Uhrzeit der Erstellung der Anzeigenkampagne im ISO 8601-Format. Ja Nein