Chrome Web Mağazası API Referansı

Bu referansta, Chrome Web Mağazası Yayınlama API'si için kullanılabilen yöntemler ve kaynak temsilleri açıklanmaktadır. Her kaynak türünde bir veya daha fazla veri temsili ve bir veya daha fazla yöntem bulunur. Uygulama ayrıntıları için Chrome Web Mağazası Publish API'sini kullanma başlıklı makaleye bakın.

Öğe sayısı

Öğe Kaynağı ayrıntıları için kaynak gösterimine bakın. URI'lar, aksi belirtilmedikçe https://www.googleapis.com ile ilişkilidir

İşlem HTTP isteği Açıklama
al GET
/chromewebstore/v1.1/items/itemId
Bir Chrome Web Mağazası öğesi alır. URL'de projection="DRAFT" sağlayın (büyük/küçük harfe duyarlı).
ekle POST
/upload/chromewebstore/v1.1/items
Yeni bir öğe ekler.
publish POST
/chromewebstore/v1.1/
items/itemId/publish
Bir öğe yayınlar.

İsteğe bağlı publishTarget sorgu parametresi, öğenin nasıl yayınlanacağını belirtir. Geçerli değerler "trustedTesters" ve "default"'dir.
güncelle PUT
/upload/chromewebstore/v1.1/
items/itemId


ve

PUT
/items/itemId
Mevcut bir öğeyi günceller.

Kaynak temsili

{
  "kind": "chromewebstore#item",
  "id": string,
  "publicKey": string,
  "uploadState": string,
  "itemError": [
    (value)
  ]
}
Mülk adıDeğerAçıklama
iddizeÖğenin benzersiz kimliği.
itemError[]listİşlemin kullanıcılar tarafından okunabilir durumunun ayrıntılarını (yalnızca İngilizce) belirtin. Uygulamanızı Chrome Web Mağazası'na yüklediğinizde aynı hata mesajları gösterilir.
kinddizeBu kaynağı öğe olarak tanımlar. Değer: "chromewebstore#item" sabit dizesi.
publicKeydizeBu öğenin ortak anahtarı.
uploadStatedizeİşlemin durumu.

Kabul edilebilir değerler şunlardır:
  • "FAILURE"
  • "IN_PROGRESS"
  • "NOT_FOUND"
  • "SUCCESS"

Get

Bir Chrome Web Mağazası öğesi alır. URL parametresi olarak projection="DRAFT" (büyük/küçük harfe duyarlı) değerini sağlayın.

İstek

HTTP isteği

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

Parametreler

Parametre adıDeğerAçıklama
Yol parametreleri
itemIddizeChrome uygulamasını, Chrome uzantısını veya Chrome temasını temsil eden benzersiz tanımlayıcı.
İsteğe bağlı sorgu parametreleri
projectiondizeDöndürülecek öğe bilgileri alt kümesini belirler.

Kabul edilebilir değerler şunlardır:
  • "DRAFT": Mevcut taslaktan çıkarılan bilgileri döndürür.
  • "PUBLISHED": Yayınlanan öğe taslağından çıkarılan bilgileri döndür.
Şu anda yalnızca "DRAFT" ürününün desteklendiğini unutmayın.

Yetkilendirme

Bu istek, aşağıdaki kapsamla yetkilendirme gerektiriyor.

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

Yukarıdaki URL, erişim jetonu oluşturulurken kapsam parametresi olarak kullanılır. API yetkilendirmesi ve kimlik doğrulaması hakkında daha fazla bilgi edinmek için OAuth 2.0 dokümanlarına bakın.

İstek içeriği

Bu yöntemle istek gövdesi sağlamayın.

Yanıt

Başarılı olursa bu yöntem, yanıt gövdesinde bir Öğeler kaynağı döndürür.

Ekle

Yeni bir item ekler.

Bu yöntem bir yükleme URI'sini destekler ve yüklenen medyayı kabul eder.

İstek

HTTP isteği

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

Parametreler

Parametre adıDeğerAçıklama
Gerekli sorgu parametreleri
uploadTypedize/upload URI'sine yükleme isteğinin türü. Kabul edilen tek değer media, yani medya verilerinin basit bir şekilde yüklenmesidir.
İsteğe bağlı sorgu parametreleri
publisherEmaildizeÖğelerin sahibi olan yayıncının e-posta adresi. Varsayılan olarak arayanın e-posta adresi kullanılır.

Yetkilendirme

Bu istek, aşağıdaki kapsamla yetkilendirme gerektiriyor.

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

Yukarıdaki URL, erişim jetonu oluşturulurken kapsam parametresi olarak kullanılır. API yetkilendirmesi ve kimlik doğrulaması hakkında daha fazla bilgi edinmek için OAuth 2.0 dokümanlarına bakın.

İstek içeriği

Bu yöntemle istek gövdesi sağlamayın.

Yanıt

Başarılı olursa bu yöntem, yanıt gövdesinde bir Öğeler kaynağı döndürür.

Yayınla

Bir öğe yayınlar. URL'de tanımlı publishTarget özelliğini sağlayın (büyük/küçük harfe duyarlı): publishTarget = "trustedTesters" veya publishTarget = "default".

İstek

HTTP isteği

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

Parametreler

Parametre adıDeğerAçıklama
Yol parametreleri
itemIddizeYayınlanacak öğenin kimliği.
İsteğe bağlı sorgu parametreleri
publishTargetdizeURL'de tanımlı publishTarget değerini sağlayın (büyük/küçük harfe duyarlı): publishTarget="trustedTesters" veya publishTarget="default". Varsayılan olarak publishTarget="default" değerine ayarlanır.

İstek içeriği

İstek gövdesinde, isteğe bağlı olarak aşağıdaki yapıyla veri sağlayabilirsiniz:

JSON

{
  "target": string
}
Mülk adıDeğerAçıklama
targetstringBu yayınlama işleminin yayınlama hedefi. Bu, publishTarget öğesinin URL sorgu parametresi olarak kullanılmasıyla aynıdır. Dize değeri target="trustedTesters" veya target="default" olabilir. Herhangi bir değer sağlanmazsa varsayılan değer target="default" olur. Önerilen kullanım, değeri belirtmek için URL sorgu parametresini kullanmaktır.

Yetkilendirme

Bu istek, aşağıdaki kapsamla yetkilendirme gerektiriyor.

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

Yukarıdaki URL, erişim jetonu oluşturulurken kapsam parametresi olarak kullanılır. API yetkilendirmesi ve kimlik doğrulaması hakkında daha fazla bilgi edinmek için OAuth 2.0 dokümanlarına bakın.

Yanıt

Başarılı olursa bu yöntem aşağıdaki yapıya sahip bir yanıt gövdesi döndürür:

{
  "kind": "chromewebstore#item",
  "item_id": string,
  "status": [
    string
  ],
  "statusDetail": [
    string
  ]
}
Mülk adıDeğerAçıklama
kindstringStatik dize değeri her zaman "chromewebstore#item"'dir.
item_idstringBu öğenin kimliği.
status[]listBu yayınlama işleminin durum kodu. Şu listeden birden fazla öğe içerebilir: OK, NOT_AUTHORIZED, INVALID_DEVELOPER, DEVELOPER_NO_OWNERSHIP, DEVELOPER_SUSPENDED, ITEM_NOT_FOUND, ITEM_PENDING_REVIEW, ITEM_TAKEN_DOWN, PUBLISHER_SUSPENDED.
statusDetail[]listYukarıdaki durum kodunun kullanıcılar tarafından anlaşılabilir ayrıntılı açıklaması.

Güncelle

Mevcut bir öğeyi günceller.

Bu yöntem bir yükleme URI'sini destekler ve yüklenen medyayı kabul eder.

İstek

HTTP isteği

Bu yöntem, iki ayrı URI üzerinden medya yükleme işlevselliği sağlar.

  • Medya yükleme istekleri için yükleme URI'si:

    PUT https://www.googleapis.com/upload/chromewebstore/v1.1/items/itemId
    
  • Yalnızca meta veri istekleri için meta veri URI'si:

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

Parametreler

Parametre adıDeğerAçıklama
Yol parametreleri
itemIdstringYüklenecek öğenin kimliği.
Gerekli sorgu parametreleri
uploadTypestring/upload URI'sine yükleme isteğinin türü. Kabul edilebilir değerler: media - Basit yükleme. Meta veri olmadan yalnızca medyayı yüklemek.

İstek içeriği

İstek gövdesinde meta veri olarak bir Öğe kaynağı sağlayın.

Yetkilendirme

Bu istek, aşağıdaki kapsamla yetkilendirme gerektiriyor.

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

Yukarıdaki URL, erişim jetonu oluşturulurken kapsam parametresi olarak kullanılır. API yetkilendirmesi ve kimlik doğrulaması hakkında daha fazla bilgi edinmek için OAuth 2.0 dokümanlarına bakın.

Yanıt

Başarılı olursa bu yöntem, yanıt gövdesinde bir Öğeler kaynağı döndürür.