Verwalten von App-Übermittlungen
Die Microsoft Store-Übermittlungs-API bietet Methoden zum Verwalten von Übermittlungen für Ihre Apps, einschließlich gradueller Paketrollouts. Eine Einführung in die Microsoft Store-Übermittlungs-API, einschließlich der Voraussetzungen für die Verwendung der API, finden Sie unter Erstellen und Verwalten von Übermittlungen mithilfe von Microsoft Store-Diensten.
Wichtig
Wenn Sie die Microsoft Store-Übermittlungs-API verwenden, um eine Übermittlung für eine App zu erstellen, stellen Sie sicher, dass Sie weitere Änderungen an der Übermittlung nur mithilfe der API und nicht mithilfe des Partner Centers vornehmen. Wenn Sie Partner Center verwenden, um eine Übermittlung zu ändern, die Sie ursprünglich mithilfe der API erstellt haben, können Sie diese Übermittlung nicht mehr mithilfe der API ändern oder übernehmen. In einigen Fällen kann die Übermittlung in einem Fehlerzustand verbleiben, in dem sie nicht im Übermittlungsprozess fortgesetzt werden kann. In diesem Fall müssen Sie die Übermittlung löschen und eine neue Übermittlung erstellen.
Wichtig
Sie können diese API nicht verwenden, um Übermittlungen für Volumenkäufe über die Microsoft Store für Unternehmen und Microsoft Store für Bildungseinrichtungen zu veröffentlichen oder Übermittlungen für BRANCHEN-Apps direkt für Unternehmen zu veröffentlichen. Für beide Szenarien müssen Sie partner Center verwenden, um die Übermittlung zu veröffentlichen.
Methoden zum Verwalten von App-Übermittlungen
Verwenden Sie die folgenden Methoden, um eine App-Übermittlung abzurufen, zu erstellen, zu aktualisieren, zu übernehmen oder zu löschen. Bevor Sie diese Methoden verwenden können, muss die App bereits in Ihrem Partner Center-Konto vorhanden sein, und Sie müssen zuerst eine Übermittlung für die App im Partner Center erstellen. Weitere Informationen finden Sie auf der Website Voraussetzungen.
Method | URI | Beschreibung |
---|---|---|
GET | https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId} | Abrufen einer vorhandenen App-Übermittlung |
GET | https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/status | Abrufen des Status einer vorhandenen App-Übermittlung |
POST | https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions | Erstellen einer neuen App-Übermittlung |
PUT | https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId} | Aktualisieren einer vorhandenen App-Übermittlung |
POST | https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/commit | Commit für eine neue oder aktualisierte App-Übermittlung |
DELETE | https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId} | Löschen einer App-Übermittlung |
Erstellen einer App-Übermittlung
Führen Sie diesen Vorgang aus, um eine Übermittlung für eine App zu erstellen.
Falls noch nicht geschehen, füllen Sie alle Voraussetzungen für die Microsoft Store-Übermittlungs-API aus.
Hinweis
Stellen Sie sicher, dass die App bereits mindestens eine abgeschlossene Übermittlung mit den Altersfreigabeinformationen abgeschlossen hat.
Abrufen eines Azure AD-Zugriffstokens Sie müssen dieses Zugriffstoken an die Methoden in der Microsoft Store-Übermittlungs-API übergeben. 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.
Erstellen Sie eine App-Übermittlung , indem Sie die folgende Methode in der Microsoft Store-Übermittlungs-API ausführen. Diese Methode erstellt eine neue laufende Übermittlung, bei der es sich um eine Kopie Ihrer letzten veröffentlichten Übermittlung handelt.
POST https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions
Der Antworttext enthält eine App-Übermittlungsressource , die die ID der neuen Übermittlung, den SAS-URI (Shared Access Signature) zum Hochladen aller zugehörigen Dateien für die Übermittlung in Azure Blob Storage (z. B. App-Pakete, Eintragsbilder und Trailerdateien) sowie alle Daten für die neue Übermittlung (z. B. Die Auflistungen und Preisinformationen) enthält.
Hinweis
Ein SAS-URI bietet Zugriff auf eine sichere Ressource im Azure-Speicher, ohne dass Kontoschlüssel erforderlich sind. Hintergrundinformationen zu SAS-URIs und deren Verwendung mit Azure Blob Storage finden Sie unter Shared Access Signatures, Teil 1: Grundlegendes zum SAS-Modell und freigegebenen Zugriffssignaturen, Teil 2: Erstellen und Verwenden eines SAS mit Blob-Speicher.
Wenn Sie neue Pakete hinzufügen, Bilder auflisten oder Trailerdateien für die Übermittlung hinzufügen, bereiten Sie die App-Pakete vor, und bereiten Sie die App-Screenshots, Bilder und Trailer vor. Fügen Sie alle diese Dateien zu einem ZIP-Archiv hinzu.
Überarbeiten Sie die App-Übermittlungsdaten mit allen erforderlichen Änderungen für die neue Übermittlung, und führen Sie die folgende Methode aus, um die App-Übermittlung zu aktualisieren.
PUT https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}
Hinweis
Wenn Sie neue Dateien für die Übermittlung hinzufügen, stellen Sie sicher, dass Sie die Übermittlungsdaten aktualisieren, um auf den Namen und den relativen Pfad dieser Dateien im ZIP-Archiv zu verweisen.
Wenn Sie neue Pakete, Auflistungsbilder oder Trailerdateien für die Übermittlung hinzufügen, laden Sie das ZIP-Archiv mithilfe des SAS-URI in Azure Blob Storage hoch, der im Antworttext der POST-Methode bereitgestellt wurde, die Sie zuvor aufgerufen haben. Es gibt verschiedene Azure-Bibliotheken, mit denen Sie dies auf einer Vielzahl von Plattformen tun können, darunter:
Im folgenden C#-Codebeispiel wird das Hochladen eines ZIP-Archivs in Azure Blob Storage mithilfe der CloudBlockBlobe-Klasse, in der Azure Storage-Clientbibliothek für .NET veranschaulicht. In diesem Beispiel wird davon ausgegangen, dass das ZIP-Archiv bereits in ein Streamobjekt geschrieben wurde.
string sasUrl = "https://productingestionbin1.blob.core.windows.net/ingestion/26920f66-b592-4439-9a9d-fb0f014902ec?sv=2014-02-14&sr=b&sig=usAN0kNFNnYE2tGQBI%2BARQWejX1Guiz7hdFtRhyK%2Bog%3D&se=2016-06-17T20:45:51Z&sp=rwl"; Microsoft.WindowsAzure.Storage.Blob.CloudBlockBlob blockBob = new Microsoft.WindowsAzure.Storage.Blob.CloudBlockBlob(new System.Uri(sasUrl)); await blockBob.UploadFromStreamAsync(stream);
Führen Sie die folgende Methode aus, um die App-Übermittlung zu übernehmen. Dadurch wird Partner Center benachrichtigt, dass Sie mit Ihrer Übermittlung fertig sind und dass Ihre Updates jetzt auf Ihr Konto angewendet werden sollen.
POST https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/commit
Überprüfen Sie den Commit-Status, indem Sie die folgende Methode ausführen, um den Status der App-Übermittlung abzurufen.
GET https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/status
Um den Übermittlungsstatus zu bestätigen, überprüfen Sie den Statuswert im Antworttext. Dieser Wert sollte von CommitStarted in PreProcessing geändert werden, wenn die Anforderung erfolgreich ist oder CommitFailed ausgeführt wird, wenn Fehler in der Anforderung vorhanden sind. Wenn Fehler vorhanden sind, enthält das Feld statusDetails weitere Details zum Fehler.
Nachdem der Commit erfolgreich abgeschlossen wurde, wird die Übermittlung zur Aufnahme an den Store gesendet. Sie können den Übermittlungsfortschritt weiterhin mithilfe der vorherigen Methode oder über das Partner Center überwachen.
Methoden zum Verwalten eines graduellen Paketrollouts
Sie können die aktualisierten Pakete in einer App-Übermittlung schrittweise auf einen Prozentsatz der Kunden Ihrer App unter Windows 10 und Windows 11 bereitstellen. Auf diese Weise können Sie Feedback- und Analysedaten für die spezifischen Pakete überwachen, um sicherzustellen, dass Sie über das Update sicher sind, bevor Sie es umfassender einführen. Sie können den Rollout-Prozentsatz (oder das Update anhalten) für eine veröffentlichte Übermittlung ändern, ohne eine neue Übermittlung erstellen zu müssen. Weitere Details, einschließlich Anweisungen zum Aktivieren und Verwalten eines graduellen Paketrollouts im Partner Center, finden Sie in diesem Artikel.
Um ein graduelles Paketrollout für eine App-Übermittlung programmgesteuert zu aktivieren, gehen Sie folgendermaßen vor, indem Sie Methoden in der Microsoft Store-Übermittlungs-API verwenden:
- Erstellen Sie eine App-Übermittlung , oder rufen Sie eine vorhandene App-Übermittlung ab.
- Suchen Sie in den Antwortdaten nach der PackageRollout-Ressource , legen Sie das Feld "isPackageRolloutRollout " auf "true" fest, und legen Sie das Feld "packageRolloutPercentage " auf den Prozentsatz der Kunden Ihrer App fest, die die aktualisierten Pakete erhalten sollen.
- Übergeben Sie die aktualisierten App-Übermittlungsdaten an die Aktualisierung einer App-Übermittlungsmethode .
Nachdem ein graduelles Paketrollout für eine App-Übermittlung aktiviert wurde, können Sie die folgenden Methoden verwenden, um das graduelle Rollout programmgesteuert abzurufen, zu aktualisieren, anzuhalten oder abzuschließen.
Method | URI | Beschreibung |
---|---|---|
GET | https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/packagerollout | Abrufen der schrittweisen Rolloutinformationen für eine App-Übermittlung |
POST | https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/updatepackagerolloutpercentage | Aktualisieren des Prozentsatzes des graduellen Rollouts für eine App-Übermittlung |
POST | https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/haltpackagerollout | Anhalten des graduellen Rollouts für eine App-Übermittlung |
POST | https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/finalizepackagerollout | Abschließen des graduellen Rollouts für eine App-Übermittlung |
Codebeispiele zum Verwalten von App-Übermittlungen
Die folgenden Artikel enthalten detaillierte Codebeispiele, die veranschaulichen, wie Sie eine App-Übermittlung in verschiedenen Programmiersprachen erstellen:
- C#-Beispiel: Übermittlungen für Apps, Add-Ons und Flights
- C#-Beispiel: App-Übermittlung mit Spieloptionen und Trailern
- Java-Beispiel: Übermittlungen für Apps, Add-Ons und Flights
- Java-Beispiel: App-Übermittlung mit Spieloptionen und Trailern
- Python-Beispiel: Übermittlungen für Apps, Add-Ons und Flights
- Python-Beispiel: App-Übermittlung mit Spieloptionen und Trailern
StoreBroker PowerShell-Modul
Als Alternative zum direkten Aufrufen der Microsoft Store-Übermittlungs-API stellen wir auch ein Open-Source-PowerShell-Modul bereit, das eine Befehlszeilenschnittstelle über die API implementiert. Dieses Modul wird als StoreBroker bezeichnet. Sie können dieses Modul verwenden, um Ihre App-, Flight- und Add-On-Übermittlungen über die Befehlszeile zu verwalten, anstatt die Microsoft Store-Übermittlungs-API direkt aufzurufen, oder Sie können einfach die Quelle durchsuchen, um weitere Beispiele für den Aufruf dieser API anzuzeigen. Das StoreBroker-Modul wird in Microsoft aktiv als primäre Art und Weise verwendet, wie viele Erstanbieteranwendungen an den Store übermittelt werden.
Weitere Informationen finden Sie auf unserer StoreBroker-Seite auf GitHub.
Datenressourcen
Die Methoden der Microsoft Store-Übermittlungs-API zum Verwalten von App-Übermittlungen verwenden die folgenden JSON-Datenressourcen.
App-Übermittlungsressource
Diese Ressource beschreibt eine App-Übermittlung.
{
"id": "1152921504621243540",
"applicationCategory": "BooksAndReference_EReader",
"pricing": {
"trialPeriod": "FifteenDays",
"marketSpecificPricings": {},
"sales": [],
"priceId": "Tier2",
"isAdvancedPricingModel": true
},
"visibility": "Public",
"targetPublishMode": "Manual",
"targetPublishDate": "1601-01-01T00:00:00Z",
"listings": {
"en-us": {
"baseListing": {
"copyrightAndTrademarkInfo": "",
"keywords": [
"epub"
],
"licenseTerms": "",
"privacyPolicy": "",
"supportContact": "",
"websiteUrl": "",
"description": "Description",
"features": [
"Free ebook reader"
],
"releaseNotes": "",
"images": [
{
"fileName": "contoso.png",
"fileStatus": "Uploaded",
"id": "1152921504672272757",
"description": "Main page",
"imageType": "Screenshot"
}
],
"recommendedHardware": [],
"title": "Contoso ebook reader"
},
"platformOverrides": {
"Windows81": {
"description": "Ebook reader for Windows 8.1"
}
}
}
},
"hardwarePreferences": [
"Touch"
],
"automaticBackupEnabled": false,
"canInstallOnRemovableMedia": true,
"isGameDvrEnabled": false,
"gamingOptions": [],
"hasExternalInAppProducts": false,
"meetAccessibilityGuidelines": true,
"notesForCertification": "",
"status": "PendingCommit",
"statusDetails": {
"errors": [],
"warnings": [],
"certificationReports": []
},
"fileUploadUrl": "https://productingestionbin1.blob.core.windows.net/ingestion/387a9ea8-a412-43a9-8fb3-a38d03eb483d?sv=2014-02-14&sr=b&sig=sdd12JmoaT6BhvC%2BZUrwRweA%2Fkvj%2BEBCY09C2SZZowg%3D&se=2016-06-17T18:32:26Z&sp=rwl",
"applicationPackages": [
{
"fileName": "contoso_app.appx",
"fileStatus": "Uploaded",
"id": "1152921504620138797",
"version": "1.0.0.0",
"architecture": "ARM",
"languages": [
"en-US"
],
"capabilities": [
"ID_RESOLUTION_HD720P",
"ID_RESOLUTION_WVGA",
"ID_RESOLUTION_WXGA"
],
"minimumDirectXVersion": "None",
"minimumSystemRam": "None",
"targetDeviceFamilies": [
"Windows.Mobile min version 10.0.10240.0"
]
}
],
"packageDeliveryOptions": {
"packageRollout": {
"isPackageRollout": false,
"packageRolloutPercentage": 0.0,
"packageRolloutStatus": "PackageRolloutNotStarted",
"fallbackSubmissionId": "0"
},
"isMandatoryUpdate": false,
"mandatoryUpdateEffectiveDate": "1601-01-01T00:00:00.0000000Z"
},
"enterpriseLicensing": "Online",
"allowMicrosoftDecideAppAvailabilityToFutureDeviceFamilies": true,
"allowTargetFutureDeviceFamilies": {
"Desktop": false,
"Mobile": true,
"Holographic": true,
"Xbox": false,
"Team": true
},
"friendlyName": "Submission 2",
"trailers": []
}
Diese Ressource weist die folgenden Werte auf:
Wert | Typ | Beschreibung |
---|---|---|
id | Zeichenfolge | Die ID der Übermittlung Diese ID steht in den Antwortdaten für Anforderungen zum Erstellen einer App-Übermittlung, zum Abrufen aller Apps und zum Abrufen einer App zur Verfügung. Für eine Übermittlung, die im Partner Center erstellt wurde, ist diese ID auch in der URL für die Übermittlungsseite im Partner Center verfügbar. |
applicationCategory | Zeichenfolge | Eine Zeichenfolge, die die Kategorie und/oder Unterkategorie für Ihre App angibt. Kategorien und Unterkategorien werden in einer einzelnen Zeichenfolge mit dem Unterstrich "_" kombiniert, z . B. BooksAndReference_EReader. |
Preise | Objekt | Eine Preisressource , die Preisinformationen für die App enthält. |
Sichtbarkeit | Zeichenfolge | Die Sichtbarkeit der App. Dies kann einer der folgenden Werte sein:
|
targetPublishMode | Zeichenfolge | Der Veröffentlichungsmodus für die Übermittlung. Dies kann einer der folgenden Werte sein:
|
targetPublishDate | Zeichenfolge | Das Veröffentlichungsdatum für die Übermittlung im ISO 8601-Format, wenn der targetPublishMode auf SpecificDate festgelegt ist. |
listings | Objekt | Ein Wörterbuch mit Schlüssel- und Wertpaaren, wobei jeder Schlüssel ein Ländercode ist und jeder Wert eine Eintragsressource ist, die Eintragsinformationen für die App enthält. |
hardwarePreferences | array | Ein Array von Zeichenfolgen, die die Hardwareeinstellungen für Ihre App definieren. Dies kann einer der folgenden Werte sein:
|
automaticBackupEnabled | boolean | Gibt an, ob Windows die Daten Ihrer App in automatische Sicherungen auf OneDrive aufnehmen kann. Weitere Informationen finden Sie unter App-Deklarationen. |
canInstallOnRemovableMedia | boolean | Gibt an, ob Kunden Ihre App auf Wechselmedien installieren können. Weitere Informationen finden Sie unter App-Deklarationen. |
isGameDvrEnabled | boolean | Gibt an, ob game DVR für die App aktiviert ist. |
gamingOptions | array | Ein Array, das eine Ressource für Spieleoptionen enthält, die spielbezogene Einstellungen für die App definiert. |
hasExternalInAppProducts | boolean | Gibt an, ob Ihre App Benutzern das Kaufgeschäft außerhalb des Microsoft Store-Commerce-Systems ermöglicht. Weitere Informationen finden Sie unter App-Deklarationen. |
meetAccessibilityGuidelines | boolean | Gibt an, ob Ihre App getestet wurde, um die Richtlinien für die Barrierefreiheit zu erfüllen. Weitere Informationen finden Sie unter App-Deklarationen. |
notesForCertification | Zeichenfolge | Enthält Hinweise zur Zertifizierung für Ihre App. |
status | Zeichenfolge | Der Status der Übermittlung. Dies kann einer der folgenden Werte sein:
|
statusDetails | Objekt | Eine Statusdetailsesource, die zusätzliche Details zum Status der Übermittlung enthält, einschließlich Informationen zu Fehlern. |
fileUploadUrl | Zeichenfolge | Der SAS-URI (Shared Access Signature) zum Hochladen von Paketen für die Übermittlung. Wenn Sie neue Pakete, Auflistungsbilder oder Trailerdateien für die Übermittlung hinzufügen, laden Sie das ZIP-Archiv hoch, das die Pakete und Bilder enthält, in diesen URI. Weitere Informationen finden Sie unter Erstellen einer App-Übermittlung. |
applicationPackages | array | Ein Array von Anwendungspaketressourcen , die Details zu den einzelnen Paketen in der Übermittlung bereitstellen. |
packageDeliveryOptions | Objekt | Eine Ressource für Paketübermittlungsoptionen, die schrittweise Paketrollouts und obligatorische Updateeinstellungen für die Übermittlung enthält. |
enterpriseLicensing | Zeichenfolge | Einer der Enterprise-Lizenzierungswerte , die das Verhalten der Unternehmenslizenzierung für die App angeben. |
allowMicrosoftDecideAppAvailabilityToFutureDeviceFamilies | boolean | Gibt an, ob Microsoft die App für zukünftige Windows 10- und Windows 11-Gerätefamilien verfügbar machen darf. |
allowTargetFutureDeviceFamilies | Objekt | Ein Wörterbuch mit Schlüssel- und Wertpaaren, wobei jeder Schlüssel eine Windows 10- und Windows 11-Gerätefamilie ist und jeder Wert ein boolescher Wert ist, der angibt, ob Ihre App auf die angegebene Gerätefamilie ausgerichtet werden darf. |
friendlyName | Zeichenfolge | Der Anzeigename der Übermittlung, wie im Partner Center gezeigt. Dieser Wert wird für Sie generiert, wenn Sie die Übermittlung erstellen. |
Anhänger | array | Ein Array mit bis zu 15 Trailerressourcen , die Videotrailer für den App-Eintrag darstellen. |
Preisressource
Diese Ressource enthält Preisinformationen für die App. Diese Ressource weist die folgenden Werte auf:
Wert | Typ | Beschreibung |
---|---|---|
trialPeriod | Zeichenfolge | Eine Zeichenfolge, die den Testzeitraum für die App angibt. Dies kann einer der folgenden Werte sein:
|
marketSpecificPricings | Objekt | Ein Wörterbuch mit Schlüssel- und Wertpaaren, wobei jeder Schlüssel ein zweiseitiger ISO 3166-1 Alpha-2-Ländercode ist und jeder Wert ein Preisniveau ist. Diese Elemente stellen die benutzerdefinierten Preise für Ihre App in bestimmten Märkten dar. Alle Elemente in diesem Wörterbuch setzen den Grundpreis außer Kraft, der durch den PriceId-Wert für den angegebenen Markt angegeben wird. |
sales | array | Veraltet. Ein Array von Verkaufsressourcen , die Verkaufsinformationen für die App enthalten. |
priceId | Zeichenfolge | Ein Preisniveau , das den Grundpreis für die App angibt. |
isAdvancedPricingModel | boolean | Wenn zutreffend, hat Ihr Entwicklerkonto Zugriff auf die erweiterte Gruppe von Preisniveaus von 0,99 USD auf 1999,99 USD. Wenn falsch, hat Ihr Entwicklerkonto Zugriff auf die originale Gruppe von Preisniveaus von 0,99 USD auf 999,99 USD. Weitere Informationen zu den verschiedenen Ebenen finden Sie unter Preisniveaus. Hinweis Dieses Feld ist schreibgeschützt |
Verkaufsressource
Diese Ressourcen enthalten Verkaufsinformationen für eine App.
Wichtig
Die Verkaufsressource wird nicht mehr unterstützt, und derzeit können Sie die Verkaufsdaten für eine App-Übermittlung nicht mithilfe der Microsoft Store-Übermittlungs-API abrufen oder ändern. In Zukunft aktualisieren wir die Microsoft Store-Übermittlungs-API, um eine neue Möglichkeit für den programmgesteuerten Zugriff auf Verkaufsinformationen für App-Übermittlungen einzuführen.
- Nach dem Aufrufen der GET-Methode zum Abrufen einer App-Übermittlung ist der Verkaufswert leer. Sie können weiterhin Partner Center verwenden, um die Verkaufsdaten für Ihre App-Übermittlung abzurufen.
- Beim Aufrufen der PUT-Methode zum Aktualisieren einer App-Übermittlung werden die Informationen im Verkaufswert ignoriert. Sie können weiterhin Partner Center verwenden, um die Verkaufsdaten für Ihre App-Übermittlung zu ändern.
Diese Ressource weist die folgenden Werte auf:
Wert | Typ | BESCHREIBUNG |
---|---|---|
name | Zeichenfolge | Der Name des Verkaufs. |
basePriceId | Zeichenfolge | Das Preisniveau, das für den Grundpreis des Verkaufs verwendet werden soll. |
startDate | Zeichenfolge | Das Startdatum für den Verkauf im ISO 8601-Format. |
endDate | Zeichenfolge | Das Enddatum für den Verkauf im ISO 8601-Format. |
marketSpecificPricings | Objekt | Ein Wörterbuch mit Schlüssel- und Wertpaaren, wobei jeder Schlüssel ein zweiseitiger ISO 3166-1 Alpha-2-Ländercode ist und jeder Wert ein Preisniveau ist. Diese Elemente stellen die benutzerdefinierten Preise für Ihre App in bestimmten Märkten dar. Alle Elemente in diesem Wörterbuch setzen den Grundpreis außer Kraft, der durch den basePriceId für den angegebenen Markt angegeben wird. |
Auflistungsressource
Diese Ressource enthält Eintragsinformationen für eine App. Diese Ressource weist die folgenden Werte auf:
Wert | Typ | Beschreibung |
---|---|---|
baseListing | Objekt | Die Basisauflistungsinformationen für die App, die die Standardauflistungsinformationen für alle Plattformen definiert. |
platformOverrides | Objekt | Ein Wörterbuch mit Schlüssel- und Wertpaaren, wobei jeder Schlüssel eine Zeichenfolge ist, die eine Plattform identifiziert, für die die Eintragsinformationen überschrieben werden sollen, und jeder Wert ist eine Basisauflistungsressource (die nur die Werte von Beschreibung zu Titel enthält), die die Eintragsinformationen angibt, die für die angegebene Plattform außer Kraft gesetzt werden sollen. Die Schlüssel können die folgenden Werte aufweisen:
|
Basisauflistungsressource
Diese Ressource enthält Basisauflistungsinformationen für eine App. Diese Ressource weist die folgenden Werte auf:
Wert | Typ | Beschreibung |
---|---|---|
copyrightAndTrademarkInfo | Zeichenfolge | Optionale Copyright- und/oder Markeninformationen. |
keywords | array | Ein Array von Schlüsselworten , mit dem Ihre App in Suchergebnissen angezeigt werden kann. |
licenseTerms | Zeichenfolge | Die optionalen Lizenzbedingungen für Ihre App. |
privacyPolicy | Zeichenfolge | Dieser Wert ist veraltet. Um die URL der Datenschutzrichtlinie für Ihre App festzulegen oder zu ändern, müssen Sie dies auf der Seite "Eigenschaften" im Partner Center tun. Sie können diesen Wert aus Ihren Aufrufen der Übermittlungs-API weglassen. Wenn Sie diesen Wert festlegen, wird er ignoriert. |
supportContact | Zeichenfolge | Dieser Wert ist veraltet. Um die Supportkontakt-URL oder E-Mail-Adresse für Ihre App festzulegen oder zu ändern, müssen Sie dies auf der Seite "Eigenschaften" im Partner Center tun. Sie können diesen Wert aus Ihren Aufrufen der Übermittlungs-API weglassen. Wenn Sie diesen Wert festlegen, wird er ignoriert. |
websiteUrl | Zeichenfolge | Dieser Wert ist veraltet. Um die URL der Webseite für Ihre App festzulegen oder zu ändern, müssen Sie dies auf der Seite "Eigenschaften" im Partner Center tun. Sie können diesen Wert aus Ihren Aufrufen der Übermittlungs-API weglassen. Wenn Sie diesen Wert festlegen, wird er ignoriert. |
Beschreibung | string | Die Beschreibung für den App-Eintrag. |
Features | array | Ein Array von bis zu 20 Zeichenfolgen, die die Features für Ihre App auflisten. |
releaseNotes | Zeichenfolge | Die Versionshinweise für Ihre App. |
images | array | Ein Array von Bild- und Symbolressourcen für den App-Eintrag. |
recommendedHardware | array | Ein Array von bis zu 11 Zeichenfolgen, die die empfohlenen Hardwarekonfigurationen für Ihre App auflisten. |
minimumHardware | Zeichenfolge | Ein Array von bis zu 11 Zeichenfolgen, die die mindesten Hardwarekonfigurationen für Ihre App auflisten. |
title | Zeichenfolge | Der Titel für den App-Eintrag. |
shortDescription | Zeichenfolge | Wird nur für Spiele verwendet. Diese Beschreibung wird im Abschnitt "Informationen " des Game Hub auf Xbox One angezeigt und hilft Kunden, mehr über Ihr Spiel zu erfahren. |
shortTitle | Zeichenfolge | Eine kürzere Version des Produktnamens. Wenn angegeben, kann dieser kürzere Name an verschiedenen Stellen auf Xbox One (während der Installation, in Erfolgen usw.) anstelle des vollständigen Titels Ihres Produkts angezeigt werden. |
sortTitle | Zeichenfolge | Wenn Ihr Produkt auf unterschiedliche Weise alphabetisch alphabetisiert werden kann, können Sie hier eine andere Version eingeben. Dies kann Kunden beim Suchen helfen, das Produkt schneller zu finden. |
voiceTitle | Zeichenfolge | Ein alternativer Name für Ihr Produkt, der bei Verwendung von Kinect oder einem Headset in der Audioumgebung auf Xbox One verwendet werden kann. |
devStudio | Zeichenfolge | Geben Sie diesen Wert an, wenn Sie ein Feld "Entwickelt nach " in die Auflistung aufnehmen möchten. (Die Veröffentlicht nach Feld listet den Herausgeberanzeigenamen auf, der Ihrem Konto zugeordnet ist, unabhängig davon, ob Sie einen devStudio-Wert angeben.) |
Bildressource
Diese Ressource enthält Bild- und Symboldaten für einen App-Eintrag. Weitere Informationen zu Bildern und Symbolen für einen App-Eintrag finden Sie unter App-Screenshots und -Bilder. Diese Ressource weist die folgenden Werte auf:
Wert | Typ | Beschreibung |
---|---|---|
fileName | Zeichenfolge | Der Name der Bilddatei im ZIP-Archiv, das Sie für die Übermittlung hochgeladen haben. |
fileStatus | Zeichenfolge | Der Status der Bilddatei. Dies kann einer der folgenden Werte sein:
|
id | Zeichenfolge | Die ID für das Bild. Dieser Wert wird vom Partner Center bereitgestellt. |
Beschreibung | string | Die Beschreibung für das Bild. |
imageType | Zeichenfolge | Gibt den Typ des Bilds an. Die folgenden Zeichenfolgen werden derzeit unterstützt.
|
Ressource für Spieleoptionen
Diese Ressource enthält spielbezogene Einstellungen für die App. Die Werte in dieser Ressource entsprechen den Spieleinstellungen für Übermittlungen im Partner Center.
{
"gamingOptions": [
{
"genres": [
"Games_ActionAndAdventure",
"Games_Casino"
],
"isLocalMultiplayer": true,
"isLocalCooperative": true,
"isOnlineMultiplayer": false,
"isOnlineCooperative": false,
"localMultiplayerMinPlayers": 2,
"localMultiplayerMaxPlayers": 12,
"localCooperativeMinPlayers": 2,
"localCooperativeMaxPlayers": 12,
"isBroadcastingPrivilegeGranted": true,
"isCrossPlayEnabled": false,
"kinectDataForExternal": "Enabled"
}
],
}
Diese Ressource weist die folgenden Werte auf:
Wert | Typ | Beschreibung |
---|---|---|
genres | array | Ein Array einer oder mehrerer der folgenden Zeichenfolgen, die die Genres des Spiels beschreiben:
|
isLocalMultiplayer | boolean | Gibt an, ob das Spiel lokale Multiplayer unterstützt. |
isLocalCooperative | boolean | Gibt an, ob das Spiel lokale Koop unterstützt. |
isOnlineMultiplayer | boolean | Gibt an, ob das Spiel Online-Multiplayer unterstützt. |
isOnlineCooperative | boolean | Gibt an, ob das Spiel Online-Koop unterstützt. |
localMultiplayerMinPlayers | int | Gibt die Mindestanzahl der Spieler an, die das Spiel für lokale Multiplayer unterstützt. |
localMultiplayerMaxPlayers | int | Gibt die maximale Anzahl von Spielern an, die das Spiel für lokale Multiplayer unterstützt. |
localCooperativeMinPlayers | int | Gibt die Mindestanzahl der Spieler an, die das Spiel für lokale Zusammenarbeit unterstützt. |
localCooperativeMaxPlayers | int | Gibt die maximale Anzahl von Spielern an, die das Spiel für lokale Koop unterstützt. |
isBroadcastingPrivilegeGranted | boolean | Gibt an, ob das Spiel die Übertragung unterstützt. |
isCrossPlayEnabled | boolean | Gibt an, ob das Spiel Multiplayersitzungen zwischen Spielern auf Windows 10- und Windows 11-PCs und Xbox unterstützt. |
kinectDataForExternal | Zeichenfolge | Einer der folgenden Zeichenfolgenwerte, die angibt, ob das Spiel Kinect-Daten sammeln und an externe Dienste senden kann:
|
Hinweis
Die GamingOptions-Ressource wurde im Mai 2017 hinzugefügt, nachdem die Microsoft Store-Übermittlungs-API zuerst für Entwickler veröffentlicht wurde. Wenn Sie eine Übermittlung für eine App über die Übermittlungs-API erstellt haben, bevor diese Ressource eingeführt wurde und diese Übermittlung noch ausgeführt wird, ist diese Ressource null für Übermittlungen für die App, bis Sie die Übermittlung erfolgreich ausführen oder sie löschen. Wenn die GamingOptions-Ressource für Übermittlungen für eine App nicht verfügbar ist, ist das HasAdvancedListingPermission-Feld der vom Abrufen einer App-Methode zurückgegebenen Anwendungsressource "false".
Statusdetails-Ressource
Diese Ressource enthält zusätzliche Details zum Status einer Übermittlung. Diese Ressource weist die folgenden Werte auf:
Wert | Typ | Beschreibung |
---|---|---|
errors | Objekt | Ein Array von Statusdetailsesourcen, die Fehlerdetails für die Übermittlung enthalten. |
warnings | Objekt | Ein Array von Statusdetailsesourcen, die Warnungsdetails für die Übermittlung enthalten. |
certificationReports | Objekt | Ein Array von Zertifizierungsberichtsressourcen, die Zugriff auf die Zertifizierungsberichtsdaten für die Übermittlung bieten. Sie können diese Berichte auf weitere Informationen überprüfen, wenn die Zertifizierung fehlschlägt. |
Statusdetailressource
Diese Ressource enthält zusätzliche Informationen zu Fehlern oder Warnungen für eine Übermittlung. Diese Ressource weist die folgenden Werte auf:
Wert | Typ | BESCHREIBUNG |
---|---|---|
code | Zeichenfolge | Ein Übermittlungsstatuscode, der den Typ des Fehlers oder der Warnung beschreibt. |
details | Zeichenfolge | Eine Nachricht mit weiteren Details zum Problem. |
Anwendungspaketressource
Diese Ressource enthält Details zu einem App-Paket für die Übermittlung.
{
"applicationPackages": [
{
"fileName": "contoso_app.appx",
"fileStatus": "Uploaded",
"id": "1152921504620138797",
"version": "1.0.0.0",
"architecture": "ARM",
"languages": [
"en-US"
],
"capabilities": [
"ID_RESOLUTION_HD720P",
"ID_RESOLUTION_WVGA",
"ID_RESOLUTION_WXGA"
],
"minimumDirectXVersion": "None",
"minimumSystemRam": "None",
"targetDeviceFamilies": [
"Windows.Mobile min version 10.0.10240.0"
]
}
],
}
Diese Ressource weist die folgenden Werte auf:
Hinweis
Beim Aufrufen der Aktualisierung einer App-Übermittlungsmethode sind nur die Werte "fileName", "fileStatus", "minimumDirectXVersion" und "minimumSystemRam " dieses Objekts im Anforderungstext erforderlich. Die anderen Werte werden vom Partner Center aufgefüllt.
Wert | Typ | Beschreibung |
---|---|---|
fileName | Zeichenfolge | Der Name des Pakets. |
fileStatus | Zeichenfolge | Der Status des Pakets. Dies kann einer der folgenden Werte sein:
|
id | Zeichenfolge | Eine ID, die das Paket eindeutig identifiziert. Dieser Wert wird vom Partner Center bereitgestellt. |
version | Zeichenfolge | Die Version des App-Pakets. Weitere Informationen finden Sie unter Paketversionsnummerierung. |
architecture | Zeichenfolge | Die Architektur des Pakets (z. B. ARM). |
languages | array | Ein Array von Sprachcodes für die von der App unterstützten Sprachen. Weitere Informationen finden Sie unter unterstützte Sprachen. |
capabilities | array | Ein Array von Funktionen, die vom Paket benötigt werden. Weitere Informationen zu Funktionen finden Sie unter App-Funktionsdeklarationen. |
minimumDirectXVersion | Zeichenfolge | Die minimale DirectX-Version, die vom App-Paket unterstützt wird. Dies kann nur für Apps festgelegt werden, die auf Windows 8.x abzielen. Bei Apps, die auf andere Betriebssystemversionen abzielen, muss dieser Wert beim Aufrufen einer App-Übermittlungsmethode vorhanden sein, der angegebene Wert wird jedoch ignoriert. Dies kann einer der folgenden Werte sein:
|
minimumSystemRam | Zeichenfolge | Der minimale RAM, der vom App-Paket benötigt wird. Dies kann nur für Apps festgelegt werden, die auf Windows 8.x abzielen. Bei Apps, die auf andere Betriebssystemversionen abzielen, muss dieser Wert beim Aufrufen einer App-Übermittlungsmethode vorhanden sein, der angegebene Wert wird jedoch ignoriert. Dies kann einer der folgenden Werte sein:
|
targetDeviceFamilies | array | Ein Array von Zeichenfolgen, die die Gerätefamilien darstellen, auf die das Paket ausgerichtet ist. Dieser Wert wird nur für Pakete verwendet, die auf Windows 10 abzielen. für Pakete, die auf frühere Versionen abzielen, hat dieser Wert den Wert "None". Die folgenden Gerätefamilienzeichenfolgen werden derzeit für Windows 10- und Windows 11-Pakete unterstützt, wobei {0} es sich um eine Windows 10- oder Windows 11-Versionszeichenfolge wie 10.0.10240.0, 10.0.10586.0 oder 10.0.14393.0 handelt:
|
id="certification-report-resource"
Ressource für den Zertifizierungsbericht
Diese Ressource bietet Zugriff auf die Zertifizierungsberichtsdaten für eine Übermittlung. Diese Ressource weist die folgenden Werte auf:
Wert | Typ | Beschreibung |
---|---|---|
Datum | Zeichenfolge | Datum und Uhrzeit der Berichterstellung im ISO 8601-Format. |
reportUrl | Zeichenfolge | Die URL, über die Sie auf den Bericht zugreifen können. |
Ressource für Paketübermittlungsoptionen
Diese Ressource enthält schrittweise Paketrollouts und obligatorische Updateeinstellungen für die Übermittlung.
{
"packageDeliveryOptions": {
"packageRollout": {
"isPackageRollout": false,
"packageRolloutPercentage": 0,
"packageRolloutStatus": "PackageRolloutNotStarted",
"fallbackSubmissionId": "0"
},
"isMandatoryUpdate": false,
"mandatoryUpdateEffectiveDate": "1601-01-01T00:00:00.0000000Z"
},
}
Diese Ressource weist die folgenden Werte auf:
Wert | Typ | Beschreibung |
---|---|---|
packageRollout | Objekt | Eine Paketrolloutressource , die schrittweise Paketrollouteinstellungen für die Übermittlung enthält. |
isMandatoryUpdate | boolean | Gibt an, ob die Pakete in dieser Übermittlung als obligatorisch für die Selbstinstallation von App-Updates behandelt werden sollen. Weitere Informationen zu obligatorischen Paketen für die selbstinstallation von App-Updates finden Sie unter Herunterladen und Installieren von Paketupdates für Ihre App. |
obligatorUpdateEffectiveDate | date | Das Datum und die Uhrzeit, zu der die Pakete in dieser Übermittlung obligatorisch werden, im ISO 8601-Format und in der UTC-Zeitzone. |
Paketrollout-Ressource
Diese Ressource enthält schrittweise Paketrollouteinstellungen für die Übermittlung. Diese Ressource weist die folgenden Werte auf:
Wert | Typ | Beschreibung |
---|---|---|
isPackageRollout | boolean | Gibt an, ob das graduelle Paketrollout für die Übermittlung aktiviert ist. |
packageRolloutPercentage | float | Der Prozentsatz der Benutzer, die die Pakete im graduellen Rollout erhalten. |
packageRolloutStatus | Zeichenfolge | Eine der folgenden Zeichenfolgen, die den Status des graduellen Paketrollouts angibt:
|
fallbackSubmissionId | Zeichenfolge | Die ID der Übermittlung, die von Kunden empfangen wird, die die graduellen Rolloutpakete nicht erhalten. |
Hinweis
Die Werte "packageRolloutStatus " und "fallbackSubmissionId " werden vom Partner Center zugewiesen und sind nicht für die Festlegung durch den Entwickler vorgesehen. Wenn Sie diese Werte in einen Anforderungstext einschließen, werden diese Werte ignoriert.
Trailers-Ressource
Diese Ressource stellt einen Videotrailer für den App-Eintrag dar. Die Werte in dieser Ressource entsprechen den Traileroptionen für Übermittlungen im Partner Center.
Sie können bis zu 15 Trailerressourcen zum Trailerarray in einer App-Übermittlungsressource hinzufügen. Um Trailer-Videodateien und Miniaturansichten für eine Übermittlung hochzuladen, fügen Sie diese Dateien demselben ZIP-Archiv hinzu, das die Pakete und Auflistungsbilder für die Übermittlung enthält, und laden Sie dieses ZIP-Archiv dann in den SAS-URI (Shared Access Signature) für die Übermittlung hoch. Weitere Informationen zum Hochladen des ZIP-Archivs in den SAS-URI finden Sie unter Erstellen einer App-Übermittlung.
{
"trailers": [
{
"id": "1158943556954955699",
"videoFileName": "Trailers\\ContosoGameTrailer.mp4",
"videoFileId": "1159761554639123258",
"trailerAssets": {
"en-us": {
"title": "Contoso Game",
"imageList": [
{
"fileName": "Images\\ContosoGame-Thumbnail.png",
"id": "1155546904097346923",
"description": "This is a still image from the video."
}
]
}
}
}
]
}
Diese Ressource weist die folgenden Werte auf:
Wert | Typ | Beschreibung |
---|---|---|
id | Zeichenfolge | Die ID für den Trailer. Dieser Wert wird vom Partner Center bereitgestellt. |
videoFileName | Zeichenfolge | Der Name der Trailer-Videodatei im ZIP-Archiv, das Dateien für die Übermittlung enthält. |
videoFileId | Zeichenfolge | Die ID für die Trailer-Videodatei. Dieser Wert wird vom Partner Center bereitgestellt. |
trailerAssets | Objekt | Ein Wörterbuch mit Schlüssel- und Wertpaaren, wobei jeder Schlüssel ein Sprachcode ist und jeder Wert eine Trailerressourcenressource ist, die zusätzliche gebietsschemaspezifische Ressourcen für den Trailer enthält. Weitere Informationen zu den unterstützten Sprachcodes finden Sie unter "Unterstützte Sprachen". |
Hinweis
Die Trailers-Ressource wurde im Mai 2017 hinzugefügt, nachdem die Microsoft Store-Übermittlungs-API zuerst für Entwickler veröffentlicht wurde. Wenn Sie eine Übermittlung für eine App über die Übermittlungs-API erstellt haben, bevor diese Ressource eingeführt wurde und diese Übermittlung noch ausgeführt wird, ist diese Ressource null für Übermittlungen für die App, bis Sie die Übermittlung erfolgreich ausführen oder sie löschen. Wenn die Trailers-Ressource für Übermittlungen für eine App nicht verfügbar ist, ist das HasAdvancedListingPermission-Feld der vom Abrufen einer App-Methode zurückgegebenen Anwendungsressource "false".
Trailer-Ressourcenressource
Diese Ressource enthält zusätzliche gebietsschemaspezifische Ressourcen für einen Trailer, der in einer Trailerressource definiert ist. Diese Ressource weist die folgenden Werte auf:
Wert | Typ | BESCHREIBUNG |
---|---|---|
Titel | Zeichenfolge | Der lokalisierte Titel des Trailers. Der Titel wird angezeigt, wenn der Benutzer den Trailer im Vollbildmodus wiederspielt. |
imageList | array | Ein Array, das eine Bildressource enthält, die das Miniaturbild für den Trailer bereitstellt. Sie können nur eine Bildressource in dieses Array aufnehmen. |
Bildressource (für einen Trailer)
Diese Ressource beschreibt die Miniaturansicht eines Trailers. Diese Ressource weist die folgenden Werte auf:
Wert | Typ | Beschreibung |
---|---|---|
fileName | Zeichenfolge | Der Name der Miniaturbilddatei im ZIP-Archiv, das Sie für die Übermittlung hochgeladen haben. |
id | Zeichenfolge | Die ID für das Miniaturbild. Dieser Wert wird vom Partner Center bereitgestellt. |
Beschreibung | string | Die Beschreibung für das Miniaturbild. Dieser Wert ist nur Metadaten und wird benutzern nicht angezeigt. |
Enumerationen
Diese Methoden verwenden die folgenden Enumerationen.
Preisstufen
Die folgenden Werte stellen die verfügbaren Preisniveaus in der Ressourcenressource für eine App-Übermittlung dar.
Wert | Beschreibung |
---|---|
Basis | Das Preisniveau ist nicht festgelegt; verwenden Sie den Grundpreis für die App. |
NotAvailable | Die App ist in der angegebenen Region nicht verfügbar. |
Kostenlos | Die Apps ist kostenlos. |
Ebenexxx | Eine Zeichenfolge, die das Preisniveau für die App im Format Tierxxxx angibt. Derzeit werden die folgenden Preisstufen unterstützt:
|
Enterprise-Lizenzierungswerte
Die folgenden Werte stellen das Organisationslizenzierungsverhalten für die App dar. Weitere Informationen zu diesen Optionen finden Sie unter Organisationslizenzierungsoptionen.
Hinweis
Obwohl Sie die Lizenzierungsoptionen für die Organisation für eine App-Übermittlung über die Übermittlungs-API konfigurieren können, können Sie diese API nicht verwenden, um Übermittlungen für Volumenkäufe über die Microsoft Store für Unternehmen und Microsoft Store für Bildungseinrichtungen zu veröffentlichen. Um Übermittlungen an den Microsoft Store für Unternehmen und Microsoft Store für Bildungseinrichtungen zu veröffentlichen, müssen Sie Partner Center verwenden.
Wert | BESCHREIBUNG |
---|---|
Keine | Stellen Sie Ihre App nicht für Unternehmen mit der vom Store verwalteten Volumenlizenzierung (Onlinelizenzierung) zur Verfügung. |
Online | Stellen Sie Ihre App Für Unternehmen mit Volumenlizenzierung mit vom Store verwalteten (Online)-Volumenlizenzierung zur Verfügung. |
OnlineAndOffline | Stellen Sie Ihre App Für Unternehmen mit der vom Store verwalteten (Online)-Volumenlizenzierung zur Verfügung, und stellen Sie Ihre App für Unternehmen über die getrennte (Offline)-Lizenzierung zur Verfügung. |
Übermittlungsstatuscode
Die folgenden Werte stellen den Statuscode einer Übermittlung dar.
Wert | BESCHREIBUNG |
---|---|
Keine | Es wurde kein Code angegeben. |
InvalidArchive | Das ZIP-Archiv, das das Paket enthält, ist ungültig oder weist ein unbekanntes Archivformat auf. |
MissingFiles | Das ZIP-Archiv verfügt nicht über alle Dateien, die in Ihren Übermittlungsdaten aufgelistet wurden, oder sie befinden sich am falschen Speicherort im Archiv. |
PackageValidationFailed | Mindestens ein Paket in Ihrer Übermittlung konnte nicht überprüft werden. |
InvalidParameterValue | Einer der Parameter im Anforderungstext ist ungültig. |
InvalidOperation | Der von Ihnen versuchte Vorgang ist ungültig. |
InvalidState | Der von Ihnen versuchte Vorgang ist für den aktuellen Status des Flight-Pakets ungültig. |
ResourceNotFound | Das angegebene Flight-Paket konnte nicht gefunden werden. |
ServiceError | Ein interner Dienstfehler verhinderte, dass die Anforderung erfolgreich war. Versuchen Sie die Anforderung erneut. |
ListingOptOutWarning | Der Entwickler hat eine Auflistung aus einer vorherigen Übermittlung entfernt oder keine Eintragsinformationen enthalten, die vom Paket unterstützt werden. |
ListingOptInWarning | Der Entwickler hat einen Eintrag hinzugefügt. |
UpdateOnlyWarning | Der Entwickler versucht, etwas einzufügen, das nur Updateunterstützung enthält. |
Andere | Die Übermittlung befindet sich in einem nicht erkannten oder nicht kategorisierten Zustand. |
PackageValidationWarning | Der Paketüberprüfungsprozess führte zu einer Warnung. |