Verwalten von Lieferpositionen

  • Artikel

Verwenden Sie diese Methoden in der Microsoft Store-Werbe-API, um eine oder mehrere Lieferpositionen zu erstellen, um Inventar zu kaufen und Ihre Anzeigen für eine Werbeanzeigenkampagne zu liefern. Für jede Lieferposition können Sie die Zielgruppenadressierung festlegen, Ihren Gebotspreis festlegen und entscheiden, wie viel Sie ausgeben möchten, indem Sie ein Budget festlegen und eine Verknüpfung mit Kreativen herstellen, die Sie verwenden möchten.

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

Hinweis Bevor Sie mit dieser API erfolgreich Lieferpositionen für Anzeigenkampagnen erstellen können, müssen Sie zunächst eine kostenpflichtige Anzeigenkampagne über die Seite Anzeigenkampagnen im Partner Center erstellen und mindestens ein Zahlungsinstrument auf dieser Seite hinzufügen. Danach können Sie mithilfe dieser API erfolgreich abrechenbare Lieferpositionen für Anzeigenkampagnen erstellen. Anzeigenkampagnen, die Sie mit der API erstellen, stellen automatisch das Standardzahlungsinstrument in Rechnung, das auf der Seite Anzeigenkampagnen in Partner Center ausgewählt wurde.

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, die Sie mit dieser API erstellen, werden automatisch das Standardzahlungsinstrument abgerechnet, das auf der Seite Anzeigenkampagnen in Partner Center ausgewählt wurde.

  • 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/line Erstellt eine neue Lieferlinie.
PUT https://manage.devcenter.microsoft.com/v1.0/my/promotion/line/{lineId} Bearbeitet die durch lineId angegebene Übermittlungszeile.
GET https://manage.devcenter.microsoft.com/v1.0/my/promotion/line/{lineId} Ruft die durch lineId angegebene Übermittlungszeile ab.
Header type BESCHREIBUNG
Authorization Zeichenfolge Erforderlich. Das Azure AD-Zugriffstoken im Format Bearertoken<>.
Nachverfolgungs-ID GUID Optional. Eine ID, die den Anruffluss nachverfolgt.

Anforderungstext

Die POST- und PUT-Methoden erfordern einen JSON-Anforderungstext mit den erforderlichen Feldern eines Delivery-Zeilenobjekts 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 Übermittlungsleitung zu erstellen.

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

{
    "name": "Contoso App Campaign - Paid Line",
    "configuredStatus": "Active",
    "startDateTime": "2017-01-19T12:09:34Z",
    "endDateTime": "2017-01-31T23:59:59Z",
    "bidAmount": 0.4,
    "dailyBudget": 20,
    "targetProfileId": {
        "id": 310021746
    },
    "creatives": [
        {
            "id": 106851
        }
    ],
    "campaignId": 31043481,
    "minMinutesPerImp ": 1
}

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

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

Antwort

Diese Methoden geben einen JSON-Antworttext mit einem Delivery-Zeilenobjekt zurück, das Informationen zu der Zustellzeile enthält, die erstellt, aktualisiert oder abgerufen wurde. Im folgenden Beispiel wird ein Antworttext für diese Methoden veranschaulicht.

{
    "Data": {
        "id": 31043476,
        "name": "Contoso App Campaign - Paid Line",
        "configuredStatus": "Active",
        "effectiveStatus": "Active",
        "effectiveStatusReasons": [
            "{\"ValidationStatusReasons\":null}"
        ],
        "startDateTime": "2017-01-19T12:09:34Z",
        "endDateTime": "2017-01-31T23:59:59Z",
        "createdDateTime": "2017-01-17T10:28:34Z",
        "bidType": "CPM",
        "bidAmount": 0.4,
        "dailyBudget": 20,
        "targetProfileId": {
            "id": 310021746
        },
        "creatives": [
            {
                "id": 106126
            }
        ],
        "campaignId": 31043481,
        "minMinutesPerImp ": 1,
        "pacingType ": "SpendEvenly",
        "currencyId ": 732
    }
}

Übermittlungszeilenobjekt

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- oder PUT-Methoden erforderlich sind.

Feld Typ BESCHREIBUNG Schreibgeschützt Standard Erforderlich für POST/PUT
id integer Die ID der Lieferposition. Ja Nein
name Zeichenfolge Der Name der Lieferposition. Nein POST
konfiguriertStatus Zeichenfolge Einer der folgenden Werte, der die status der vom Entwickler angegebenen Lieferposition angibt:
  • Aktiv
  • Inaktiv
 Nein POST
effectiveStatus Zeichenfolge Einer der folgenden Werte, der die effektive status der Übermittlungsposition basierend auf der Systemvalidierung angibt:
  • Aktiv
  • Inaktiv
  • Verarbeitung
  • Fehler
 Ja Nein
effectiveStatusReasons array Mindestens einer der folgenden Werte, die den Grund für die effektive status der Lieferlinie angeben:
  • AdCreativesInactive
  • ValidationFailed
 Ja Nein
startDatetime Zeichenfolge Startdatum und -uhrzeit für die Lieferlinie im ISO 8601-Format. Dieser Wert kann nicht geändert werden, wenn er bereits in der Vergangenheit liegt. Nein POST, PUT
endDatetime Zeichenfolge Enddatum und -uhrzeit für die Lieferlinie im ISO 8601-Format. Dieser Wert kann nicht geändert werden, wenn er sich bereits in der Vergangenheit befindet. Nein POST, PUT
createdDatetime Zeichenfolge Das Datum und die Uhrzeit der Erstellung der Lieferlinie im ISO 8601-Format. Ja Nein
bidType Zeichenfolge Ein Wert, der den Gebotstyp der Übermittlungslinie angibt. Derzeit wird nur CPM unterstützt. Nein CPM Nein
bidAmount Decimal Der Gebotsbetrag, der für das Bieten einer Anzeigenanforderung verwendet werden soll. Nein Der durchschnittliche CPM-Wert basierend auf Den Zielmärkten (dieser Wert wird in regelmäßigen Abständen überarbeitet). Nein
dailyBudget Decimal Das Tagesbudget für die Lieferlinie. Entweder dailyBudget oder lifetimeBudget muss festgelegt werden. Nein POST, PUT (wenn lifetimeBudget nicht festgelegt ist)
lifetimeBudget Decimal Das Lebensdauerbudget für die Lieferlinie. Entweder lifetimeBudget* oder dailyBudget muss festgelegt werden. Nein POST, PUT (wenn dailyBudget nicht festgelegt ist)
targetingProfileId Objekt (object) Für ein Objekt, das das Zielprofil identifiziert, das die Benutzer, Regionen und Bestandstypen beschreibt, die Sie für diese Übermittlungszeile als Ziel verwenden möchten. Dieses Objekt besteht aus einem einzelnen ID-Feld , das die ID des Zielprofils angibt. Nein Nein
Kreativen array Mindestens ein Objekt, das die Kreativen darstellt, die der Übermittlungszeile zugeordnet sind. Jedes Objekt in diesem Feld besteht aus einem einzelnen ID-Feld , das die ID eines Creative angibt. Nein Nein
campaignId integer Die ID der übergeordneten Anzeigenkampagne. Nein Nein
minMinutesPerImp integer Gibt das minimale Zeitintervall (in Minuten) zwischen zwei Impressionen an, die demselben Benutzer aus dieser Übermittlungszeile angezeigt werden. Nein 4000 Nein
pacingType Zeichenfolge Einer der folgenden Werte, die den Pacingtyp angeben:
  • SpendEvenly
  • SpendAsFastAsPossible
 Nein SpendEvenly Nein
currencyId integer Die ID der Währung der Kampagne. Ja Die Währung des Entwicklerkontos (Sie müssen dieses Feld nicht in POST- oder PUT-Aufrufen angeben) Nein