REST-API-Referenz zum Aktualisieren von Microsoft Edge-Add-Ons
Dieser Artikel ist die REST-Endpunktreferenz für die Microsoft Edge-Add-Ons-API. Diese API automatisiert die Veröffentlichung von Updates für Add-Ons, die an den Microsoft Edge-Add-Ons-Store übermittelt wurden.
Eine Übersicht finden Sie unter Verwenden der REST-API zum Aktualisieren von Microsoft Edge-Add-Ons.
Versionen der Update-REST-API
Ab dem 6. September 2024 werden sowohl v1.1 als auch v1 dieser Update-REST-API unterstützt. Später wird v1 nicht mehr unterstützt. Das Datum für die Beendigung der Unterstützung von v1 ist noch nicht abgeschlossen.
Hochladen eines Pakets zum Aktualisieren einer vorhandenen Übermittlung
Lädt ein Paket hoch, um einen vorhandenen Entwurf der Übermittlung eines Add-On-Produkts zu aktualisieren.
Weitere Informationen finden Sie unter Hochladen eines Pakets zum Aktualisieren einer vorhandenen Übermittlung unter Verwenden der REST-API zum Aktualisieren von Microsoft Edge-Add-Ons.
Anforderung
| Methode | Anforderungs-URI |
|---|---|
POST |
/products/$productID/submissions/draft/package |
URI-Parameter
| URI-Parameter | Beschreibung |
|---|---|
$productID |
Erforderlich. Die Produkt-ID des Produkts, in das das Paket hochgeladen werden muss. |
Anforderungsheader
Die folgenden Anforderungsheader sind erforderlich:
Anforderungstext
<Zip package>
Antwort
Antwortheader
- Ort:
{operationID}
Die Antwort enthält eine Vorgangs-ID, die an andere Endpunkte gesendet werden soll.
Statuscodes
Diese API verfügt über die folgenden erwarteten status Codes.
| HTTP-Statuscode | Beschreibung |
|---|---|
| 202 | Die Anforderung wird für die Verarbeitung akzeptiert, aber die Verarbeitung ist nicht abgeschlossen. |
| 4XX | Weitere Informationen finden Sie weiter unten unter Fehlercodes. |
| 5XX | Weitere Informationen finden Sie weiter unten unter Fehlercodes. |
Siehe auch:
- Hochladen eines Pakets zum Aktualisieren einer vorhandenen Übermittlung unter Verwenden der REST-API zum Aktualisieren von Microsoft Edge-Add-Ons.
Überprüfen der status eines Paketuploads
Ruft die status des Paketuploads ab.
Weitere Informationen finden Sie unter Überprüfen der status eines Paketuploads unter Verwenden der REST-API zum Aktualisieren von Microsoft Edge-Add-Ons.
Anforderung
| Methode | Anforderungs-URI |
|---|---|
GET |
/products/$productID/submissions/draft/package/operations/$operationID |
URI-Parameter
| URI-Parameter | Beschreibung |
|---|---|
$operationID |
Erforderlich. Die Vorgangs-ID der Uploadanforderung, die im vorherigen Schritt übermittelt wurde. Diese Informationen sind im Antwortheader verfügbar. |
Anforderungsheader
Die folgenden Anforderungsheader sind erforderlich:
Anforderungstext
Keine
Antwort
Es gibt mehrere Antworten für unterschiedliche Szenarien.
Antwort, wenn der Vorgang noch ausgeführt wird
{
"id": "{operationID}",
"createdTime": "Date Time",
"lastUpdatedTime": "Date Time",
"status": "InProgress",
"message": null,
"errorCode": null,
"errors": null
}
Antwort, wenn der Vorgang erfolgreich ist
{
"id": "{operationID}",
"createdTime": "Date Time",
"lastUpdatedTime": "Date Time",
"status": "Succeeded",
"message": "Successfully updated package to {fileName}.zip",
"errorCode": "",
"errors": null
}
Antwort, wenn der Vorgang mit Fehlern fehlschlägt
{
"id": "{operationID}",
"createdTime": "Date Time",
"lastUpdatedTime": "Date Time",
"status": "Failed",
"message": "Error Message.",
"errorCode": "Error Code",
"errors": ["list of errors"]
}
Antwortheader
Keine.
Statuscodes
Diese API verfügt über die folgenden erwarteten status Codes.
| HTTP-Statuscode | Beschreibung |
|---|---|
| 200 | Die Anforderung ist OK. |
| 4XX | Weitere Informationen finden Sie weiter unten unter Fehlercodes. |
| 5XX | Weitere Informationen finden Sie weiter unten unter Fehlercodes. |
Siehe auch:
- Überprüfen der status eines Paketuploads unter Verwenden der REST-API zum Aktualisieren von Microsoft Edge-Add-Ons.
Veröffentlichen der Produktentwurfsübermittlung
Veröffentlicht den aktuellen Entwurf des Produkts in Microsoft Edge-Add-Ons.
Weitere Informationen finden Sie unter Veröffentlichen der Übermittlung unter Verwenden der REST-API zum Aktualisieren von Microsoft Edge-Add-Ons.
Anforderung
| Methode | Anforderungs-URI |
|---|---|
POST |
/products/$productID/submissions |
URI-Parameter
| URI-Parameter | Beschreibung |
|---|---|
$productID |
Erforderlich. Die Produkt-ID des Produkts, dessen Entwurf veröffentlicht werden muss. |
Anforderungsheader
Die folgenden Anforderungsheader sind erforderlich:
Anforderungstext
<Notes for certification>, im Nur-Text-Format.
Antwort
Antwortheader
- Ort:
{operationID}
Die Antwort enthält eine Vorgangs-ID, die an andere Endpunkte gesendet werden soll.
Statuscodes
Diese API verfügt über die folgenden erwarteten status Codes.
| HTTP-Statuscode | Beschreibung |
|---|---|
| 202 | Die Anforderung wird für die Verarbeitung akzeptiert, aber die Verarbeitung ist nicht abgeschlossen. |
| 4XX | Weitere Informationen finden Sie weiter unten unter Fehlercodes. |
| 5XX | Weitere Informationen finden Sie weiter unten unter Fehlercodes. |
Siehe auch:
- Veröffentlichen der Übermittlung unter Verwenden der REST-API zum Aktualisieren von Microsoft Edge-Add-Ons.
Überprüfen der Veröffentlichungs-status
Überprüft die status des Veröffentlichungsvorgangs.
Weitere Informationen finden Sie unter Überprüfen der Veröffentlichungs-status unter Verwenden der REST-API zum Aktualisieren von Microsoft Edge-Add-Ons.
Anforderung
| Methode | Anforderungs-URI |
|---|---|
GET |
/products/$productID/submissions/operations/$operationID |
URI-Parameter
Keine.
Anforderungsheader
Die folgenden Anforderungsheader sind erforderlich:
Anforderungstext
Keine
Antwort
Ein GET Vorgang status API kann in den folgenden Szenarien aufgerufen werden. In allen gültigen Szenarien 200 OK wird mit unterschiedlichen status Nachrichten zurückgegeben.
Die Antwort enthält eine Vorgangs-ID, die an andere Endpunkte gesendet werden soll.
Antwort beim Veröffentlichen eines neuen Produkts
{
"id": "{operationID}",
"createdTime": "Date Time",
"lastUpdatedTime": " Date Time ",
"status": "Failed",
"message": "Can't create new extension.",
"errorCode": "CreateNotAllowed",
"errors": null
}
Antwort, wenn nichts Neues veröffentlicht werden soll
{
"id": "{operationID}",
"createdTime": "Date Time",
"lastUpdatedTime": " Date Time ",
"status": "Failed",
"message": "Can't publish extension since there are no updates, please try again after updating the package.",
"errorCode": "NoModulesUpdated",
"errors": null
}
Antwort, wenn eine Überprüfungsübermittlung für dasselbe Produkt vorliegt
{
"id": "{operationID}",
"createdTime": "Date Time",
"lastUpdatedTime": " Date Time ",
"status": "Failed",
"message": "Can't publish extension as your extension submission is in progress. Please try again later.",
"errorCode": "InProgressSubmission",
"errors": null
}
Antwort, wenn es eine fortlaufende nicht veröffentlichte Übermittlung für dasselbe Produkt gibt
{
"id": "{operationID}",
"createdTime": "Date Time",
"lastUpdatedTime": " Date Time ",
"status": "Failed",
"message": "Can't publish extension as your extension is being unpublished. Please try after you've unpublished.",
"errorCode": "UnpublishInProgress",
"errors": null
}
Antwort, wenn eines der Module ungültig ist
{
"id": "{operationID}",
"createdTime": "Date Time",
"lastUpdatedTime": " Date Time ",
"status": "Failed",
"message": "Can't publish extension as your extension has modules that are not valid. Fix the modules with errors and try to publish again.",
"errorCode": "ModuleStateUnPublishable",
"errors": [
{
"message": "Invalid module : <Modules>"
}
]
}
Antwort bei Überprüfungsfehlern in der Übermittlung
{
"id": "{operationID}",
"createdTime": "Date Time",
"lastUpdatedTime": " Date Time ",
"status": "Failed",
"message": "Extension can't be published as there are submission validation failures. Fix these errors and try again later.",
"errorCode": "SubmissionValidationError",
"errors": ["{list of errors}"]
}
Antwort, wenn der Veröffentlichungsaufruf erfolgreich ist
{
"id": "{operationID}",
"createdTime": "Date Time",
"lastUpdatedTime": "Date Time",
"status": "Succeeded",
"message": "Successfully created submission with ID {submission.Id}",
"errorCode": "",
"errors": null
}
Antwort, wenn der Veröffentlichungsaufruf mit einem nicht wiederherstellbaren Fehler fehlschlägt
{
"id": "{operationID}",
"createdTime": "Date Time",
"lastUpdatedTime": " Date Time ",
"status": "Failed",
"message": "An error occurred while performing the operation",
"errorCode": null,
"errors": null
}
Antwort, wenn der Veröffentlichungsaufruf mit einem unerwarteten Fehler fehlschlägt
{
"id": "{operationID}",
"message": "An error occurred while processing the request. Please contact support Correlation ID: {operationID} Timestamp: {timeStamp}",
}
Antwortheader
Keine.
Statuscodes
Diese API verfügt über die folgenden erwarteten status Codes.
| HTTP-Statuscode | Beschreibung |
|---|---|
| 200 | Die Anforderung ist OK. |
| 4XX | Weitere Informationen finden Sie weiter unten unter Fehlercodes. |
| 5XX | Weitere Informationen finden Sie weiter unten unter Fehlercodes. |
Siehe auch:
- Überprüfen der Veröffentlichungs-status unter Verwenden der REST-API zum Aktualisieren von Microsoft Edge-Add-Ons.
Fehlercodes
Hier finden Sie eine Liste allgemeiner Fehlercodes und mögliche Gründe. Eine vollständige Liste finden Sie unter Partner Center-REST-Fehlercodes oder Liste der HTTP-status-Codes.
4xx: Clientfehler
| Nachricht | Beschreibung | Beispielszenario |
|---|---|---|
| 400 Ungültige Anforderung | Der Server hat die Anforderung nicht verstanden. | Es ist kein Paket (ZIP-Datei) im Text vorhanden. Oder der Header fehlt, Content-Type oder sein Wert ist falsch. |
| 401 Nicht autorisiert | Die Anforderungsseite benötigt eine Autorisierung. | Das Authentifizierungstoken fehlt, ist abgelaufen oder ungültig. |
| 404 Nicht gefunden | Der Server kann die angeforderte Seite nicht finden. | Die angegebene Produkt-ID oder Vorgangs-ID verfügt nicht über eine gültige GUID, ist ungültig oder gehört nicht zum Entwickler, der die Anforderung stellt. |
| 408 Anfrage timeout | Die Anforderung hat länger gedauert, als der Server darauf vorbereitet war. | Beim Hochladen eines Pakets ist ein Timeout aufgetreten. |
| 429 Zu viele Anforderungen | Vom Benutzer wurden zu viele Anforderungen gesendet. | Zu viele Anforderungen wurden gesendet und gedrosselt. |
5xx: Serverfehler
| Nachricht | Beschreibung | Beispielszenario |
|---|---|---|
| Interner Serverfehler 500 | Die Anforderung wurde nicht abgeschlossen. | Der Server hat eine unerwartete Bedingung erfüllt. |
Siehe auch
- Verwenden der REST-API zum Aktualisieren von Microsoft Edge-Add-Ons
- Partner Center-REST-Fehlercodes in der Partner Center-Dokumentation.
- Liste der HTTP-status Codes bei Wikipedia.