Freigeben über

Abrufen von Abonnements für einen Benutzer

  • Artikel

Verwenden Sie diese Methode in der Microsoft Store-Einkaufs-API, um die Abonnement-Add-Ons abzurufen, die ein bestimmter Benutzer zu verwenden hat.

Hinweis

Diese Methode kann nur von Entwicklerkonten verwendet werden, die von Microsoft bereitgestellt wurden, um Abonnement-Add-Ons für Universelle Windows-Plattform-Apps (UWP) zu erstellen. Abonnement-Add-Ons sind derzeit für die meisten Entwicklerkonten nicht verfügbar.

Die Microsoft.StoreServices-Bibliothek stellt die Funktionalität dieser Methode über die StoreServicesClient.RecurrenceQueryAsync-API bereit.

Voraussetzungen

Um diese Methode zu verwenden, benötigen Sie Folgendes:

  • Ein Azure AD-Zugriffstoken mit dem Zielgruppen-URI-Wert https://onestore.microsoft.com.
  • Ein Microsoft Store-ID-Schlüssel, der die Identität des Benutzers darstellt, dessen Abonnements Sie abrufen möchten.

Weitere Informationen finden Sie unter Verwalten von Produktberechtigungen aus einem Dienst.

Anfordern

Anforderungssyntax

Methode Anforderungs-URI
POST https://purchase.mp.microsoft.com/v8.0/b2b/recurrences/query

Anforderungsheader

Header Typ Beschreibung
Autorisierung Zeichenfolge Erforderlich. Das Azure AD-Zugriffstoken im Formular Bearer<-Token>.
Host Zeichenfolge Muss auf den Wert purchase.mp.microsoft.com festgelegt werden.
Inhaltslänge Zahl Die Länge des Anforderungstexts.
Content-Type Zeichenfolge Gibt den Anforderungs- und Antworttyp an. Derzeit ist der einzige unterstützte Wert "application/json".

Anforderungstext

Parameter Typ Beschreibung Erforderlich
b2bKey Zeichenfolge Der Microsoft Store-ID-Schlüssel , der die Identität des Benutzers darstellt, dessen Abonnements Sie abrufen möchten. Ja
continuationToken Zeichenfolge Wenn der Benutzer über Berechtigungen für mehrere Abonnements verfügt, gibt der Antworttext ein Fortsetzungstoken zurück, wenn der Seitengrenzwert erreicht ist. Stellen Sie dieses Fortsetzungstoken hier in nachfolgenden Aufrufen bereit, um verbleibende Produkte abzurufen. No
pageSize Zeichenfolge Die maximale Anzahl von Abonnements, die in einer Antwort zurückgegeben werden sollen. Der Standard ist 25. No

Anforderungsbeispiel

Im folgenden Beispiel wird veranschaulicht, wie Sie diese Methode verwenden, um die Abonnement-Add-Ons abzurufen, die ein bestimmter Benutzer zu verwenden hat. Ersetzen Sie den b2bKey-Wert durch den Microsoft Store-ID-Schlüssel , der die Identität des Benutzers darstellt, dessen Abonnements Sie abrufen möchten.

POST https://purchase.mp.microsoft.com/v8.0/b2b/recurrences/query HTTP/1.1
Authorization: Bearer <your access token>
Content-Type: application/json
Host: purchase.mp.microsoft.com

{
  "b2bKey":  "eyJ0eXAiOiJ..."
}

Antwort

Diese Methode gibt einen JSON-Antworttext zurück, der eine Sammlung von Datenobjekten enthält, die die Abonnement-Add-Ons beschreiben, die der Benutzer verwenden kann. Im folgenden Beispiel wird der Antworttext für einen Benutzer veranschaulicht, der über eine Berechtigung für ein Abonnement verfügt.

{
  "items": [
    {
      "autoRenew":true,
      "beneficiary":"pub:gFVuEBiZHPXonkYvtdOi+tLE2h4g2Ss0ZId0RQOwzDg=",
      "expirationTime":"2017-06-11T03:07:49.2552941+00:00",
      "id":"mdr:0:bc0cb6960acd4515a0e1d638192d77b7:77d5ebee-0310-4d23-b204-83e8613baaac",
      "lastModified":"2017-01-08T21:07:51.1459644+00:00",
      "market":"US",
      "productId":"9NBLGGH52Q8X",
      "skuId":"0024",
      "startTime":"2017-01-10T21:07:49.2552941+00:00",
      "recurrenceState":"Active"
    }
  ]
}

Antworttext

Der Antworttext enthält die folgenden Daten.

Wert Typ BESCHREIBUNG
items array Ein Array von Objekten, die Daten zu jedem Abonnement-Add-On enthalten, das der angegebene Benutzer für die Verwendung berechtigt ist. Weitere Informationen zu den Daten in den einzelnen Objekten finden Sie in der folgenden Tabelle.

Jedes Objekt im Elementarray enthält die folgenden Werte.

Wert Typ Beschreibung
autoRenew Boolean Gibt an, ob das Abonnement für die automatische Verlängerung am Ende des aktuellen Abonnementzeitraums konfiguriert ist.
Begünstigter Zeichenfolge Die ID des Begünstigten der Berechtigung, die diesem Abonnement zugeordnet ist.
expirationTime Zeichenfolge Das Datum und die Uhrzeit, zu dem das Abonnement abläuft, im ISO 8601-Format. Dieses Feld ist nur verfügbar, wenn sich das Abonnement in bestimmten Zuständen befindet. Die Ablaufzeit gibt in der Regel an, wann der aktuelle Zustand abläuft. Beispielsweise gibt das Ablaufdatum für ein aktives Abonnement an, wann die nächste automatische Verlängerung erfolgt.
expirationTimeWithGrace Zeichenfolge Das Datum und die Uhrzeit, zu dem das Abonnement abläuft, einschließlich des Karenzzeitraums im ISO 8601-Format. Dieser Wert gibt an, wann der Benutzer den Zugriff auf das Abonnement verliert, nachdem das Abonnement nicht automatisch verlängert wurde.
id Zeichenfolge Die ID des Abonnements. Verwenden Sie diesen Wert, um anzugeben, welches Abonnement Sie ändern möchten, wenn Sie den Abrechnungsstatus eines Abonnements für eine Benutzermethode aufrufen.
isTrial Boolean Gibt an, ob das Abonnement eine Testversion ist.
lastModified Zeichenfolge Datum und Uhrzeit der letzten Änderung des Abonnements im ISO 8601-Format.
Markt Zeichenfolge Der Ländercode (im Zwei-Buchstaben-ISO 3166-1-Alpha-2-Format), in dem der Benutzer das Abonnement erworben hat.
productId Zeichenfolge Die Store-ID für das Produkt , das das Abonnement-Add-On im Microsoft Store-Katalog darstellt. Eine Beispiel-Store-ID für ein Produkt ist 9NBLGGH42CFD.
skuId Zeichenfolge Die Store-ID für die SKU , die das Abonnement-Add-On im Microsoft Store-Katalog darstellt. Eine Beispielspeicher-ID für eine SKU ist 0010.
startTime Zeichenfolge Das Startdatum und die Startzeit für das Abonnement im ISO 8601-Format.
recurrenceState Zeichenfolge Einer der folgenden Werte:
  • Keine: Dies gibt ein unbefristetes Abonnement an.
  • Aktiv: Das Abonnement ist aktiv, und der Benutzer ist berechtigt, die Dienste zu nutzen.
  • Inaktiv: Das Abonnement liegt hinter dem Ablaufdatum, und der Benutzer hat die Option für die automatische Verlängerung für das Abonnement deaktiviert.
  • Storniert: Das Abonnement wurde absichtlich vor dem Ablaufdatum mit oder ohne Rückerstattung gekündigt.
  • InDunning: Das Abonnement befindet sich im Dunning (d. a. das Abonnement läuft bald ab, und Microsoft versucht, Guthaben zu erwerben, um das Abonnement automatisch zu verlängern).
  • Fehler: Der Dunningzeitraum ist abgelaufen, und das Abonnement konnte nach mehreren Versuchen nicht verlängert werden.

Hinweis:

  • Inaktiv/abgebrochene/Fehler sind Terminalzustände. Wenn ein Abonnement einen dieser Zustände eingibt, muss der Benutzer das Abonnement erneut erwerben, um es erneut zu aktivieren. Der Nutzer ist nicht berechtigt, die Dienste in diesen Zuständen zu nutzen.
  • Wenn ein Abonnement storniert wird, wird die Ablaufzeit mit dem Datum und der Uhrzeit der Kündigung aktualisiert.
  • Die ID des Abonnements bleibt während der gesamten Lebensdauer gleich. Sie wird nicht geändert, wenn die Option für die automatische Verlängerung aktiviert oder deaktiviert ist. Wenn ein Benutzer ein Abonnement nach Erreichen eines Terminalzustands erneut kauft, wird eine neue Abonnement-ID erstellt.
  • Die ID eines Abonnements sollte zum Ausführen eines Vorgangs für ein einzelnes Abonnement verwendet werden.
  • Wenn ein Benutzer ein Abonnement nach dem Kündigen oder Beenden erneut kauft, erhalten Sie zwei Einträge: eine mit der alten Abonnement-ID in einem Terminalstatus und eine mit der neuen Abonnement-ID in einem aktiven Zustand.
  • Es empfiehlt sich immer, sowohl recurrenceState als auch expirationTime zu überprüfen, da Updates für recurrenceState möglicherweise um ein paar Minuten (oder gelegentlich Stunden) verzögert werden können.
cancellationDate Zeichenfolge Datum und Uhrzeit der Kündigung des Abonnements des Benutzers im ISO 8601-Format.