ข้อมูลอ้างอิงเกี่ยวกับ API ของ Chrome เว็บสโตร์

ข้อมูลอ้างอิงนี้อธิบายวิธีและการนำเสนอทรัพยากรที่มีให้ใช้งานสำหรับ API เผยแพร่ ของ Chrome เว็บสโตร์ ทรัพยากรแต่ละประเภทจะมีการนำเสนอข้อมูลอย่างน้อย 1 รายการและวิธีการอย่างน้อย 1 วิธี ดูการใช้ API การเผยแพร่ของ Chrome เว็บสโตร์สำหรับรายละเอียดการใช้งาน

รายการ

ดูรายละเอียดทรัพยากรรายการได้ที่การแสดงทรัพยากร URI จะสัมพันธ์กับ https://www.googleapis.com เว้นแต่จะระบุไว้เป็นอย่างอื่น

การดำเนินการ คำขอ HTTP คำอธิบาย
ได้ GET
/chromewebstore/v1.1/items/itemId
รับรายการใน Chrome เว็บสโตร์ ระบุ projection="DRAFT" ใน URL (คำนึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่)
แทรก POST
/upload/chromewebstore/v1.1/items
แทรกรายการใหม่
publish POST
/chromewebstore/v1.1/
items/itemId/publish
เผยแพร่รายการ

พารามิเตอร์การค้นหา publishTarget (ไม่บังคับ) จะระบุวิธีเผยแพร่รายการ ค่าที่ถูกต้องคือ "trustedTesters" และ "default"
อัปเดต PUT
/upload/chromewebstore/v1.1/
items/itemId


และ

PUT
/items/itemId
อัปเดตรายการที่มีอยู่

การนำเสนอทรัพยากร

{
  "kind": "chromewebstore#item",
  "id": string,
  "publicKey": string,
  "uploadState": string,
  "itemError": [
    (value)
  ]
}
ชื่อพร็อพเพอร์ตี้ค่าคำอธิบาย
idสตริงรหัสที่ไม่ซ้ำกันของสินค้า
itemError[]ลิสต์รายละเอียดของสถานะการดำเนินการที่มนุษย์อ่านได้เป็นภาษาอังกฤษเท่านั้น ข้อความแสดงข้อผิดพลาดเดียวกันจะแสดงเมื่อคุณอัปโหลดแอปไปยัง Chrome เว็บสโตร์
kindสตริงระบุทรัพยากรนี้เป็นรายการ ค่า: สตริงคงที่ "chromewebstore#item"
publicKeyสตริงคีย์สาธารณะของรายการนี้
uploadStateสตริงสถานะของการดำเนินการ

ค่าที่ยอมรับมีดังนี้
  • "FAILURE"
  • "IN_PROGRESS"
  • "NOT_FOUND"
  • "SUCCESS"

ดาวน์โหลด

รับรายการใน Chrome เว็บสโตร์ ระบุ projection="DRAFT" (คำนึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่) เป็นพารามิเตอร์ของ URL

ส่งคำขอ

คำขอ HTTP

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

พารามิเตอร์

ชื่อพารามิเตอร์ค่าคำอธิบาย
พารามิเตอร์เส้นทาง
itemIdสตริงตัวระบุที่ไม่ซ้ำกันซึ่งแสดงแอป Chrome, ส่วนขยายของ Chrome หรือธีม Chrome
พารามิเตอร์การค้นหาที่ไม่บังคับ
projectionสตริงกำหนดชุดย่อยของข้อมูลสินค้าที่จะแสดง

ค่าที่ยอมรับได้มีดังนี้
  • "DRAFT": ส่งคืนข้อมูลที่ดึงมาจากฉบับร่างปัจจุบัน
  • "PUBLISHED": แสดงข้อมูลที่ดึงมาจากฉบับร่างของรายการที่เผยแพร่
โปรดทราบว่าขณะนี้รองรับเฉพาะ "DRAFT" เท่านั้น

การให้สิทธิ์

คำขอนี้จำเป็นต้องให้สิทธิ์แก่ขอบเขตต่อไปนี้

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

ระบบจะใช้ URL ข้างต้นเป็นพารามิเตอร์ขอบเขตเมื่อสร้างโทเค็นเพื่อการเข้าถึง โปรดดูรายละเอียดเพิ่มเติมเกี่ยวกับการให้สิทธิ์และการตรวจสอบสิทธิ์ API ในเอกสารประกอบของ OAuth 2.0

เนื้อหาของคำขอ

อย่าระบุเนื้อหาคำขอด้วยวิธีนี้

คำตอบ

หากสำเร็จ เมธอดนี้จะส่งคืนค่า Items resource ในเนื้อหาของการตอบกลับ

แทรก

แทรกรายการใหม่

วิธีนี้รองรับ URI การอัปโหลดและยอมรับสื่อที่อัปโหลด

ส่งคำขอ

คำขอ HTTP

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

พารามิเตอร์

ชื่อพารามิเตอร์ค่าคำอธิบาย
พารามิเตอร์การค้นหาที่จำเป็น
uploadTypeสตริงประเภทคำขออัปโหลดไปยัง URI /upload ค่าเดียวที่ยอมรับคือ media ซึ่งเป็นการอัปโหลดข้อมูลสื่อแบบง่ายๆ
พารามิเตอร์การค้นหาที่ไม่บังคับ
publisherEmailสตริงอีเมลของผู้เผยแพร่ที่เป็นเจ้าของรายการเหล่านี้ ค่าเริ่มต้นจะเป็นอีเมลของผู้โทร

การให้สิทธิ์

คำขอนี้จำเป็นต้องให้สิทธิ์แก่ขอบเขตต่อไปนี้

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

ระบบจะใช้ URL ข้างต้นเป็นพารามิเตอร์ขอบเขตเมื่อสร้างโทเค็นเพื่อการเข้าถึง โปรดดูรายละเอียดเพิ่มเติมเกี่ยวกับการให้สิทธิ์และการตรวจสอบสิทธิ์ API ในเอกสารประกอบของ OAuth 2.0

เนื้อหาของคำขอ

อย่าระบุเนื้อหาคำขอด้วยวิธีนี้

คำตอบ

หากสำเร็จ เมธอดนี้จะส่งคืนค่า Items resource ในเนื้อหาของการตอบกลับ

เผยแพร่

เผยแพร่รายการ ระบุ PublishTarget ที่กำหนดใน URL (คำนึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่): PublishTarget = "trustedTesters" or publishTarget = "default"

ส่งคำขอ

คำขอ HTTP

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

พารามิเตอร์

ชื่อพารามิเตอร์ค่าคำอธิบาย
พารามิเตอร์เส้นทาง
itemIdสตริงรหัสของรายการที่จะเผยแพร่
พารามิเตอร์การค้นหาที่ไม่บังคับ
publishTargetสตริงระบุ publishTarget ที่กำหนดไว้ใน URL (คำนึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่): publishTarget="trustedTesters" หรือ publishTarget="default" ค่าเริ่มต้นคือ publishTarget="default"

เนื้อหาของคำขอ

ในเนื้อหาคำขอ คุณจะเลือกให้ข้อมูลด้วยโครงสร้างต่อไปนี้หรือไม่ก็ได้

JSON

{
  "target": string
}
ชื่อพร็อพเพอร์ตี้ค่าคำอธิบาย
targetstringเป้าหมายการเผยแพร่ของการดำเนินการเผยแพร่นี้ ซึ่งจะเหมือนกับการใช้ publishTarget เป็นพารามิเตอร์การค้นหาของ URL ค่าสตริงอาจเป็น target="trustedTesters" หรือ target="default" ก็ได้ ค่าเริ่มต้น หากไม่ได้ระบุไว้จะเป็น target="default" การใช้งานที่แนะนำคือการใช้พารามิเตอร์การค้นหา URL เพื่อระบุค่า

การให้สิทธิ์

คำขอนี้จำเป็นต้องให้สิทธิ์แก่ขอบเขตต่อไปนี้

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

ระบบจะใช้ URL ข้างต้นเป็นพารามิเตอร์ขอบเขตเมื่อสร้างโทเค็นเพื่อการเข้าถึง โปรดดูรายละเอียดเพิ่มเติมเกี่ยวกับการให้สิทธิ์และการตรวจสอบสิทธิ์ API ในเอกสารประกอบของ OAuth 2.0

คำตอบ

หากทำสำเร็จ เมธอดนี้จะส่งเนื้อหาการตอบกลับที่มีโครงสร้างต่อไปนี้กลับมา

{
  "kind": "chromewebstore#item",
  "item_id": string,
  "status": [
    string
  ],
  "statusDetail": [
    string
  ]
}
ชื่อพร็อพเพอร์ตี้ค่าคำอธิบาย
kindstringค่าสตริงแบบคงที่คือ "chromewebstore#item" เสมอ
item_idstringรหัสของรายการนี้
status[]listรหัสสถานะของการดำเนินการเผยแพร่นี้ ซึ่งอาจมีองค์ประกอบหลายองค์ประกอบจากรายการต่อไปนี้ OK, NOT_AUTHORIZED, INVALID_DEVELOPER, DEVELOPER_NO_OWNERSHIP, DEVELOPER_SUSPENDED, ITEM_NOT_FOUND, ITEM_PENDING_REVIEW, ITEM_TAKEN_DOWN, PUBLISHER_SUSPENDED
statusDetail[]listคำอธิบายรหัสสถานะด้านบนที่มนุษย์อ่านเข้าใจได้โดยละเอียด

อัปเดต

อัปเดตรายการที่มีอยู่

วิธีนี้รองรับ URI การอัปโหลดและยอมรับสื่อที่อัปโหลด

ส่งคำขอ

คำขอ HTTP

เมธอดนี้มอบฟังก์ชันการอัปโหลดสื่อผ่าน URI ที่แยกกัน 2 รายการ

  • URI การอัปโหลด สำหรับคำขออัปโหลดสื่อ:

    PUT https://www.googleapis.com/upload/chromewebstore/v1.1/items/itemId
    
  • URI ข้อมูลเมตา สำหรับคำขอที่มีเฉพาะข้อมูลเมตา:

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

พารามิเตอร์

ชื่อพารามิเตอร์ค่าคำอธิบาย
พารามิเตอร์เส้นทาง
itemIdstringรหัสของรายการที่จะอัปโหลด
พารามิเตอร์การค้นหาที่จำเป็น
uploadTypestringประเภทคำขออัปโหลดไปยัง URI /upload ค่าที่ยอมรับมีดังนี้ media - อัปโหลดแบบง่าย อัปโหลดสื่อเท่านั้นโดยไม่มีข้อมูลเมตา

เนื้อหาของคำขอ

ในเนื้อหาคำขอ ให้ระบุทรัพยากรรายการเป็นข้อมูลเมตา

การให้สิทธิ์

คำขอนี้จำเป็นต้องให้สิทธิ์แก่ขอบเขตต่อไปนี้

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

ระบบจะใช้ URL ข้างต้นเป็นพารามิเตอร์ขอบเขตเมื่อสร้างโทเค็นเพื่อการเข้าถึง โปรดดูรายละเอียดเพิ่มเติมเกี่ยวกับการให้สิทธิ์และการตรวจสอบสิทธิ์ API ในเอกสารประกอบของ OAuth 2.0

คำตอบ

หากสำเร็จ เมธอดนี้จะส่งคืนค่า Items resource ในเนื้อหาของการตอบกลับ