Freigeben über

Verwalten von Lieferpositionen

  • Artikel

Verwenden Sie diese Methoden in der Microsoft Store-Werbungs-API, um eine oder mehrere Lieferpositionen zu erstellen, um Inventar zu kaufen und Ihre Anzeigen für eine Werbeanzeigekampagne zu liefern. Für jede Lieferposition können Sie die Zielbestimmung festlegen, ihren Angebotspreis 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 Lieferpositionen und Anzeigenkampagnen, Zielgruppenprofilen und Werbemittel finden Sie unter Ausführen von Anzeigenkampagnen mit Microsoft Store-Diensten.

Hinweis Bevor Sie lieferpositionen für Anzeigenkampagnen mithilfe dieser API erfolgreich erstellen können, müssen Sie zuerst eine kostenpflichtige Anzeigenkampagne mithilfe der Seite "Anzeigenkampagnen " im Partner Center erstellen und mindestens ein Zahlungsmittel auf dieser Seite hinzufügen. Anschließend können Sie mithilfe dieser API erfolgreich rechnungsbare Lieferpositionen für Anzeigenkampagnen erstellen. Anzeigenkampagnen, die Sie mit der API erstellen, werden automatisch das auf der Seite "Anzeigenkampagnen" im Partner Center ausgewählte Standardzahlungsinstrument abgerechnet.

Voraussetzungen

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

  • Falls noch nicht geschehen, erfüllen Sie alle Voraussetzungen für die Microsoft Store-Werbungs-API.

    Hinweis

    Stellen Sie als Teil der Voraussetzungen sicher, dass Sie mindestens eine kostenpflichtige Anzeigenkampagne im Partner Center erstellen und mindestens ein Zahlungsmittel für die Anzeigenkampagne in Partner Center hinzufügen. Lieferpositionen, die Sie mit dieser API erstellen, werden automatisch das auf der Seite "Anzeigenkampagnen" im Partner Center ausgewählte Standardzahlungsinstrument abgerechnet.

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

Anforderung

Diese Methoden weisen die folgenden URIs auf.

Methodentyp Anforderungs-URI Beschreibung
POST https://manage.devcenter.microsoft.com/v1.0/my/promotion/line Erstellt eine neue Lieferposition.
PUT https://manage.devcenter.microsoft.com/v1.0/my/promotion/line/{lineId} Bearbeitet die durch lineId angegebene Lieferzeile.
GET https://manage.devcenter.microsoft.com/v1.0/my/promotion/line/{lineId} Ruft die durch lineId angegebene Lieferzeile ab.
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- und PUT-Methoden erfordern einen JSON-Anforderungstext mit den erforderlichen Feldern eines Lieferzeilenobjekts 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 Lieferposition 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 Übermittlungszeilenobjekt 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
    }
}

Lieferzeilenobjekt

Die Anforderungs- und Antworttexte für diese Methoden enthalten die folgenden Felder. Diese Tabelle zeigt, welche Felder schreibgeschützt sind (d. h., 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. No POST
configuredStatus Zeichenfolge Einer der folgenden Werte, der den Status der vom Entwickler angegebenen Lieferposition angibt:
  • Aktiv
  • Inaktiv
 No POST
effectiveStatus Zeichenfolge Einer der folgenden Werte, der den effektiven Status der Lieferposition basierend auf der Systemüberprüfung angibt:
  • Aktiv
  • Inaktiv
  • Processing
  • Fehler
 Ja No
effectiveStatusReasons array Mindestens einer der folgenden Werte, die den Grund für den effektiven Status der Lieferposition angeben:
  • AdCreativesInactive
  • ValidationFailed
 Ja No
startDatetime Zeichenfolge Das Startdatum und die Startzeit für die Lieferposition im ISO 8601-Format. Dieser Wert kann nicht geändert werden, wenn er sich bereits in der Vergangenheit befindet. No POST, PUT
endDatetime Zeichenfolge Enddatum und -uhrzeit für die Lieferposition im ISO 8601-Format. Dieser Wert kann nicht geändert werden, wenn er sich bereits in der Vergangenheit befindet. No POST, PUT
createdDatetime Zeichenfolge Datum und Uhrzeit der Erstellung der Lieferposition im ISO 8601-Format. Ja No
bidType Zeichenfolge Ein Wert, der den Gebotstyp der Lieferposition angibt. Derzeit ist der einzige unterstützte Wert CPM. No CPM No
bidAmount Decimal Der Gebotsbetrag, der für das Gebot einer Anzeigenanfrage verwendet werden soll. No Der durchschnittliche CPM-Wert basierend auf den Zielmärkten (dieser Wert wird in regelmäßigen Abständen überarbeitet). No
dailyBudget Decimal Das Tagesbudget für die Lieferposition. Entweder dailyBudget oder lifetimeBudget muss festgelegt werden. No POST, PUT (wenn lifetimeBudget nicht festgelegt ist)
lifetimeBudget Decimal Das Lebensdauerbudget für die Lieferposition. Entweder lifetimeBudget* oder dailyBudget muss festgelegt werden. No POST, PUT (wenn dailyBudget nicht festgelegt ist)
targetingProfileId Objekt On object that identifies the targeting profile that describes the users, geographies and inventory types that you want to target for this delivery line. Dieses Objekt besteht aus einem einzelnen ID-Feld , das die ID des Zielprofils angibt. No No
Kreative array Mindestens ein Objekt, das die Werbemittel darstellt, die der Lieferposition zugeordnet sind. Jedes Objekt in diesem Feld besteht aus einem einzelnen ID-Feld , das die ID eines Werbemittels angibt. No No
campaignId integer Die ID der übergeordneten Anzeigenkampagne. No No
minMinutesPerImp integer Gibt das minimale Zeitintervall (in Minuten) zwischen zwei Aufrufen an, die demselben Benutzer von dieser Lieferposition angezeigt werden. No 4000 No
pacingType Zeichenfolge Einer der folgenden Werte, die den Pacingtyp angeben:
  • SpendEvenly
  • SpendAsFastAsPossible
 No SpendEvenly No
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) No