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

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

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

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

คุณต้องทำตามคู่มือเริ่มต้นใช้งานหลักเพื่อตั้งค่าการเข้าถึง API, ข้อมูลเข้าสู่ระบบบริการ และโปรเจ็กต์ที่อยู่ในระบบคลาวด์ของ Google ก่อนจึงจะเรียก 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. แนวทางปฏิบัติแนะนำและการซิงค์

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

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