Cette page a été traduite par l'API Cloud Translation.

Documentation de référence de l'API Chrome Web Store

Ce document de référence décrit les méthodes et la représentation des ressources disponibles pour l'API Publishing du Chrome Web Store. Chaque type de ressource comporte une ou plusieurs représentations de données ainsi qu'une ou plusieurs méthodes. Pour en savoir plus sur l'implémentation, consultez Utiliser l'API Chrome Web Store Publish.

Éléments

Pour en savoir plus sur la ressource "Items", consultez la représentation de la ressource. Sauf indication contraire, les URI sont relatifs à https://www.googleapis.com.

Opération	Requête HTTP	Description
obtenir	GET `/chromewebstore/v1.1/items/itemId`	Permet d'obtenir un article du Chrome Web Store. Indiquez `projection="DRAFT"` dans l'URL (sensible à la casse).
insérer	POST `/upload/chromewebstore/v1.1/items`	Insère un nouvel élément.
publish	POST `/chromewebstore/v1.1/ items/itemId/publish`	Publie un élément. Le paramètre de requête `publishTarget` facultatif spécifie la manière dont l'élément sera publié. Les valeurs valides sont `"trustedTesters"` et `"default"`.
mettre à jour	PUT `/upload/chromewebstore/v1.1/ items/itemId` et PUT `/items/itemId`	Met à jour un élément existant.

Représentation des ressources

{
  "kind": "chromewebstore#item",
  "id": string,
  "publicKey": string,
  "uploadState": string,
  "itemError": [
    (value)
  ]
}

Nom de propriété	Valeur	Description
`id`	string	Identifiant unique de l'article.
`itemError[]`	list	Détail de l'état de l'opération dans un format lisible, en anglais uniquement. Les mêmes messages d'erreur s'affichent lorsque vous importez votre application dans le Chrome Web Store.
`kind`	string	Identifie cette ressource en tant qu'élément. Valeur: chaîne fixe `"chromewebstore#item"`.
`publicKey`	string	Clé publique de cet élément.
`uploadState`	string	État de l'opération. Valeurs acceptées: "`FAILURE`" "`IN_PROGRESS`" "`NOT_FOUND`" "`SUCCESS`"

Télécharger

Permet d'obtenir un article du Chrome Web Store. Indiquez projection="DRAFT" (sensible à la casse) comme paramètre d'URL.

Requête

Requête HTTP

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

Paramètres

Nom du paramètre	Valeur	Description
Paramètres de chemin d'accès
`itemId`	string	Identifiant unique représentant l'application Chrome, l'extension Chrome ou le thème Chrome.
Paramètres de requête facultatifs
`projection`	string	Détermine le sous-ensemble d'informations sur les articles à renvoyer. Les valeurs acceptées sont les suivantes: "`DRAFT`": affiche les informations extraites du brouillon actuel. "`PUBLISHED`": renvoie les informations extraites du brouillon de l'article publié. Notez que seul `"DRAFT"` est accepté pour le moment.

Autorisation

Cette requête nécessite une autorisation ayant le champ d'application suivant.

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

L'URL ci-dessus est utilisée comme paramètre de champ d'application lors de la génération d'un jeton d'accès. Pour en savoir plus sur l'authentification et l'autorisation des API, consultez la documentation OAuth 2.0.

Corps de la requête

Ne spécifiez pas de corps de requête pour cette méthode.

Réponse

Lorsque cette méthode fonctionne, elle renvoie une ressource "Items" dans le corps de la réponse.

Insérer

Insère un nouvel élément.

Cette méthode accepte un URI d'importation et les médias importés.

Requête

Requête HTTP

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

Paramètres

Nom du paramètre	Valeur	Description
Paramètres de requête requis
`uploadType`	string	Type de requête d'importation envoyée à l'URI /upload. La seule valeur acceptée est `media`: simple importation des données multimédias.
Paramètres de requête facultatifs
`publisherEmail`	string	Adresse e-mail de l'éditeur propriétaire des articles. Par défaut, il s'agit de l'adresse e-mail de l'appelant.

Autorisation

Cette requête nécessite une autorisation ayant le champ d'application suivant.

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

Corps de la requête

Ne spécifiez pas de corps de requête pour cette méthode.

Réponse

Lorsque cette méthode fonctionne, elle renvoie une ressource "Items" dans le corps de la réponse.

Publier

Publie un élément. Définissez une valeur publishTarget dans l'URL (sensible à la casse): publishTarget = "trustedTesters" ou publishTarget = "default".

Requête

Requête HTTP

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

Paramètres

Nom du paramètre	Valeur	Description
Paramètres de chemin d'accès
`itemId`	string	ID de l'élément à publier.
Paramètres de requête facultatifs
`publishTarget`	string	Indiquez la valeur `publishTarget` définie dans l'URL (sensible à la casse): `publishTarget="trustedTesters"` ou `publishTarget="default"`. La valeur par défaut est `publishTarget="default"`.

Corps de la requête

Dans le corps de la requête, vous pouvez éventuellement fournir des données en respectant la structure suivante:

JSON

{
  "target": string
}

Nom de propriété	Valeur	Description
`target`	`string`	Cible de publication de cette opération de publication. Cela revient à utiliser publishTarget comme paramètre de requête d'URL. La valeur de la chaîne peut être target="trustedTesters" ou target="default". Si aucune valeur n'est fournie, la valeur par défaut est target="default". Nous vous recommandons d'utiliser le paramètre de requête d'URL pour spécifier la valeur.

Autorisation

Cette requête nécessite une autorisation ayant le champ d'application suivant.

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

Réponse

Si la requête aboutit, cette méthode renvoie un corps de réponse présentant la structure suivante :

{
  "kind": "chromewebstore#item",
  "item_id": string,
  "status": [
    string
  ],
  "statusDetail": [
    string
  ]
}

Nom de propriété	Valeur	Description
`kind`	`string`	La valeur de chaîne statique est toujours `"chromewebstore#item"`.
`item_id`	`string`	Identifiant de cet article.
`status[]`	`list`	Code d'état de cette opération de publication. Il peut contenir plusieurs éléments de la liste suivante: `OK`, `NOT_AUTHORIZED`, `INVALID_DEVELOPER`, `DEVELOPER_NO_OWNERSHIP`, `DEVELOPER_SUSPENDED`, `ITEM_NOT_FOUND`, `ITEM_PENDING_REVIEW`, `ITEM_TAKEN_DOWN`, `PUBLISHER_SUSPENDED`.
`statusDetail[]`	`list`	Explication détaillée et compréhensible du code d'état ci-dessus.

Mettre à jour

Met à jour un élément existant.

Cette méthode accepte un URI d'importation et les médias importés.

Requête

Requête HTTP

Cette méthode fournit une fonctionnalité d'importation de médias via deux URI distincts.

URI d'importation, pour les requêtes d'importation de médias:

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

URI de métadonnées, pour les requêtes ne contenant que des métadonnées:
```
PUT https://www.googleapis.com/chromewebstore/v1.1/items/itemId
```

Paramètres

Nom du paramètre	Valeur	Description
Paramètres de chemin d'accès
`itemId`	`string`	Identifiant de l'article à importer.
Paramètres de requête requis
`uploadType`	`string`	Type de requête d'importation envoyée à l'URI /upload. Valeurs acceptées : `media` : importation simple. Importez uniquement le contenu multimédia, sans métadonnées.

Corps de la requête

Dans le corps de la requête, indiquez une ressource "Items" en tant que métadonnées.

Autorisation

Cette requête nécessite une autorisation ayant le champ d'application suivant.

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

Réponse

Lorsque cette méthode fonctionne, elle renvoie une ressource "Items" dans le corps de la réponse.