คู่มือนักพัฒนาแอป Play Catalog API

Play Catalog API ช่วยให้ App Store ของบุคคลที่สาม (3PAS) ที่ลงทะเบียนใน Google Play สามารถสำรวจการอัปเดตแคตตาล็อกแอปของ Google Play ได้ ผู้เรียกใช้สามารถดึงข้อมูลรายละเอียดแคตตาล็อกสำหรับแอปที่มีการแก้ไขหรือนำออกตั้งแต่การส่งออกแคตตาล็อกรายวันครั้งล่าสุด

ดูรายการปลายทาง เมธอด และสคีมาทรัพยากรทั้งหมดได้ที่เอกสารอ้างอิง Play Catalog API

ก่อนที่คุณจะเริ่มต้น

คุณต้องทำตามคู่มือการเริ่มต้นใช้งานหลักให้เสร็จสมบูรณ์ เพื่อตั้งค่าการเข้าถึง API, ข้อมูลเข้าสู่ระบบของบริการ และโปรเจ็กต์ Google Cloud ก่อน จึงจะเรียก Play Catalog API ได้

การออกแบบและสถาปัตยกรรม API

ระบบจะสร้างการส่งออกแคตตาล็อก Play ทุกๆ 24 ชั่วโมง Play Catalog API มีกลไกการสำรวจภายในวันเพื่อดึงข้อมูลอัปเดตที่ เกิดขึ้นตั้งแต่การส่งออกครั้งล่าสุด

  1. สำรวจหาเหตุการณ์การอัปเดต: คุณจะค้นหา appstorecatalog.recentUpdateEvents.list ด้วยหน้าต่าง startTime และ endTime เพื่อดูว่ามีการแก้ไขหรือลบชื่อแพ็กเกจใด
  2. ดึงข้อมูลมุมมองแบบละเอียด: สำหรับชื่อแพ็กเกจแต่ละชื่อที่แก้ไข คุณจะเรียกใช้ appstorecatalog.recentAppViews.get เพื่อดึงข้อมูลเมตาCatalogAppView แบบละเอียด

API เป็นแบบอ่านอย่างเดียวและจำกัดให้แสดงเฉพาะเหตุการณ์ที่เกิดขึ้นในช่วง 36 ชั่วโมงที่ผ่านมา API มีขีดจำกัด QPS ที่ 2 ซึ่งใช้ร่วมกันทั้ง 2 วิธี

1. การสำรวจเหตุการณ์การอัปเดตแคตตาล็อก

หากต้องการดึงข้อมูลรายการแพ็กเกจที่มีการเปลี่ยนแปลงในช่วงเวลาที่เฉพาะเจาะจง ให้เรียกใช้เมธอด appstorecatalog.recentUpdateEvents.list

ระบบจะแสดงเฉพาะเหตุการณ์การอัปเดตสำหรับแอปที่มีสิทธิ์เท่านั้น แอปที่มีสิทธิ์ต้องมีลักษณะดังนี้

  • เลือกใช้การรวมแคตตาล็อกสำหรับ App Store ที่เรียกใช้
  • เผยแพร่และพร้อมให้บริการในสหรัฐอเมริกา (US) บน Google Play Store

ทำความเข้าใจประเภทการอัปเดต

  • MODIFICATION: ทริกเกอร์เมื่อมีการแก้ไขแอปที่มีสิทธิ์ เผยแพร่เป็นครั้งแรก เริ่มกำหนดเป้าหมายไปยังสหรัฐอเมริกา หรือเมื่อแอปเลือกใช้แคตตาล็อกของคุณใหม่
  • DELETION: ทริกเกอร์เมื่อมีการเลิกเผยแพร่แอป เลือกไม่ใช้การรวมแคตตาล็อก ถูกระงับหรือถูกบล็อก หรือหยุดกำหนดเป้าหมายไปยังสหรัฐอเมริกา

2. การดึงข้อมูลมุมมองแอปแคตตาล็อก

สำหรับแต่ละแพ็กเกจที่ส่งคืนพร้อมกับเหตุการณ์ MODIFICATION คุณสามารถดึงรายละเอียดแคตตาล็อกที่อัปเดตแล้ว ได้โดยการเรียกใช้เมธอด appstorecatalog.recentAppViews.get

3. แนวทางปฏิบัติแนะนำและการซิงค์

โปรดปฏิบัติตามหลักเกณฑ์การผสานรวมต่อไปนี้เพื่อรักษาฐานข้อมูลแคตตาล็อกที่สอดคล้องกันในร้านค้า

  • การซิงค์การส่งออกรายวัน: นำเข้ารายชื่อแอปที่มีสิทธิ์ทั้งหมดโดยใช้ การส่งออกแคตตาล็อกรายวัน
  • (ไม่บังคับ) การซิงค์ระหว่างวัน: ทำการสำรวจปลายทาง appstorecatalog.recentUpdateEvents.list เป็นประจำ (เช่น ทุกนาที) โดยใช้กรอบเวลาที่เลื่อนไปเรื่อยๆ ตรวจสอบว่าคุณจัดการ การแบ่งหน้าโดยใช้ nextPageToken
    • การอัปเดตกระบวนการ
      • สําหรับเหตุการณ์ MODIFICATION ให้ดึงข้อมูล CatalogAppView ที่อัปเดตแล้วโดยใช้ appstorecatalog.recentAppViews.get แล้วอัปเดตฐานข้อมูลในเครื่อง
      • สำหรับDELETION ให้นำแอปออกจากข้อมูลของร้านค้าหรือ ซ่อนแอปจากผู้ใช้
    • จัดการเหตุการณ์การแก้ไขซ้ำ: คุณอาจเห็นเหตุการณ์ MODIFICATION หลายรายการสำหรับแอปเดียวกัน ซึ่งหมายความว่าแอปได้รับการแก้ไขหลายครั้งในกรอบเวลาที่ค้นหา appstorecatalog.recentAppViews.get จะแสดงมุมมองแอปของการแก้ไขล่าสุดเสมอ