Chrome Web Store API-Referenz

In dieser Referenz werden die Methoden und die Ressourcendarstellung beschrieben, die für die Chrome Web Store Publish API verfügbar sind. Jeder Ressourcentyp hat eine oder mehrere Datendarstellungen und eine oder mehrere Methoden. Einzelheiten zur Implementierung finden Sie unter Chrome Web Store Publish API verwenden.

Elemente

Ausführliche Informationen zu Ressourcen vom Typ "Items" erhalten Sie in der Ressourcendarstellung. Sofern nicht anders angegeben, beziehen sich die URIs auf https://www.googleapis.com.

Vorgang HTTP-Anfrage Beschreibung
Erhalten GET
/chromewebstore/v1.1/items/itemId
Ruft einen Chrome Web Store-Artikel ab Geben Sie projection="DRAFT" in der URL an (Groß-/Kleinschreibung beachten).
einfügen POST
/upload/chromewebstore/v1.1/items
Fügt ein neues Element ein.
publish POST
/chromewebstore/v1.1/
items/itemId/publish
Veröffentlicht ein Element.

Der optionale publishTarget-Abfrageparameter gibt an, wie das Element veröffentlicht wird. Gültige Werte sind "trustedTesters" und "default".
aktualisieren PUT
/upload/chromewebstore/v1.1/
items/itemId


und

PUT
/items/itemId
Aktualisiert ein vorhandenes Element

Ressourcendarstellung

{
  "kind": "chromewebstore#item",
  "id": string,
  "publicKey": string,
  "uploadState": string,
  "itemError": [
    (value)
  ]
}
Property-NameWertBeschreibung
idStringEindeutige ID des Artikels
itemError[]listGeben Sie den menschenlesbaren Status des Vorgangs an (nur auf Englisch). Dieselben Fehlermeldungen werden angezeigt, wenn Sie Ihre Anwendung in den Chrome Web Store hochladen.
kindStringKennzeichnet diese Ressource als Element. Wert: der feste String "chromewebstore#item".
publicKeyStringÖffentlicher Schlüssel dieses Elements
uploadStateStringStatus des Vorgangs.

Zulässige Werte sind:
  • "FAILURE"
  • "IN_PROGRESS"
  • "NOT_FOUND"
  • "SUCCESS"

Get

Ruft einen Chrome Web Store-Artikel ab Geben Sie projection="DRAFT" als URL-Parameter an (Groß-/Kleinschreibung beachten).

Anfragen

HTTP-Anfrage

GET https://www.googleapis.com/chromewebstore/v1.1/items/itemId

Parameter

ParameternameWertBeschreibung
Pfadparameter
itemIdStringEindeutige Kennung für die Chrome-App, die Chrome-Erweiterung oder das Chrome-Design.
Optionale Abfrageparameter
projectionStringBestimmt, welche Teilmenge der Artikelinformationen zurückgegeben werden soll.

Zulässige Werte sind:
  • DRAFT“: Gibt Informationen zurück, die aus dem aktuellen Entwurf extrahiert wurden.
  • PUBLISHED“: Gibt Informationen zurück, die aus dem veröffentlichten Elemententwurf extrahiert wurden.
Beachten Sie, dass derzeit nur "DRAFT" unterstützt wird.

Autorisierung

Diese Anfrage erfordert eine Autorisierung im folgenden Bereich.

https://www.googleapis.com/auth/chromewebstore.readonly

Die obige URL wird beim Generieren eines Zugriffstokens als Bereichsparameter verwendet. Weitere Informationen zur API-Autorisierung und -Authentifizierung finden Sie in der OAuth 2.0-Dokumentation.

Anfragetext

Mit dieser Methode keinen Anfragetext bereitstellen.

Antwort

Wenn der Vorgang erfolgreich ist, wird mit dieser Methode eine Elementressource im Antworttext zurückgegeben.

Einfügen

Fügt ein neues Element ein.

Diese Methode unterstützt einen Upload-URI und akzeptiert hochgeladene Medien.

Anfragen

HTTP-Anfrage

POST https://www.googleapis.com/upload/chromewebstore/v1.1/items

Parameter

ParameternameWertBeschreibung
Erforderliche Abfrageparameter
uploadTypeStringDer Typ der Uploadanfrage an den /upload-URI. Der einzige zulässige Wert ist media: ein einfacher Upload der Mediendaten.
Optionale Abfrageparameter
publisherEmailStringDie E-Mail-Adresse des Publishers, dem die Artikel gehören. Die Standardeinstellung ist die E-Mail-Adresse des Anrufers.

Autorisierung

Diese Anfrage erfordert eine Autorisierung im folgenden Bereich.

https://www.googleapis.com/auth/chromewebstore

Die obige URL wird beim Generieren eines Zugriffstokens als Bereichsparameter verwendet. Weitere Informationen zur API-Autorisierung und -Authentifizierung finden Sie in der OAuth 2.0-Dokumentation.

Anfragetext

Mit dieser Methode keinen Anfragetext bereitstellen.

Antwort

Wenn der Vorgang erfolgreich ist, wird mit dieser Methode eine Elementressource im Antworttext zurückgegeben.

Veröffentlichen

Es wird ein Element veröffentlicht. Geben Sie das in der URL definierte „publishTarget“ an (Groß-/Kleinschreibung beachten): publishTarget = "trustedTesters" oderpublishTarget = "default".

Anfragen

HTTP-Anfrage

POST https://www.googleapis.com/chromewebstore/v1.1/items/itemId/publish

Parameter

ParameternameWertBeschreibung
Pfadparameter
itemIdStringDie ID des zu veröffentlichenden Artikels.
Optionale Abfrageparameter
publishTargetStringGeben Sie die definierte publishTarget in der URL an (Groß-/Kleinschreibung beachten): publishTarget="trustedTesters" oder publishTarget="default". Die Standardeinstellung ist publishTarget="default".

Anfragetext

Im Anfragetext können Sie optional Daten mit der folgenden Struktur angeben:

JSON

{
  "target": string
}
Property-NameWertBeschreibung
targetstringDas Veröffentlichungsziel dieses Veröffentlichungsvorgangs. Dies entspricht der Verwendung von „publishTarget“ als URL-Suchparameter. Der Stringwert kann entweder target="trustedTesters" oder target="default" sein. Wenn kein Wert angegeben wird, lautet der Standardwert target="default". Es wird empfohlen, den Wert mit dem URL-Suchparameter anzugeben.

Autorisierung

Diese Anfrage erfordert eine Autorisierung im folgenden Bereich.

https://www.googleapis.com/auth/chromewebstore

Die obige URL wird beim Generieren eines Zugriffstokens als Bereichsparameter verwendet. Weitere Informationen zur API-Autorisierung und -Authentifizierung finden Sie in der OAuth 2.0-Dokumentation.

Antwort

Bei Erfolg gibt diese Methode einen Antworttext mit der folgenden Struktur zurück:

{
  "kind": "chromewebstore#item",
  "item_id": string,
  "status": [
    string
  ],
  "statusDetail": [
    string
  ]
}
Name der EigenschaftWertBeschreibung
kindstringDer statische Stringwert ist immer "chromewebstore#item".
item_idstringDie ID dieses Artikels.
status[]listDer Statuscode dieses Veröffentlichungsvorgangs. Es kann mehrere Elemente aus der folgenden Liste enthalten: OK, NOT_AUTHORIZED, INVALID_DEVELOPER, DEVELOPER_NO_OWNERSHIP, DEVELOPER_SUSPENDED, ITEM_NOT_FOUND, ITEM_PENDING_REVIEW, ITEM_TAKEN_DOWN, PUBLISHER_SUSPENDED.
statusDetail[]listDetaillierte, für Menschen verständliche Erklärung des obigen Statuscodes.

Aktualisieren

Aktualisiert einen vorhandenen Artikel

Diese Methode unterstützt einen Upload-URI und akzeptiert hochgeladene Medien.

Anfragen

HTTP-Anfrage

Diese Methode bietet Funktionen zum Hochladen von Medien über zwei separate URIs.

  • Upload-URI für Medienuploadanfragen:

    PUT https://www.googleapis.com/upload/chromewebstore/v1.1/items/itemId
    
  • Metadaten-URI für Nur-Metadaten-Anfragen:

    PUT https://www.googleapis.com/chromewebstore/v1.1/items/itemId
    

Parameter

ParameternameWertBeschreibung
Pfadparameter
itemIdstringDie ID des hochzuladenden Artikels.
Erforderliche Abfrageparameter
uploadTypestringDer Typ der Uploadanfrage an den /upload-URI. Zulässige Werte sind: media: Einfacher Upload. Laden Sie nur die Medien ohne Metadaten hoch.

Anfragetext

Geben Sie im Anfragetext eine Elementressource als Metadaten an.

Autorisierung

Diese Anfrage erfordert eine Autorisierung im folgenden Bereich.

https://www.googleapis.com/auth/chromewebstore

Die obige URL wird beim Generieren eines Zugriffstokens als Bereichsparameter verwendet. Weitere Informationen zur API-Autorisierung und -Authentifizierung finden Sie in der OAuth 2.0-Dokumentation.

Antwort

Wenn der Vorgang erfolgreich ist, wird mit dieser Methode eine Elementressource im Antworttext zurückgegeben.