Verwalten von App-Übermittlungen
Die Microsoft Store-Übermittlungs-API bietet Methoden, die Sie zum Verwalten von Übermittlungen für Ihre Apps verwenden können, einschließlich schrittweiser 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, müssen Sie weitere Änderungen an der Übermittlung nur mithilfe der API und nicht mit Partner Center 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 committen. In einigen Fällen kann die Übermittlung in einem Fehlerzustand verbleiben, in dem sie im Übermittlungsprozess nicht 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 in 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 zum Abrufen, Erstellen, Aktualisieren, Committen oder Löschen einer App-Übermittlung. Bevor Sie diese Methoden verwenden können, muss die App bereits in Ihrem Partner Center-Konto vorhanden sein, und Sie müssen zunächst eine Übermittlung für die App in Partner Center erstellen. Weitere Informationen finden Sie unter Voraussetzungen.
Methode | 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 | Committen einer neuen oder aktualisierten App-Übermittlung |
Delete | https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId} | Löschen einer App-Übermittlung |
Erstellen einer App-Übermittlung
Gehen Sie folgendermaßen vor, um eine Übermittlung für eine App zu erstellen.
Wenn Sie dies noch nicht getan haben, erfüllen Sie alle Voraussetzungen für die Microsoft Store-Übermittlungs-API.
Hinweis
Stellen Sie sicher, dass für die App bereits mindestens eine abgeschlossene Übermittlung mit den Informationen zur Altersfreigabe abgeschlossen ist.
Rufen Sie ein Azure AD-Zugriffstoken ab. 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. Wenn das Token abgelaufen ist, können Sie ein neues 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, die eine Kopie der letzten veröffentlichten Übermittlung ist.
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, Auflistungsbilder 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 in Azure Storage, ohne dass Kontoschlüssel erforderlich sind. Hintergrundinformationen zu SAS-URIs und deren Verwendung mit Azure Blob Storage finden Sie unter Shared Access Signatures, Part 1: Understanding the SAS model and Shared Access Signatures, Part 2: Create and use a SAS with Blob Storage.
Wenn Sie neue Pakete, Listenbilder 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 all diese Dateien 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, aktualisieren Sie die Übermittlungsdaten so, dass sie auf den Namen und den relativen Pfad dieser Dateien im ZIP-Archiv verweisen.
Wenn Sie neue Pakete, Auflistenbilder oder Trailerdateien für die Übermittlung hinzufügen, laden Sie das ZIP-Archiv mithilfe des SAS-URI hoch, der im Antworttext der zuvor aufgerufenen POST-Methode bereitgestellt wurde, in Azure Blob Storage. Zu diesem Zweck können Sie verschiedene Azure-Bibliotheken auf unterschiedlichen Plattformen verwenden, darunter:
Im folgenden C#-Codebeispiel wird veranschaulicht, wie Sie mithilfe der CloudBlockBlob-Klasse in der Azure Storage-Clientbibliothek für .NET ein ZIP-Archiv in Azure Blob Storage hochladen. Im Beispiel wird davon ausgegangen, dass das ZIP-Archiv bereits in ein Datenstromobjekt 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 folgende Methode aus, um die App-Übermittlung zu committen. Dadurch wird Partner Center benachrichtigt, dass Sie mit Ihrer Übermittlung fertig sind und dass Ihre Updates nun auf Ihr Konto angewendet werden sollten.
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 Status der Übermittlung zu überprüfen, zeigen Sie den Wert status im Antworttext an. Dieser Wert sollte von CommitStarted entweder in PreProcessing geändert worden sein, wenn die Anforderung erfolgreich war, oder in CommitFailed, wenn die Anforderung Fehler enthalten hat. Wenn Fehler aufgetreten sind, enthält das Feld StatusDetails Feld weitere Details zu den Fehlern.
Nachdem das Commit erfolgreich abgeschlossen wurde, wird die Übermittlung zur Aufnahme an den Store gesendet. Sie können den Übermittlungsfortschritt weiterhin überwachen, indem Sie die vorherige Methode verwenden oder das Partner Center besuchen.
Methoden zum Verwalten eines graduellen Paketrollouts
Sie können die aktualisierten Pakete in einer App-Übermittlung schrittweise an einen Prozentsatz der Kunden Ihrer App auf Windows 10 und Windows 11. So können Sie Feedback und Analysedaten für die jeweiligen Pakete überwachen und vor einem umfassenden Rollout sicherstellen, dass das Update ordnungsgemäß funktioniert. Sie können den Rollout-Prozentwert für eine veröffentlichte Übermittlung ändern (oder die Aktualisierung anhalten), ohne dass Sie eine neue Übermittlung erstellen müssen. Weitere Informationen, einschließlich Anweisungen zum Aktivieren und Verwalten eines schrittweisen Paketrollouts in Partner Center, finden Sie in diesem Artikel.
Führen Sie zum programmgesteuerten Aktivieren eines schrittweisen Paketrollouts für eine App-Übermittlung diesen Prozess mithilfe von Methoden in der Microsoft Store-Übermittlungs-API aus:
- 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 isPackageRollout auftrue 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 Methode zum Aktualisieren einer App-Übermittlung.
Nachdem ein graduelles Paketrollout für eine App-Übermittlung aktiviert wurde, können Sie das graduelle Rollout mithilfe der folgenden Methoden programmgesteuert abrufen, aktualisieren, anhalten oder abschließen.
Methode | URI | Beschreibung |
---|---|---|
GET | https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/packagerollout | Abrufen von Informationen zum graduellen Rollout einer App-Übermittlung |
POST | https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/updatepackagerolloutpercentage | Aktualisieren des Prozentsatzes eines graduellen Rollouts einer App-Übermittlung |
POST | https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/haltpackagerollout | Anhalten des graduellen Rollouts einer App-Übermittlung |
POST | https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/finalizepackagerollout | Abschließen des graduellen Rollouts einer App-Übermittlung |
Codebeispiele für die Verwaltung von App-Übermittlungen
Die folgenden Artikel enthalten ausführliche Codebeispiele, die zeigen, 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 der API implementiert. Dieses Modul heißt StoreBroker. 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 das Aufrufen dieser API anzuzeigen. Das StoreBroker-Modul wird in Microsoft aktiv als primäre Methode verwendet, um viele Erstanbieteranwendungen an den Store zu übermitteln.
Weitere Informationen finden Sie auf unserer StoreBroker-Seite auf GitHub.
Datenressourcen
Die Microsoft Store-Übermittlungs-API-Methoden zum Verwalten von App-Übermittlungen verwenden die folgenden JSON-Datenressourcen.
Ressource für App-Übermittlungen
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": []
}
Die Ressource hat die folgenden Werte.
Wert | Typ | BESCHREIBUNG |
---|---|---|
id | Zeichenfolge | Die ID der Übermittlung. Diese ID ist in den Antwortdaten für Anforderungen verfügbar, um eine App-Übermittlung zu erstellen, alle Apps abzurufen und eine App abzurufen. Für eine Übermittlung, die in Partner Center erstellt wurde, ist diese ID auch in der URL für die Übermittlungsseite in Partner Center verfügbar. |
applicationCategory | Zeichenfolge | Eine Zeichenfolge, die Kategorie und/oder Unterkategorie für Ihre App angibt. Kategorien und Unterkategorien werden mit einem Unterstrich „_“ zu einer einzigen Zeichenfolge zusammengefasst, z. B. BooksAndReference_EReader. |
Preise | Objekt (object) | Eine Preisressource, die Preisinformationen für die App enthält. |
Sichtbarkeit | Zeichenfolge | Die Sichtbarkeit der App. Mögliche Werte:
|
targetPublishMode | Zeichenfolge | Der Veröffentlichungsmodus für die Übermittlung. Mögliche Werte:
|
targetPublishDate | Zeichenfolge | Das Veröffentlichungsdatum der Übermittlung im ISO 8601-Format, wenn TargetPublishMode den Wert SpecificDate hat. |
listings | Objekt (object) | Ein Verzeichnis von Schlüssel-Wert-Paaren, wobei ein Schlüssel ein Ländercode und ein Wert eine Eintragsressource ist, die Eintragsinfos für die App enthält. |
hardwarePreferences | array | Ein Array von Zeichenfolgen, die die Hardwareeinstellungen für die App definieren. Mögliche Werte:
|
automaticBackupEnabled | boolean | Gibt an, ob Windows die App-Daten in automatische Sicherungen auf OneDrive aufnehmen können. Weitere Informationen finden Sie unter App-Deklarationen. |
canInstallOnRemovableMedia | boolean | Gibt an, ob Kunden die 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 Spieloptionenressource enthält, die spielbezogene Einstellungen für die App definiert. |
hasExternalInAppProducts | boolean | Gibt an, ob Ihre App es Benutzern ermöglicht, einkäufe außerhalb des Microsoft Store-Commerce-Systems zu tätigen. Weitere Informationen finden Sie unter App-Deklarationen. |
meetAccessibilityGuidelines | boolean | Gibt an, ob getestet wurde, ob die App die Richtlinien zur Barrierefreiheit erfüllt. Weitere Informationen finden Sie unter App-Deklarationen. |
notesForCertification | Zeichenfolge | Enthält Hinweise zur Zertifizierung für Ihre App. |
status | Zeichenfolge | Der Status der Übermittlung. Mögliche Werte:
|
statusDetails | Objekt (object) | Eine Ressource für Statusdetails, die zusätzliche Details über den Status der Übermittlung enthält, einschließlich Fehlerinformationen. |
fileUploadUrl | Zeichenfolge | Der Shared Access Signature (SAS)-URI für das Hochladen der Pakete für die Übermittlung. Wenn Sie neue Pakete, Auflisten von Bildern oder Trailerdateien für die Übermittlung hinzufügen, laden Sie das ZIP-Archiv, das die Pakete und Bilder enthält, in diesen URI hoch. Weitere Informationen finden Sie unter Erstellen einer App-Übermittlung. |
applicationPackages | array | Ein Array von Ressourcen für Anwendungspakete, die Details über die einzelnen Pakete in der Übermittlung bereitstellen. |
packageDeliveryOptions | Objekt (object) | Eine Ressource für Paketübermittlungsoptionen, die Einstellungen zu graduellen Paketrollouts und zu verpflichtenden Updates für die Übermittlung enthält. |
enterpriseLicensing | Zeichenfolge | Einer der Werte für Unternehmenslizenzierung, die das Verhalten der Unternehmenslizenzierung für die App angeben. |
allowMicrosoftDecideAppAvailabilityToFutureDeviceFamilies | boolean | Gibt an, ob Microsoft die App zukünftigen Windows 10 und Windows 11 Gerätefamilien zur Verfügung stellen darf. |
allowTargetFutureDeviceFamilies | Objekt (object) | Ein Wörterbuch von Schlüssel- und Wertpaaren, wobei jeder Schlüssel ein Windows 10 und Windows 11 Gerätefamilie ist und jeder Wert ein boolescher Wert ist, der angibt, ob Ihre App die angegebene Gerätefamilie als Ziel verwenden darf. |
friendlyName | Zeichenfolge | Der Anzeigename der Übermittlung, wie in Partner Center gezeigt. Dieser Wert wird für Sie generiert, wenn Sie die Übermittlung erstellen. |
Anhänger | array | Ein Array, das bis zu 15 Trailerressourcen enthält, die Videotrailer für die App-Auflistung darstellen. |
Preisressource
Diese Ressource enthält Preisinformationen für die App. Die Ressource hat die folgenden Werte.
Wert | Typ | Beschreibung |
---|---|---|
trialPeriod | Zeichenfolge | Eine Zeichenfolge, die den Testzeitraum für die App angibt. Mögliche Werte:
|
marketSpecificPricings | Objekt (object) | Ein Verzeichnis von Schlüssel-Wert-Paaren, wobei jeder Schlüssel ein aus zwei Buchstaben bestehender 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 Verzeichnis überschreiben den durch den Wert priceId angegebenen Basispreis für den angegebenen Markt. |
Vertrieb | array | Deprecated. Ein Array von Verkaufsressourcen, die Verkaufsinformationen für die App enthalten. |
priceId | Zeichenfolge | Ein Preisniveau, das den Basispreis für die App angibt. |
isAdvancedPricingModel | boolean | Wenn true, hat Ihr Entwicklerkonto Zugriff auf die erweiterten Preisstufen von 0,99 USD auf 1999,99 USD. Bei false hat Ihr Entwicklerkonto Zugriff auf die ursprünglichen Preisstufen von 0,99 USD bis 999,99 USD. Weitere Informationen zu den verschiedenen Tarifen finden Sie unter Tarife. Hinweis Dieses Feld ist schreibgeschützt. |
Verkaufsressource
Diese Ressource enthält die Verkaufsinformationen für eine App.
Wichtig
Die Ressource Sale 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 werden wir die Microsoft Store-Übermittlungs-API aktualisieren, um eine neue Möglichkeit zum programmgesteuerten Zugriff auf Verkaufsinformationen für App-Übermittlungen einzuführen.
- Nach dem Aufrufen der GET-Methode zum Abrufen einer App-Übermittlung ist der Wert sales 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 Wert sales ignoriert. Sie können weiterhin Partner Center verwenden, um die Verkaufsdaten für Ihre App-Übermittlung zu ändern.
Die Ressource hat die folgenden Werte.
Wert | Typ | Beschreibung |
---|---|---|
name | Zeichenfolge | Der Name des Verkaufs. |
basePriceId | Zeichenfolge | Das Preisniveau, das für den Basispreis des Verkaufs verwendet werden soll. |
startDate | Zeichenfolge | Das Startdatum für den Verkauf im Format ISO 8601. |
endDate | Zeichenfolge | Das Enddatum für den Verkauf im Format ISO 8601. |
marketSpecificPricings | Objekt (object) | Ein Verzeichnis von Schlüssel-Wert-Paaren, wobei jeder Schlüssel ein aus zwei Buchstaben bestehender 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 Verzeichnis überschreiben den durch den Wert basePriceId angegebenen Basispreis für den angegebenen Markt. |
Eintragsressource
Diese Ressource enthält die Eintragsinformationen für eine App. Die Ressource hat die folgenden Werte.
Wert | Typ | Beschreibung |
---|---|---|
baseListing | Objekt (object) | Die Informationen für den Basiseintrag für die App, die die standardmäßigen Eintragsinformationen für alle Plattformen definiert. |
platformOverrides | Objekt (object) | Ein Verzeichnis von Schlüssel-Wert-Paaren, in denen jeder Schlüssel eine Zeichenfolge ist, die eine Plattform identifiziert, für die die Eintragsinformationen überschrieben werden sollen, und jeder Wert eine Basiseintragsressource ist (die nur die Werte von Beschreibung bis Titel enthält), die die Eintragsinformationen angibt, die für die angegebene Plattform überschrieben werden sollen. Die Schlüssel können die folgenden Werte haben:
|
Ressource für Basiseinträge
Diese Ressource enthält die Basiseintragsinformationen für eine App. Die Ressource hat die folgenden Werte.
Wert | Typ | Beschreibung |
---|---|---|
copyrightAndTrademarkInfo | Zeichenfolge | Optionale Copyright- und/oder Markeninformationen. |
keywords | array | Ein Array von keyword, um die Anzeige Ihrer App in Suchergebnissen zu unterstützen. |
licenseTerms | Zeichenfolge | Die optionalen Lizenzbestimmungen für Ihre App. |
privacyPolicy | Zeichenfolge | Dieser Wert ist veraltet. Zum Festlegen oder Ändern der Datenschutzrichtlinien-URL für Ihre App müssen Sie dies auf der Seite Eigenschaften in Partner Center tun. Sie können diesen Wert in 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 im Partner Center auf der Seite Eigenschaften tun. Sie können diesen Wert in 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 in Partner Center tun. Sie können diesen Wert in Ihren Aufrufen der Übermittlungs-API weglassen. Wenn Sie diesen Wert festlegen, wird er ignoriert. |
description | Zeichenfolge | 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 mit bis zu 11 Zeichenfolgen, das die Mindesthardwarekonfigurationen für Ihre App auflistet. |
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 Hubs auf Xbox One angezeigt und hilft Kunden, mehr über Ihr Spiel zu verstehen. |
shortTitle | Zeichenfolge | Eine kürzere Version des Produktnamens. Falls 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 alphabetisiert werden könnte, können Sie hier eine andere Version eingeben. Dies kann Kunden helfen, das Produkt bei der Suche schneller zu finden. |
voiceTitle | Zeichenfolge | Ein alternativer Name für Ihr Produkt, der ggf. 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 das Feld "Entwickelt von " in die Auflistung aufnehmen möchten. (Im Feld Veröffentlicht von wird der Anzeigename des Herausgebers angezeigt, der Ihrem Konto zugeordnet ist, unabhängig davon, ob Sie einen devStudio-Wert angeben oder nicht.) |
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. Die Ressource hat die folgenden Werte.
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. Mögliche Werte:
|
id | Zeichenfolge | Die ID für das Image. Dieser Wert wird von Partner Center bereitgestellt. |
description | Zeichenfolge | Die Beschreibung für das Bild. |
imageType | Zeichenfolge | Gibt den Typ des Bilds an. Die folgenden Zeichenfolgen werden derzeit unterstützt. Screenshot:
|
Gaming-Optionen-Ressource
Diese Ressource enthält spielbezogene Einstellungen für die App. Die Werte in dieser Ressource entsprechen den Spieleinstellungen für Übermittlungen in 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"
}
],
}
Die Ressource hat die folgenden Werte.
Wert | Typ | Beschreibung |
---|---|---|
genres | array | Ein Array aus mindestens einer der folgenden Zeichenfolgen, die die Genres des Spiels beschreiben:
|
isLocalMultiplayer | boolean | Gibt an, ob das Spiel den lokalen 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 von Spielern an, die das Spiel für den lokalen Multiplayer unterstützt. |
localMultiplayerMaxPlayers | INT | Gibt die maximale Anzahl von Spielern an, die das Spiel für den lokalen Multiplayer unterstützt. |
localCooperativeMinPlayers | INT | Gibt die Mindestanzahl von Spielern an, die das Spiel für den lokalen Koop unterstützt. |
localCooperativeMaxPlayers | INT | Gibt die maximale Anzahl von Spielern an, die das Spiel für den lokalen Koop unterstützt. |
isBroadcastingPrivilegeGranted | boolean | Gibt an, ob das Spiel die Übertragung unterstützt. |
isCrossPlayEnabled | boolean | Gibt an, ob das Spiel Multiplayer-Sitzungen zwischen Spielern auf Windows 10 und Windows 11 PCs und Xbox unterstützt. |
kinectDataForExternal | Zeichenfolge | Einer der folgenden Zeichenfolgenwerte, der 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 erstmals für Entwickler freigegeben 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 für Übermittlungen für die App NULL, bis Sie die Übermittlung erfolgreich committen oder löschen. Wenn die gamingOptions-Ressource nicht für Übermittlungen für eine App verfügbar ist, ist das HasAdvancedListingPermission-Feld der Anwendungsressource , die von der Methode zum Abrufen einer App zurückgegeben wird, false.
Ressource für Statusdetails
Diese Ressource enthält weitere Informationen über den Status einer Übermittlung. Die Ressource hat die folgenden Werte.
Wert | Typ | Beschreibung |
---|---|---|
errors | Objekt (object) | Ein Array von Ressourcen für einzelne Statusdetails, die Fehlerdetails zur Übermittlung enthalten. |
warnings | Objekt (object) | Ein Array von Ressourcen für einzelne Statusdetails, die Warnungsdetails zur Übermittlung enthalten. |
certificationReports | Objekt (object) | Ein Array von Ressourcen für Zertifizierungsberichte, die den Zugriff auf die Zertifizierungsberichtsdaten für die Übermittlung ermöglichen. Sie können diese Berichte auf weitere Informationen überprüfen, wenn die Zertifizierung nicht erfolgreich ist. |
Ressource für einzelne Statusdetails
Diese Ressource enthält weitere Informationen zu Fehlern oder Warnungen für eine Übermittlung. Die Ressource hat die folgenden Werte.
Wert | Typ | Beschreibung |
---|---|---|
code | Zeichenfolge | Ein Übermittlungsstatuscode, der den Fehler- oder Warnungstyp beschreibt. |
Details | Zeichenfolge | Eine Meldung mit weiteren Details zum Problem. |
Ressource für Anwendungspakete
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"
]
}
],
}
Die Ressource hat die folgenden Werte.
Hinweis
Beim Aufrufen der Methode zum Aktualisieren einer App-Übermittlung sind nur die Werte fileName, fileStatus, minimumDirectXVersion und minimumSystemRam dieses Objekts im Anforderungstext erforderlich. Die anderen Werte werden von Partner Center aufgefüllt.
Wert | Typ | Beschreibung |
---|---|---|
fileName | Zeichenfolge | Der Name des Pakets. |
fileStatus | Zeichenfolge | Der Status des Pakets. Mögliche Werte:
|
id | Zeichenfolge | Eine ID, die das Paket eindeutig identifiziert. Dieser Wert wird von Partner Center bereitgestellt. |
version | Zeichenfolge | Die Version des App-Pakets. Weitere Informationen finden Sie unter Paketversionsnummern. |
Architektur | Zeichenfolge | Die Architektur des Pakets (z. B. ARM). |
languages | array | Ein Array von Sprachcodes für die Sprachen, die von der App unterstützt werden. Weitere Informationen finden Sie unter Unterstützte Sprachen. |
capabilities | array | Ein Array von Funktionen, die für das Paket erforderlich sind. Weitere Informationen zu Funktionen finden Sie unter Deklaration der App-Funktionen. |
minimumDirectXVersion | Zeichenfolge | Die DirectX-Version, die vom App-Paket mindestens unterstützt wird. Dies kann nur für Apps festgelegt werden, die auf Windows 8.x abzielen. Für Apps, die auf andere Betriebssystemversionen abzielen, muss dieser Wert beim Aufrufen der Methode zum Aktualisieren einer App-Übermittlung vorhanden sein, aber der von Ihnen angegebene Wert wird ignoriert. Mögliche Werte:
|
minimumSystemRam | Zeichenfolge | Die Menge an RAM, die für das App-Paket mindestens erforderlich ist. Dies kann nur für Apps festgelegt werden, die auf Windows 8.x abzielen. Für Apps, die auf andere Betriebssystemversionen abzielen, muss dieser Wert beim Aufrufen der Methode zum Aktualisieren einer App-Übermittlung vorhanden sein, aber der von Ihnen angegebene Wert wird ignoriert. Mögliche Werte:
|
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 für Windows 10 bestimmt sind. Im Fall von Paketen, die für frühere Versionen bestimmt sind, hat dieser Wert den Wert None. Die folgenden Gerätefamilienzeichenfolgen werden derzeit für Windows 10- und Windows 11-Pakete unterstützt, wobei {0} eine Windows 10 oder Windows 11 Versionszeichenfolge wie 10.0.10240.0, 10.0.10586.0 oder 10.0.14393.0 ist:
|
id="certification-report-resource"
Ressource für Zertifizierungsberichte
Diese Ressource stellt den Zugriff auf die Zertifizierungsberichtsdaten für eine Übermittlung bereit. Die Ressource hat die folgenden Werte.
Wert | Typ | BESCHREIBUNG |
---|---|---|
date | Zeichenfolge | Das Datum und die Uhrzeit der Generierung des Berichts im ISO 8601-Format. |
reportUrl | Zeichenfolge | Die URL, unter der Sie auf den Bericht zugreifen können. |
Ressource für Paketübermittlungsoptionen
Diese Ressource enthält Einstellungen zu graduellen Paketrollouts und zu verpflichtenden Updates für die Übermittlung.
{
"packageDeliveryOptions": {
"packageRollout": {
"isPackageRollout": false,
"packageRolloutPercentage": 0,
"packageRolloutStatus": "PackageRolloutNotStarted",
"fallbackSubmissionId": "0"
},
"isMandatoryUpdate": false,
"mandatoryUpdateEffectiveDate": "1601-01-01T00:00:00.0000000Z"
},
}
Die Ressource hat die folgenden Werte.
Wert | Typ | Beschreibung |
---|---|---|
packageRollout | Objekt (object) | Eine Ressource für Paketrollouts, die Einstellungen zu graduellen Paketrollouts für die Übermittlung enthält. |
isMandatoryUpdate | boolean | Gibt an, ob die Pakete in dieser Übermittlung für automatisch installierte App-Updates als verpflichtend behandelt werden sollen. Weitere Informationen zu verpflichtenden Paketen für automatisch installierte App-Aktualisierungen finden Sie unter Herunterladen und Installieren von Paketupdates für Ihre App. |
mandatoryUpdateEffectiveDate | date | Zeitpunkt (Datum und Uhrzeit), zu dem die Pakete in dieser Übermittlung verpflichtend werden, im ISO 8601-Format und gemäß UTC-Zeitzone. |
Ressource für Paketrollouts
Diese Ressource enthält Einstellungen für graduelle Paketrollouts für die Übermittlung. Die Ressource hat die folgenden Werte.
Wert | Typ | Beschreibung |
---|---|---|
isPackageRollout | boolean | Gibt an, ob für die Übermittlung der graduelle Paketrollout aktiviert ist. |
packageRolloutPercentage | float | Der Prozentsatz der Benutzer, die im Rahmen des graduellen Paketrollouts die Pakete erhalten. |
packageRolloutStatus | Zeichenfolge | Eine der folgenden Zeichenfolgen, die den Status des graduellen Paketrollouts angeben:
|
fallbackSubmissionId | Zeichenfolge | Die ID der Übermittlung, die die Kunden erhalten, die keine Pakete im Rahmen des graduellen Paketrollouts erhalten. |
Hinweis
Die Werte packageRolloutStatus und fallbackSubmissionId werden von Partner Center zugewiesen und sollen nicht vom Entwickler festgelegt werden. Wenn Sie diese Werte in einen Anforderungstext einschließen, werden diese Werte ignoriert.
Trailerressource
Diese Ressource stellt einen Videotrailer für die App-Auflistung dar. Die Werte in dieser Ressource entsprechen den Traileroptionen für Übermittlungen in Partner Center.
Sie können dem Trailerarray in einer App-Übermittlungsressource bis zu 15 Trailerressourcen hinzufügen. Um Trailervideodateien 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."
}
]
}
}
}
]
}
Die Ressource hat die folgenden Werte.
Wert | Typ | BESCHREIBUNG |
---|---|---|
id | Zeichenfolge | Die ID für den Trailer. Dieser Wert wird von Partner Center bereitgestellt. |
videoFileName | Zeichenfolge | Der Name der Trailervideodatei im ZIP-Archiv, das Dateien für die Übermittlung enthält. |
videoFileId | Zeichenfolge | Die ID für die Trailervideodatei. Dieser Wert wird von Partner Center bereitgestellt. |
trailerAssets | Objekt (object) | Ein Wörterbuch von Schlüssel-Wert-Paaren, wobei jeder Schlüssel ein Sprachcode ist und jeder Wert eine Trailer-Ressourcenressource 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 Trailerressource wurde im Mai 2017 hinzugefügt, nachdem die Microsoft Store-Übermittlungs-API erstmals für Entwickler freigegeben 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 für Übermittlungen für die App NULL, bis Sie die Übermittlung erfolgreich committen oder löschen. Wenn die Trailers-Ressource nicht für Übermittlungen für eine App verfügbar ist, ist das HasAdvancedListingPermission-Feld der Anwendungsressource , die von der App-Methode abrufen zurückgegeben wird, false.
Trailerressourcenressource
Diese Ressource enthält zusätzliche gebietsschemaspezifische Ressourcen für einen Trailer, der in einer Trailerressource definiert ist. Die Ressource hat die folgenden Werte.
Wert | Typ | Beschreibung |
---|---|---|
title | Zeichenfolge | Der lokalisierte Titel des Trailers. Der Titel wird angezeigt, wenn der Benutzer den Trailer im Vollbildmodus abspielt. |
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 einschließen. |
Bildressource (für einen Trailer)
Diese Ressource beschreibt das Miniaturbild für einen Trailer. Die Ressource hat die folgenden Werte.
Wert | Typ | Beschreibung |
---|---|---|
fileName | Zeichenfolge | Der Name der Miniaturansichtsbilddatei im ZIP-Archiv, die Sie für die Übermittlung hochgeladen haben. |
id | Zeichenfolge | Die ID für das Miniaturbild. Dieser Wert wird von Partner Center bereitgestellt. |
description | Zeichenfolge | 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 Tarife in der Ressourcenressource "Preise " für eine App-Übermittlung dar.
Wert | Beschreibung |
---|---|
Basis | Das Preisniveau ist nicht festgelegt. Verwenden Sie den Basispreis für die App. |
NotAvailable | Die App ist für die angegebene Region nicht verfügbar. |
Kostenlos | Die Apps ist kostenlos. |
Tarifxxx | Eine Zeichenfolge, die den Tarif für die App im Format Tierxxxx angibt. Derzeit werden die folgenden Preisstufen unterstützt:
|
Enterprise-Lizenzwerte
Die folgenden Werte stellen das Lizenzierungsverhalten der Organisation für die App dar. Weitere Informationen zu diesen Optionen finden Sie unter Lizenzierungsoptionen für Unternehmen.
Hinweis
Obwohl Sie die Lizenzierungsoptionen der 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 die Microsoft Store für Unternehmen und Microsoft Store für Bildungseinrichtungen zu veröffentlichen, müssen Sie Partner Center verwenden.
Wert | Beschreibung |
---|---|
Keine | Ihre App soll Unternehmen nicht über die Store-verwaltete Volumenlizenzierung (Onlinevolumenlizenzierung) zur Verfügung gestellt werden. |
Online | Ihre App soll Unternehmen über die Store-verwaltete Volumenlizenzierung (Onlinevolumenlizenzierung) zur Verfügung gestellt werden. |
OnlineAndOffline | Ihre App soll Unternehmen über die Store-verwaltete Volumenlizenzierung (Onlinevolumenlizenzierung) sowie über die Offlinelizenzierung zur Verfügung gestellt werden. |
Ü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 hat ein unbekanntes Archivformat. |
MissingFiles | Das ZIP-Archiv enthält nicht alle Dateien, die in den Übermittlungsdaten aufgeführt sind, oder sie befinden sich am falschen Speicherort im Archiv. |
PackageValidationFailed | Mindestens ein Paket in der Ü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 Zustand des Flight-Pakets ungültig. |
ResourceNotFound | Das angegebene Flight-Paket konnte nicht gefunden werden. |
ServiceError | Ein interner Dienstfehler hat verhindert, dass die Anforderung erfolgreich ausgeführt wurde. Führen Sie die Anforderung erneut aus. |
ListingOptOutWarning | Der Entwickler hat einen Eintrag aus einer vorherigen Übermittlung entfernt oder Eintragsinformationen nicht hinzugefügt, die vom Paket unterstützt werden. |
ListingOptInWarning | Der Entwickler hat einen Eintrag hinzugefügt. |
UpdateOnlyWarning | Der Entwickler versucht, etwas einzufügen, für das nur Aktualisierungsunterstützung verfügbar ist. |
Andere | Die Übermittlung befindet sich in einem nicht erkannten oder nicht kategorisierten Zustand. |
PackageValidationWarning | Der Paketüberprüfungsvorgang hat zu einer Warnung geführt. |
Verwandte Themen
Feedback
https://aka.ms/ContentUserFeedback.
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unterFeedback senden und anzeigen für