W tym artykule opisano metody i reprezentację zasobów dostępne w interfejsie Chrome Web Store Publish API. Każdy typ zasobu ma co najmniej 1 reprezentację danych i co najmniej 1 metodę. Szczegóły implementacji znajdziesz w artykule Używanie interfejsu Chrome Web Store Publish API.
Elementy
Szczegółowe informacje o zasobie elementów znajdziesz w opisie reprezentacji zasobu. Identyfikatory URI są względne wobec https://www.googleapis.com, chyba że zaznaczono inaczej
| Operacja | Żądanie HTTP | Opis |
|---|---|---|
| pobierz |
GET/chromewebstore/v1.1/items/itemId
|
Pobiera produkt z Chrome Web Store. Podaj projection="DRAFT" w adresie URL (wielkość liter ma znaczenie). |
| wstaw |
POST/upload/chromewebstore/v1.1/items
|
Wstawia nowy element. |
| publish |
POST/chromewebstore/v1.1/
|
Publikuje element. Opcjonalny parametr zapytania publishTarget określa sposób publikacji elementu. Prawidłowe wartości to "trustedTesters" i "default".
|
| aktualizacja |
PUT/upload/chromewebstore/v1.1/i PUT /items/itemId
|
Aktualizuje istniejący element. |
Reprezentacja zasobu
{
"kind": "chromewebstore#item",
"id": string,
"publicKey": string,
"uploadState": string,
"itemError": [
(value)
]
}
| nazwa usługi, | Wartość | Opis |
|---|---|---|
id | ciąg znaków | Unikalny identyfikator elementu. |
itemError[] | lista | Szczegóły zrozumiałego dla człowieka stanu operacji, tylko w języku angielskim. Te same komunikaty o błędach wyświetlają się podczas przesyłania aplikacji do Chrome Web Store. |
kind | ciąg znaków | Identyfikuje zasób jako element. Wartość: ustalony ciąg znaków "chromewebstore#item". |
publicKey | ciąg znaków | Klucz publiczny tego elementu. |
uploadState | ciąg znaków | Stan operacji. Akceptowane wartości:
|
Pobierz
Pobiera produkt z Chrome Web Store. Podaj projection="DRAFT" (wielkość liter ma znaczenie) jako parametr adresu URL.
Prośba
Żądanie HTTP
GET https://www.googleapis.com/chromewebstore/v1.1/items/itemId
Parametry
| Nazwa parametru | Wartość | Opis |
|---|---|---|
| Parametry ścieżki | ||
itemId | ciąg znaków | Unikalny identyfikator reprezentujący aplikację Chrome, rozszerzenie do Chrome lub motyw Chrome. |
| Opcjonalne parametry zapytania | ||
projection | ciąg znaków | Określa podzbiór informacji o produktach do zwrócenia. Akceptowane wartości to:
"DRAFT". |
Upoważnienie
To żądanie wymaga autoryzacji z tego zakresu.
https://www.googleapis.com/auth/chromewebstore.readonly
Powyższy adres URL jest używany jako parametr zakresu podczas generowania tokena dostępu. Więcej informacji o autoryzacji i uwierzytelnianiu interfejsów API znajdziesz w dokumentacji protokołu OAuth 2.0.
Treść żądania
Nie podawaj treści żądania z tą metodą.
Odpowiedź
W przypadku powodzenia ta metoda zwraca w treści odpowiedzi zasób elementów.
Wstaw
Wstawia nowy element.
Ta metoda obsługuje identyfikator URI przesyłania i akceptuje przesłane multimedia.
Prośba
Żądanie HTTP
POST https://www.googleapis.com/upload/chromewebstore/v1.1/items
Parametry
| Nazwa parametru | Wartość | Opis |
|---|---|---|
| Wymagane parametry zapytania | ||
uploadType | ciąg znaków | Typ żądania przesłania do identyfikatora URI /upload. Jedyną akceptowaną wartością jest media, czyli proste przesyłanie danych o multimediach. |
| Opcjonalne parametry zapytania | ||
publisherEmail | ciąg znaków | Adres e-mail wydawcy, do którego należą produkty. Domyślnie jest to adres e-mail rozmówcy. |
Upoważnienie
To żądanie wymaga autoryzacji z tego zakresu.
https://www.googleapis.com/auth/chromewebstore
Powyższy adres URL jest używany jako parametr zakresu podczas generowania tokena dostępu. Więcej informacji o autoryzacji i uwierzytelnianiu interfejsów API znajdziesz w dokumentacji protokołu OAuth 2.0.
Treść żądania
Nie podawaj treści żądania z tą metodą.
Odpowiedź
W przypadku powodzenia ta metoda zwraca w treści odpowiedzi zasób elementów.
Opublikuj
Publikuje produkt. Podaj zdefiniowaną wartość publishTarget w adresie URL (wielkość liter ma znaczenie): publishTarget = "trustedTesters" lub publishTarget = "default".
Prośba
Żądanie HTTP
POST https://www.googleapis.com/chromewebstore/v1.1/items/itemId/publish
Parametry
| Nazwa parametru | Wartość | Opis |
|---|---|---|
| Parametry ścieżki | ||
itemId | ciąg znaków | Identyfikator elementu do opublikowania. |
| Opcjonalne parametry zapytania | ||
publishTarget | ciąg znaków | Podaj zdefiniowany element publishTarget w adresie URL (z uwzględnieniem wielkości liter): publishTarget="trustedTesters" lub publishTarget="default". Domyślna wartość to publishTarget="default". |
Treść żądania
W treści żądania możesz opcjonalnie dostarczyć dane o następującej strukturze:
JSON
{
"target": string
}
| nazwa usługi, | Wartość | Opis |
|---|---|---|
target | string | Miejsce docelowe tej operacji publikowania. Działa to tak samo jak stosowanie parametru publishTarget jako parametru zapytania w adresie URL. Wartością ciągu może być target="trustedTesters" lub target="default". Jeśli nie zostanie podana żadna wartość, domyślną wartością jest target="default". Zalecane użycie to użycie parametru zapytania adresu URL do określenia wartości. |
Upoważnienie
To żądanie wymaga autoryzacji z tego zakresu.
https://www.googleapis.com/auth/chromewebstore
Powyższy adres URL jest używany jako parametr zakresu podczas generowania tokena dostępu. Więcej informacji o autoryzacji i uwierzytelnianiu interfejsów API znajdziesz w dokumentacji protokołu OAuth 2.0.
Odpowiedź
Jeśli operacja się uda, metoda zwróci treść odpowiedzi w następującej strukturze:
{
"kind": "chromewebstore#item",
"item_id": string,
"status": [
string
],
"statusDetail": [
string
]
}
| nazwa usługi, | Wartość | Opis |
|---|---|---|
kind | string | Wartość statycznego ciągu znaków to zawsze "chromewebstore#item". |
item_id | string | Identyfikator tego produktu. |
status[] | list | Kod stanu tej operacji publikowania. Może zawierać wiele elementów z tej listy: OK, NOT_AUTHORIZED, INVALID_DEVELOPER, DEVELOPER_NO_OWNERSHIP, DEVELOPER_SUSPENDED, ITEM_NOT_FOUND, ITEM_PENDING_REVIEW, ITEM_TAKEN_DOWN, PUBLISHER_SUSPENDED. |
statusDetail[] | list | Szczegółowe, zrozumiałe dla człowieka wyjaśnienie powyższego kodu stanu. |
Aktualizuj
Aktualizuje istniejący produkt.
Ta metoda obsługuje identyfikator URI przesyłania i akceptuje przesłane multimedia.
Prośba
Żądanie HTTP
Ta metoda umożliwia przesyłanie multimediów za pomocą 2 osobnych identyfikatorów URI.
Identyfikator URI przesyłania dla żądań przesłania multimediów:
PUT https://www.googleapis.com/upload/chromewebstore/v1.1/items/itemIdIdentyfikator URI metadanych dla żądań samych metadanych:
PUT https://www.googleapis.com/chromewebstore/v1.1/items/itemId
Parametry
| Nazwa parametru | Wartość | Opis |
|---|---|---|
| Parametry ścieżki | ||
itemId | string | Identyfikator elementu do przesłania. |
| Wymagane parametry zapytania | ||
uploadType | string | Typ żądania przesłania do identyfikatora URI /upload. Akceptowane wartości: media – proste przesyłanie. Przesyłać tylko multimedia, bez metadanych. |
Treść żądania
W treści żądania jako metadane podaj zasób elementów.
Upoważnienie
To żądanie wymaga autoryzacji z tego zakresu.
https://www.googleapis.com/auth/chromewebstore
Powyższy adres URL jest używany jako parametr zakresu podczas generowania tokena dostępu. Więcej informacji o autoryzacji i uwierzytelnianiu interfejsów API znajdziesz w dokumentacji protokołu OAuth 2.0.
Odpowiedź
W przypadku powodzenia ta metoda zwraca w treści odpowiedzi zasób elementów.