Riferimento API del Chrome Web Store

Questo riferimento descrive i metodi e la rappresentazione delle risorse disponibili per l'API Chrome Web Store Publish. Ogni tipo di risorsa ha una o più rappresentazioni dei dati e uno o più metodi. Per i dettagli sull'implementazione, consulta Utilizzo dell'API Chrome Web Store Publish.

Elementi

Per i dettagli della risorsa elementi, consulta la rappresentazione delle risorse. Gli URI sono relativi a https://www.googleapis.com, se non diversamente specificato

Operazione Richiesta HTTP Descrizione
prendi GET
/chromewebstore/v1.1/items/itemId
Recupera un articolo del Chrome Web Store. Specifica projection="DRAFT" nell'URL (sensibile alle maiuscole).
inserisci POST
/upload/chromewebstore/v1.1/items
Inserisce un nuovo elemento.
publish POST
/chromewebstore/v1.1/
items/itemId/publish
Pubblica un elemento.

Il parametro di query facoltativo publishTarget specifica il modo in cui verrà pubblicato l'elemento. I valori validi sono "trustedTesters" e "default".
aggiornamento PUT
/upload/chromewebstore/v1.1/
items/itemId


e

PUT
/items/itemId
Consente di aggiornare un elemento esistente.

Rappresentazione delle risorse

{
  "kind": "chromewebstore#item",
  "id": string,
  "publicKey": string,
  "uploadState": string,
  "itemError": [
    (value)
  ]
}
Nome proprietàValoreDescrizione
idstringaID univoco dell'articolo.
itemError[]listSpecificare lo stato leggibile dell'operazione, solo in inglese. Gli stessi messaggi di errore vengono visualizzati quando carichi l'app sul Chrome Web Store.
kindstringaIdentifica questa risorsa come un elemento. Valore: la stringa fissa "chromewebstore#item".
publicKeystringaChiave pubblica di questo elemento.
uploadStatestringaStato dell'operazione.

I valori accettati sono:
  • "FAILURE"
  • "IN_PROGRESS"
  • "NOT_FOUND"
  • "SUCCESS"

Get

Recupera un articolo del Chrome Web Store. Specifica projection="DRAFT" (sensibile alle maiuscole) come parametro URL.

Richiesta

Richiesta HTTP

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

Parametri

Nome del parametroValoreDescrizione
Parametri del percorso
itemIdstringaIdentificatore univoco che rappresenta l'app, l'estensione di Chrome o il tema di Chrome.
Parametri di ricerca facoltativi
projectionstringaDetermina quale sottoinsieme di informazioni sugli articoli restituire.

I valori accettati sono:
  • "DRAFT": restituisci informazioni estratte dalla bozza corrente.
  • "PUBLISHED": restituisci informazioni estratte dalla bozza dell'articolo pubblicato.
Tieni presente che al momento è supportato solo "DRAFT".

Autorizzazione

Questa richiesta richiede l'autorizzazione con il seguente ambito.

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

L'URL sopra riportato viene utilizzato come parametro dell'ambito durante la generazione di un token di accesso. Per maggiori dettagli sull'autorizzazione e sull'autenticazione dell'API, consulta la documentazione relativa a OAuth 2.0.

Corpo della richiesta

Non fornire il corpo della richiesta con questo metodo.

Risposta

In caso di esito positivo, questo metodo restituisce una risorsaItems nel corpo della risposta.

Inserisci

Inserisce un nuovo elemento.

Questo metodo supporta un URI di caricamento e accetta i contenuti multimediali caricati.

Richiesta

Richiesta HTTP

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

Parametri

Nome del parametroValoreDescrizione
Parametri di ricerca obbligatori
uploadTypestringaIl tipo di richiesta di caricamento nell'URI /upload. L'unico valore accettato è media: un semplice caricamento dei dati multimediali.
Parametri di ricerca facoltativi
publisherEmailstringaL'email del publisher proprietario degli articoli. Il valore predefinito è l'indirizzo email del chiamante.

Autorizzazione

Questa richiesta richiede l'autorizzazione con il seguente ambito.

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

L'URL sopra riportato viene utilizzato come parametro dell'ambito durante la generazione di un token di accesso. Per maggiori dettagli sull'autorizzazione e sull'autenticazione dell'API, consulta la documentazione relativa a OAuth 2.0.

Corpo della richiesta

Non fornire il corpo della richiesta con questo metodo.

Risposta

In caso di esito positivo, questo metodo restituisce una risorsaItems nel corpo della risposta.

Pubblica

Pubblica un elemento. Fornisci publishTarget definito nell'URL (sensibile alle maiuscole): publishTarget = "trustedTesters" o publishTarget = "default".

Richiesta

Richiesta HTTP

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

Parametri

Nome del parametroValoreDescrizione
Parametri del percorso
itemIdstringaL'ID dell'elemento da pubblicare.
Parametri di ricerca facoltativi
publishTargetstringaFornisci il valore publishTarget definito nell'URL (sensibile alle maiuscole): publishTarget="trustedTesters" o publishTarget="default". Il valore predefinito è publishTarget="default".

Corpo della richiesta

Nel corpo della richiesta, puoi facoltativamente fornire dati con la seguente struttura:

JSON

{
  "target": string
}
Nome proprietàValoreDescrizione
targetstringIl target di pubblicazione di questa operazione di pubblicazione. Equivale a utilizzare publishTarget come parametro di query dell'URL. Il valore della stringa può essere target="trustedTesters" o target="default". Il valore predefinito, se non viene specificato nessuno, è target="default". L'utilizzo consigliato è quello di utilizzare il parametro di query dell'URL per specificare il valore.

Autorizzazione

Questa richiesta richiede l'autorizzazione con il seguente ambito.

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

L'URL sopra riportato viene utilizzato come parametro dell'ambito durante la generazione di un token di accesso. Per maggiori dettagli sull'autorizzazione e sull'autenticazione dell'API, consulta la documentazione relativa a OAuth 2.0.

Risposta

In caso di esito positivo, questo metodo restituisce un corpo della risposta con la seguente struttura:

{
  "kind": "chromewebstore#item",
  "item_id": string,
  "status": [
    string
  ],
  "statusDetail": [
    string
  ]
}
Nome proprietàValoreDescrizione
kindstringIl valore della stringa statico è sempre "chromewebstore#item".
item_idstringL'ID di questo articolo.
status[]listIl codice di stato di questa operazione di pubblicazione. Può contenere più elementi del seguente elenco: OK, NOT_AUTHORIZED, INVALID_DEVELOPER, DEVELOPER_NO_OWNERSHIP, DEVELOPER_SUSPENDED, ITEM_NOT_FOUND, ITEM_PENDING_REVIEW, ITEM_TAKEN_DOWN e PUBLISHER_SUSPENDED.
statusDetail[]listSpiegazione dettagliata e comprensibile dell'utente del codice di stato riportato sopra.

Aggiorna

Consente di aggiornare un elemento esistente.

Questo metodo supporta un URI di caricamento e accetta i contenuti multimediali caricati.

Richiesta

Richiesta HTTP

Questo metodo fornisce funzionalità di caricamento di contenuti multimediali tramite due URI separati.

  • URI di caricamento, per le richieste di caricamento di contenuti multimediali:

    PUT https://www.googleapis.com/upload/chromewebstore/v1.1/items/itemId
    
  • URI metadati, per richieste di soli metadati:

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

Parametri

Nome del parametroValoreDescrizione
Parametri del percorso
itemIdstringL'ID dell'articolo da caricare.
Parametri di ricerca obbligatori
uploadTypestringIl tipo di richiesta di caricamento nell'URI /upload. I valori accettati sono: media - Caricamento semplice. Carica solo i contenuti multimediali, senza metadati.

Corpo della richiesta

Nel corpo della richiesta, fornisci una risorsa Elementi come metadati.

Autorizzazione

Questa richiesta richiede l'autorizzazione con il seguente ambito.

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

L'URL sopra riportato viene utilizzato come parametro dell'ambito durante la generazione di un token di accesso. Per maggiori dettagli sull'autorizzazione e sull'autenticazione dell'API, consulta la documentazione relativa a OAuth 2.0.

Risposta

In caso di esito positivo, questo metodo restituisce una risorsaItems nel corpo della risposta.