Referência da API da Chrome Web Store

Esta referência descreve os métodos e a representação de recursos disponíveis para a API Publishing da Chrome Web Store. Cada tipo de recurso tem uma ou mais representações de dados e um ou mais métodos. Consulte Como usar a API Publish da Chrome Web Store para ver os detalhes de implementação.

Itens

Para saber mais sobre o recurso Itens, consulte a representação do recurso. Os URIs são relativos a https://www.googleapis.com, a menos que indicado de outra forma

Operação Solicitação HTTP Descrição
get GET
/chromewebstore/v1.1/items/itemId 		Recebe um item da Chrome Web Store. Forneça projection="DRAFT" no URL (diferencia maiúsculas de minúsculas).
inserir POST
/upload/chromewebstore/v1.1/items 		Insere um novo item.
publish POST
/chromewebstore/v1.1/
items/itemId/publish 		Publica um item.

O parâmetro de consulta publishTarget opcional especifica como o item será publicado. Os valores válidos são "trustedTesters" e "default".
update PUT
/upload/chromewebstore/v1.1/
items/itemId

e

PUT
/items/itemId 		Atualiza um item existente.

Representação de recurso

{
  "kind": "chromewebstore#item",
  "id": string,
  "publicKey": string,
  "uploadState": string,
  "itemError": [
    (value)
  ]
}
Nome da propriedadeValorDescrição
idstringID exclusivo do item.
itemError[]listDetalhe o status legível da operação, somente em inglês. As mesmas mensagens de erro são exibidas quando você faz upload do seu app na Chrome Web Store.
kindstringIdentifica esse recurso como um item. Valor: a string fixa "chromewebstore#item".
publicKeystringChave pública deste item.
uploadStatestringStatus da operação.

Estes são os valores aceitáveis:
  • "FAILURE"
  • "IN_PROGRESS"
  • "NOT_FOUND"
  • "SUCCESS"

Get

Recebe um item da Chrome Web Store. Forneça projection="DRAFT" (diferencia maiúsculas de minúsculas) como um parâmetro de URL.

Solicitação

Solicitação HTTP

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

Parâmetros

Nome do parâmetroValorDescrição
Parâmetros de caminho
itemIdstringIdentificador exclusivo que representa o app, a extensão ou o tema do Chrome.
Parâmetros de consulta opcionais
projectionstringDetermina qual subconjunto das informações do item será retornado.

Os valores aceitáveis são:
  • "DRAFT": as informações de retorno extraídas do rascunho atual.
  • "PUBLISHED": as informações de retorno extraídas do rascunho do item publicado.
No momento, só há suporte para "DRAFT".

Autorização

Essa solicitação requer autorização com o escopo a seguir.

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

O URL acima é usado como o parâmetro de escopo ao gerar um token de acesso. Veja mais detalhes sobre autorização e autenticação da API na documentação do OAuth 2.0.

Corpo da solicitação

Não forneça um corpo de solicitação com este método.

Resposta

Se for bem-sucedido, esse método retornará um recurso Itens no corpo da resposta.

Inserir

Insere um novo item.

Esse método aceita um URI de upload e aceita mídias enviadas.

Solicitação

Solicitação HTTP

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

Parâmetros

Nome do parâmetroValorDescrição
Parâmetros de consulta obrigatórios
uploadTypestringO tipo de solicitação de upload para o URI /upload. O único valor aceito é media: um upload simples dos dados de mídia.
Parâmetros de consulta opcionais
publisherEmailstringO e-mail do editor que é o proprietário dos itens. O padrão é o endereço de e-mail do autor da chamada.

Autorização

Essa solicitação requer autorização com o escopo a seguir.

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

O URL acima é usado como o parâmetro de escopo ao gerar um token de acesso. Veja mais detalhes sobre autorização e autenticação da API na documentação do OAuth 2.0.

Corpo da solicitação

Não forneça um corpo de solicitação com este método.

Resposta

Se for bem-sucedido, esse método retornará um recurso Itens no corpo da resposta.

Publicar

Publica um item. Forneça o publishTarget definido no URL (diferencia maiúsculas de minúsculas): publishTarget = "confiávelTesters" ou publishTarget = "padrão".

Solicitação

Solicitação HTTP

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

Parâmetros

Nome do parâmetroValorDescrição
Parâmetros de caminho
itemIdstringID do item a ser publicado.
Parâmetros de consulta opcionais
publishTargetstringInforme o publishTarget definido no URL (diferencia maiúsculas de minúsculas): publishTarget="trustedTesters" ou publishTarget="default". O padrão é publishTarget="default".

Corpo da solicitação

No corpo da solicitação, também é possível fornecer dados com a seguinte estrutura:

JSON

{
  "target": string
}
Nome da propriedadeValorDescrição
targetstringO destino de publicação desta operação de publicação. Isso é o mesmo que usar publishTarget como um parâmetro de consulta de URL. O valor da string pode ser target="trustTesters" ou target="default". O valor padrão, se nenhum for fornecido, será target="default". Recomendamos usar o parâmetro de consulta de URL para especificar o valor.

Autorização

Essa solicitação requer autorização com o escopo a seguir.

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

O URL acima é usado como o parâmetro de escopo ao gerar um token de acesso. Veja mais detalhes sobre autorização e autenticação da API na documentação do OAuth 2.0.

Resposta

Se for bem-sucedido, esse método retornará um corpo de resposta com esta estrutura:

{
  "kind": "chromewebstore#item",
  "item_id": string,
  "status": [
    string
  ],
  "statusDetail": [
    string
  ]
}
Nome da propriedadeValorDescrição
kindstringO valor da string estática é sempre "chromewebstore#item".
item_idstringID desse item.
status[]listO código de status desta operação de publicação. Ela pode conter vários elementos da seguinte lista: OK, NOT_AUTHORIZED, INVALID_DEVELOPER, DEVELOPER_NO_OWNERSHIP, DEVELOPER_SUSPENDED, ITEM_NOT_FOUND, ITEM_PENDING_REVIEW, ITEM_TAKEN_DOWN e PUBLISHER_SUSPENDED.
statusDetail[]listExplicação detalhada do código de status acima compreensível por humanos.

Atualizar

Atualiza um item existente.

Esse método aceita um URI de upload e aceita mídias enviadas.

Solicitação

Solicitação HTTP

Esse método oferece a funcionalidade de upload de mídia usando dois URIs diferentes.

  • URI de upload para solicitações de upload de mídia:

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

  • URI de metadados, para solicitações somente de metadados:

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

Parâmetros

Nome do parâmetroValorDescrição
Parâmetros de caminho
itemIdstringID do item a ser enviado.
Parâmetros de consulta obrigatórios
uploadTypestringO tipo de solicitação de upload para o URI /upload. Os valores aceitáveis são: media: upload simples. Faça upload apenas da mídia, sem metadados.

Corpo da solicitação

No corpo da solicitação, informe um recursoItems como os metadados.

Autorização

Essa solicitação requer autorização com o escopo a seguir.

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

O URL acima é usado como o parâmetro de escopo ao gerar um token de acesso. Veja mais detalhes sobre autorização e autenticação da API na documentação do OAuth 2.0.

Resposta

Se for bem-sucedido, esse método retornará um recurso Itens no corpo da resposta.