Tài liệu tham khảo API của Cửa hàng Chrome trực tuyến

Tài liệu tham khảo này mô tả các phương thức và cách biểu diễn tài nguyên có sẵn cho API Phát hành trên Cửa hàng Chrome trực tuyến. Mỗi loại tài nguyên có một hoặc nhiều bản trình bày dữ liệu và một hoặc nhiều phương thức. Hãy xem bài viết Sử dụng API phát hành trên Cửa hàng Chrome trực tuyến để biết chi tiết triển khai.

Mục

Để biết thông tin chi tiết về Tài nguyên mặt hàng, hãy xem phần nội dung trình bày tài nguyên. URI có liên quan đến https://www.googleapis.com, trừ khi có ghi chú khác

Hoạt động Yêu cầu HTTP Nội dung mô tả
nhận GET
/chromewebstore/v1.1/items/itemId 		Mua một mặt hàng trên Cửa hàng Chrome trực tuyến. Cung cấp projection="DRAFT" trong URL (phân biệt chữ hoa chữ thường).
chèn POST
/upload/chromewebstore/v1.1/items 		Chèn một mục mới.
publish POST
/chromewebstore/v1.1/
items/itemId/publish 		Xuất bản một mục.

Tham số truy vấn publishTarget (không bắt buộc) chỉ định cách phát hành mục. Các giá trị hợp lệ là "trustedTesters" và "default".
cập nhật PUT
/upload/chromewebstore/v1.1/
items/itemId

và

PUT
/items/itemId 		Cập nhật một mục hiện có.

Biểu diễn tài nguyên

{
  "kind": "chromewebstore#item",
  "id": string,
  "publicKey": string,
  "uploadState": string,
  "itemError": [
    (value)
  ]
}
Tên tài sảnGiá trịNội dung mô tả
idstringMã nhận dạng duy nhất của mặt hàng.
itemError[]danh sáchMô tả trạng thái thao tác mà con người có thể đọc được, chỉ bằng tiếng Anh. Các thông báo lỗi tương tự sẽ hiển thị khi bạn tải ứng dụng lên Cửa hàng Chrome trực tuyến.
kindstringXác định tài nguyên này dưới dạng một Mục. Giá trị: chuỗi cố định "chromewebstore#item".
publicKeystringKhoá công khai của mục này.
uploadStatestringTrạng thái hoạt động.

Các giá trị được chấp nhận là:
  • "FAILURE"
  • "IN_PROGRESS"
  • "NOT_FOUND"
  • "SUCCESS"

Get

Mua một mặt hàng trên Cửa hàng Chrome trực tuyến. Cung cấp projection="DRAFT" (phân biệt chữ hoa chữ thường) dưới dạng Tham số URL.

Yêu cầu

Yêu cầu HTTP

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

Thông số

Tên thông sốGiá trịNội dung mô tả
Tham số đường dẫn
itemIdstringGiá trị nhận dạng duy nhất biểu thị Ứng dụng Chrome, Tiện ích của Chrome hoặc Giao diện Chrome.
Tham số truy vấn không bắt buộc
projectionstringXác định nhóm thông tin mặt hàng cần trả về.

Các giá trị được chấp nhận là:
  • "DRAFT": Trả về thông tin trích xuất từ bản nháp hiện tại.
  • "PUBLISHED": Trả về thông tin trích xuất từ bản nháp mặt hàng đã xuất bản.
Xin lưu ý rằng hiện chỉ hỗ trợ "DRAFT".

Uỷ quyền

Yêu cầu này cần được cho phép với phạm vi sau.

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

URL ở trên được dùng làm tham số phạm vi khi tạo mã truy cập. Để biết thêm thông tin chi tiết về việc uỷ quyền và xác thực API, hãy tham khảo tài liệu về OAuth 2.0.

Nội dung yêu cầu

Đừng cung cấp nội dung yêu cầu bằng phương thức này.

Phản hồi

Nếu thành công, phương thức này sẽ trả về một tài nguyên Mặt hàng trong nội dung phản hồi.

Insert

Chèn một mục mới.

Phương thức này hỗ trợ URI tải lên và chấp nhận nội dung nghe nhìn đã tải lên.

Yêu cầu

Yêu cầu HTTP

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

Thông số

Tên thông sốGiá trịNội dung mô tả
Tham số truy vấn bắt buộc
uploadTypestringLoại yêu cầu tải lên URI /upload. Giá trị duy nhất được chấp nhận là media: chỉ tải dữ liệu đa phương tiện lên.
Tham số truy vấn không bắt buộc
publisherEmailstringEmail của nhà xuất bản sở hữu các mục này. Giá trị mặc định là địa chỉ email của người gọi.

Uỷ quyền

Yêu cầu này cần được cho phép với phạm vi sau.

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

URL ở trên được dùng làm tham số phạm vi khi tạo mã truy cập. Để biết thêm thông tin chi tiết về việc uỷ quyền và xác thực API, hãy tham khảo tài liệu về OAuth 2.0.

Nội dung yêu cầu

Đừng cung cấp nội dung yêu cầu bằng phương thức này.

Phản hồi

Nếu thành công, phương thức này sẽ trả về một tài nguyên Mặt hàng trong nội dung phản hồi.

Đăng

Xuất bản một mặt hàng. Cung cấp publishTarget đã xác định trong URL (phân biệt chữ hoa chữ thường): publishTarget = "trustedTesters" hoặc publishTarget = "default".

Yêu cầu

Yêu cầu HTTP

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

Thông số

Tên thông sốGiá trịNội dung mô tả
Tham số đường dẫn
itemIdstringMã của mục cần xuất bản.
Tham số truy vấn không bắt buộc
publishTargetstringCung cấp publishTarget đã xác định trong URL (phân biệt chữ hoa chữ thường): publishTarget="trustedTesters" hoặc publishTarget="default". Giá trị mặc định là publishTarget="default".

Nội dung yêu cầu

Trong nội dung yêu cầu, bạn có thể tuỳ ý cung cấp dữ liệu với cấu trúc sau đây:

JSON

{
  "target": string
}
Tên tài sảnGiá trịNội dung mô tả
targetstringMục tiêu xuất bản của hoạt động xuất bản này. Điều này cũng giống như sử dụng publishTarget làm tham số truy vấn URL. Giá trị chuỗi có thể là target="trustedTesters" hoặc target="default". Giá trị mặc định nếu không có giá trị nào được cung cấp thì giá trị là target="default". Bạn nên sử dụng tham số truy vấn URL để chỉ định giá trị.

Uỷ quyền

Yêu cầu này cần được cho phép với phạm vi sau.

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

URL ở trên được dùng làm tham số phạm vi khi tạo mã truy cập. Để biết thêm thông tin chi tiết về việc uỷ quyền và xác thực API, hãy tham khảo tài liệu về OAuth 2.0.

Phản hồi

Nếu thành công, phương thức này sẽ trả về một nội dung phản hồi có cấu trúc như sau:

{
  "kind": "chromewebstore#item",
  "item_id": string,
  "status": [
    string
  ],
  "statusDetail": [
    string
  ]
}
Tên tài sảnGiá trịNội dung mô tả
kindstringGiá trị chuỗi tĩnh luôn là "chromewebstore#item".
item_idstringMã nhận dạng của mặt hàng này.
status[]listMã trạng thái của hoạt động xuất bản này. Tệp này có thể chứa nhiều phần tử trong danh sách sau: OK, NOT_AUTHORIZED, INVALID_DEVELOPER, DEVELOPER_NO_OWNERSHIP, DEVELOPER_SUSPENDED, ITEM_NOT_FOUND, ITEM_PENDING_REVIEW, ITEM_TAKEN_DOWN, PUBLISHER_SUSPENDED.
statusDetail[]listNội dung giải thích chi tiết mà con người có thể hiểu được về mã trạng thái ở trên.

Cập nhật

Cập nhật một mục hiện có.

Phương thức này hỗ trợ URI tải lên và chấp nhận nội dung nghe nhìn đã tải lên.

Yêu cầu

Yêu cầu HTTP

Phương thức này cung cấp chức năng tải nội dung nghe nhìn lên thông qua hai URI riêng biệt.

  • URI tải lên, đối với các yêu cầu tải nội dung nghe nhìn lên:

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

  • URI siêu dữ liệu, đối với những yêu cầu chỉ siêu dữ liệu:

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

Thông số

Tên thông sốGiá trịNội dung mô tả
Tham số đường dẫn
itemIdstringMã của mục cần tải lên.
Tham số truy vấn bắt buộc
uploadTypestringLoại yêu cầu tải lên URI /upload. Các giá trị được chấp nhận là: media – Tải lên đơn giản. Chỉ tải nội dung nghe nhìn lên, không cung cấp siêu dữ liệu.

Nội dung yêu cầu

Trong nội dung yêu cầu, hãy cung cấp tài nguyên mặt hàng làm siêu dữ liệu.

Uỷ quyền

Yêu cầu này cần được cho phép với phạm vi sau.

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

URL ở trên được dùng làm tham số phạm vi khi tạo mã truy cập. Để biết thêm thông tin chi tiết về việc uỷ quyền và xác thực API, hãy tham khảo tài liệu về OAuth 2.0.

Phản hồi

Nếu thành công, phương thức này sẽ trả về một tài nguyên Mặt hàng trong nội dung phản hồi.