En esta referencia, se describen los métodos y la representación de recursos disponibles para la API de publicación de Chrome Web Store. Cada tipo de recurso tiene una o más representaciones de datos y uno o más métodos. Consulta Cómo usar la API de publicación de Chrome Web Store para obtener detalles sobre la implementación.
Ítems
Para obtener detalles sobre los recursos de los elementos, consulta la representación de recursos. Los URI se relacionan con https://www.googleapis.com, a menos que se indique lo contrario.
Operación | Solicitud HTTP | Descripción |
---|---|---|
obtener |
GET/chromewebstore/v1.1/items/itemId
|
Obtiene un elemento de Chrome Web Store. Proporciona projection="DRAFT" en la URL (distingue mayúsculas de minúsculas). |
insertar |
POST/upload/chromewebstore/v1.1/items
|
Inserta un nuevo elemento. |
publish |
POST/chromewebstore/v1.1/
|
Publica un elemento. El parámetro de consulta opcional publishTarget especifica cómo se publicará el elemento. Los valores válidos son "trustedTesters" y "default" .
|
actualizar |
PUT/upload/chromewebstore/v1.1/ y PUT /items/itemId
|
Actualiza un elemento existente. |
Representación de recursos
{
"kind": "chromewebstore#item",
"id": string,
"publicKey": string,
"uploadState": string,
"itemError": [
(value)
]
}
Nombre de la propiedad | Valor | Descripción |
---|---|---|
id | cadena | Es el ID único del artículo. |
itemError[] | list | Detalla el estado de la operación en lenguaje natural. Solo en inglés. Se muestran los mismos mensajes de error cuando subes tu aplicación a Chrome Web Store. |
kind | cadena | Identifica este recurso como un elemento. Valor: La string fija "chromewebstore#item" . |
publicKey | cadena | Clave pública de este elemento. |
uploadState | cadena | Es el estado de la operación. Los valores aceptables son los siguientes:
|
Obtener
Obtiene un elemento de Chrome Web Store. Proporciona projection="DRAFT"
(distingue mayúsculas de minúsculas) como un parámetro de URL.
Solicitud
Solicitud HTTP
GET https://www.googleapis.com/chromewebstore/v1.1/items/itemId
Parámetros
Nombre del parámetro | Valor | Descripción |
---|---|---|
Parámetros de ruta de acceso | ||
itemId | cadena | Es el identificador único que representa la app de Chrome, la extensión de Chrome o el tema de Chrome. |
Parámetros de consulta opcionales | ||
projection | cadena | Determina qué subconjunto de la información del artículo se mostrará. Los valores aceptables son los siguientes:
"DRAFT" . |
Autorización
Esta solicitud requiere autorización con el siguiente alcance.
https://www.googleapis.com/auth/chromewebstore.readonly
La URL anterior se usa como parámetro de alcance cuando se genera un token de acceso. Para obtener más detalles sobre la autorización y autenticación de la API, consulta la documentación de OAuth 2.0.
Cuerpo de la solicitud
No proporciones un cuerpo de solicitud con este método.
Respuesta
Si se aplica correctamente, este método muestra un recurso de elementos en el cuerpo de la respuesta.
Insertar
Inserta un elemento nuevo.
Este método admite un URI de carga y acepta contenido multimedia subido.
Solicitud
Solicitud HTTP
POST https://www.googleapis.com/upload/chromewebstore/v1.1/items
Parámetros
Nombre del parámetro | Valor | Descripción |
---|---|---|
Parámetros de consulta obligatorios | ||
uploadType | cadena | El tipo de solicitud de carga para el URI /upload. El único valor aceptado es media , que es una carga simple de los datos multimedia. |
Parámetros de consulta opcionales | ||
publisherEmail | cadena | Corresponde al correo electrónico del publicador propietario de los elementos. La configuración predeterminada es la dirección de correo electrónico del emisor. |
Autorización
Esta solicitud requiere autorización con el siguiente alcance.
https://www.googleapis.com/auth/chromewebstore
La URL anterior se usa como parámetro de alcance cuando se genera un token de acceso. Para obtener más detalles sobre la autorización y autenticación de la API, consulta la documentación de OAuth 2.0.
Cuerpo de la solicitud
No proporciones un cuerpo de solicitud con este método.
Respuesta
Si se aplica correctamente, este método muestra un recurso de elementos en el cuerpo de la respuesta.
Publicar
Publica un elemento. Proporciona el elemento publishTarget definido en la URL (distingue mayúsculas de minúsculas): publishTarget = "trustedTesters" or publishTarget = "default".
Solicitud
Solicitud HTTP
POST https://www.googleapis.com/chromewebstore/v1.1/items/itemId/publish
Parámetros
Nombre del parámetro | Valor | Descripción |
---|---|---|
Parámetros de ruta de acceso | ||
itemId | cadena | Es el ID del elemento que se publicará. |
Parámetros de consulta opcionales | ||
publishTarget | cadena | Proporciona un publishTarget definido en la URL (distingue mayúsculas de minúsculas): publishTarget="trustedTesters" o publishTarget="default" . La configuración predeterminada es publishTarget="default" . |
Cuerpo de la solicitud
En el cuerpo de la solicitud, puedes proporcionar datos con la siguiente estructura de manera opcional:
JSON
{
"target": string
}
Nombre de la propiedad | Valor | Descripción |
---|---|---|
target | string | Es el destino de publicación de esta operación de publicación. Esto es lo mismo que usar publishTarget como parámetro de consulta de URL. El valor de la string puede ser target="trustedTesters" o target="default". El valor predeterminado, si no se proporciona ninguno, es target="default". Se recomienda utilizar el parámetro de consulta de URL para especificar el valor. |
Autorización
Esta solicitud requiere autorización con el siguiente alcance.
https://www.googleapis.com/auth/chromewebstore
La URL anterior se usa como parámetro de alcance cuando se genera un token de acceso. Para obtener más detalles sobre la autorización y autenticación de la API, consulta la documentación de OAuth 2.0.
Respuesta
Si se aplica correctamente, este método muestra un cuerpo de respuesta con la siguiente estructura:
{
"kind": "chromewebstore#item",
"item_id": string,
"status": [
string
],
"statusDetail": [
string
]
}
Nombre de la propiedad | Valor | Descripción |
---|---|---|
kind | string | El valor de la string estática es siempre "chromewebstore#item" . |
item_id | string | Es el ID de este artículo. |
status[] | list | Es el código de estado de esta operación de publicación. Puede contener varios elementos de la siguiente lista: OK , NOT_AUTHORIZED , INVALID_DEVELOPER , DEVELOPER_NO_OWNERSHIP , DEVELOPER_SUSPENDED , ITEM_NOT_FOUND , ITEM_PENDING_REVIEW , ITEM_TAKEN_DOWN , PUBLISHER_SUSPENDED . |
statusDetail[] | list | Explicación detallada y comprensible del código de estado anterior. |
Actualizar
Actualiza un elemento existente.
Este método admite un URI de carga y acepta contenido multimedia subido.
Solicitud
Solicitud HTTP
Este método proporciona la funcionalidad de carga de contenido multimedia a través de dos URI independientes.
URI de carga para solicitudes de carga de contenido multimedia:
PUT https://www.googleapis.com/upload/chromewebstore/v1.1/items/itemId
URI de metadatos, para solicitudes solo de metadatos:
PUT https://www.googleapis.com/chromewebstore/v1.1/items/itemId
Parámetros
Nombre del parámetro | Valor | Descripción |
---|---|---|
Parámetros de ruta de acceso | ||
itemId | string | El ID del elemento que se subirá. |
Parámetros de consulta obligatorios | ||
uploadType | string | El tipo de solicitud de carga para el URI /upload. Los valores aceptables son los siguientes: media : Carga simple. Sube solo el contenido multimedia, sin metadatos. |
Cuerpo de la solicitud
En el cuerpo de la solicitud, proporciona un recurso de elementos como metadatos.
Autorización
Esta solicitud requiere autorización con el siguiente alcance.
https://www.googleapis.com/auth/chromewebstore
La URL anterior se usa como parámetro de alcance cuando se genera un token de acceso. Para obtener más detalles sobre la autorización y autenticación de la API, consulta la documentación de OAuth 2.0.
Respuesta
Si se aplica correctamente, este método muestra un recurso de elementos en el cuerpo de la respuesta.