Abrufen von Abonnements für einen Benutzer

Verwenden Sie diese Methode in der Microsoft Store-Einkaufs-API, um die Abonnement-Add-Ons abzurufen, für die ein bestimmter Benutzer über Berechtigungen verfügt.

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) erstellen zu können. 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

Zur Verwendung dieser Methode benötigen Sie:

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

Weitere Informationen finden Sie unter Verwalten von Produktberechtigungen über einen Dienst.

Anforderung

Anforderungssyntax

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

Anforderungsheader

Header type BESCHREIBUNG
Authorization Zeichenfolge Erforderlich. Das Azure AD-Zugriffstoken im Format Bearertoken<>.
Host Zeichenfolge Muss auf den Wert purchase.mp.microsoft.com festgelegt werden.
Content-Length number Die Länge des Anforderungstexts.
Content-Type Zeichenfolge Gibt den Anforderungs- und Antworttyp an. Derzeit wird als einziger Wert application/json unterstützt.

Anforderungstext

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

Anforderungsbeispiel

Im folgenden Beispiel wird veranschaulicht, wie Sie diese Methode verwenden, um die Abonnement-Add-Ons abzurufen, für die ein bestimmter Benutzer über Berechtigungen verfügt. Ersetzen Sie den Wert b2bKey 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, für die der Benutzer über Berechtigungen verfügt. 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, für das der angegebene Benutzer über eine Berechtigung verfügt. Weitere Informationen zu den Daten in den einzelnen Objekten finden Sie in der folgenden Tabelle.

Jedes Objekt im Items-Array 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.
beneficiary Zeichenfolge Die ID des Empfängers der Berechtigung, die diesem Abonnement zugeordnet ist.
expirationTime Zeichenfolge Das Datum und die Uhrzeit des Abonnementablaufs im ISO 8601-Format. Dieses Feld ist nur verfügbar, wenn sich das Abonnement in einem bestimmten Zustand 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 der 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 werden konnte.
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 ändern .
isTrial Boolean Gibt an, ob es sich bei dem Abonnement um eine Testversion handelt.
lastModified Zeichenfolge Das Datum und die Uhrzeit der letzten Änderung des Abonnements im ISO 8601-Format.
market Zeichenfolge Der Ländercode (im zweistelligen 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 Beispiel-Store-ID für eine SKU ist 0010.
startTime Zeichenfolge Startdatum und -uhrzeit für das Abonnement im ISO 8601-Format.
recurrenceState Zeichenfolge Einer der folgenden Werte:
  • Keine: Dies bedeutet ein unbefristetes Abonnement.
  • Aktiv: Das Abonnement ist aktiv, und der Benutzer ist berechtigt, die Dienste zu nutzen.
  • Inaktiv: Das Abonnement ist über das Ablaufdatum hinaus, und der Benutzer hat die Option für die automatische Verlängerung für das Abonnement deaktiviert.
  • Gekündigt: Das Abonnement wurde vor dem Ablaufdatum absichtlich mit oder ohne Rückerstattung gekündigt.
  • InDunning: Das Abonnement befindet sich in einem Mahning (das Heißt, das Abonnement läuft bald ab, und Microsoft versucht, Guthaben zu erwerben, um das Abonnement automatisch zu verlängern).
  • Fehler: Der Mahnzeitraum ist abgelaufen, und das Abonnement konnte nach mehreren Versuchen nicht verlängert werden.

Hinweis:

  • Inaktiv/Abgebrochen/Fehler sind Terminalzustände. Wenn ein Abonnement in einen dieser Zustände wechselt, 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 gekündigt wird, wird die expirationTime mit dem Datum und der Uhrzeit der Kündigung aktualisiert.
  • Die ID des Abonnements bleibt während der gesamten Lebensdauer gleich. Es ändert sich nicht, wenn die Option für die automatische Verlängerung aktiviert oder deaktiviert ist. Wenn ein Benutzer ein Abonnement nach Erreichen eines Terminalzustands erneut zurückkauft, wird eine neue Abonnement-ID erstellt.
  • Die ID eines Abonnements sollte verwendet werden, um jeden Vorgang für ein einzelnes Abonnement auszuführen.
  • Wenn ein Benutzer ein Abonnement nach dem Kündigen oder Beenden des Abonnements erneut zurückkauft, erhalten Sie beim Abfragen der Ergebnisse für den Benutzer zwei Einträge: eine mit der alten Abonnement-ID in einem Terminalzustand und eine mit der neuen Abonnement-ID in einem aktiven Zustand.
  • Es ist immer eine bewährte Methode, sowohl recurrenceState als auch expirationTime zu überprüfen, da Aktualisierungen von recurrenceState möglicherweise um einige Minuten (oder gelegentlich Stunden) verzögert werden können.
cancellationDate Zeichenfolge Das Datum und die Uhrzeit der Kündigung des Abonnements des Benutzers im ISO 8601-Format.