REST Resource: monetization.subscriptions

แหล่งข้อมูล: การสมัครใช้บริการ

การสมัครใช้บริการแอปเดียว

การแสดง JSON 
{   "packageName": string,   "productId": string,   "basePlans": [     {       object (BasePlan)     }   ],   "listings": [     {       object (SubscriptionListing)     }   ],   "archived": boolean,   "taxAndComplianceSettings": {     object (SubscriptionTaxAndComplianceSettings)   },   "restrictedPaymentCountries": {     object (RestrictedPaymentCountries)   } }
ช่อง
packageName

string

เปลี่ยนแปลงไม่ได้ ชื่อแพ็กเกจของแอปหลัก
productId

string

เปลี่ยนแปลงไม่ได้ รหัสผลิตภัณฑ์ที่ไม่ซ้ำกันของผลิตภัณฑ์ ไม่ซ้ำกันภายในแอปหลัก รหัสผลิตภัณฑ์ต้องประกอบด้วยตัวอักษรพิมพ์เล็ก (a-z), ตัวเลข (0-9), ขีดล่าง (_) และจุด (.) โดยต้องขึ้นต้นด้วยตัวอักษรพิมพ์เล็กหรือตัวเลข และมีความยาวระหว่าง 1 ถึง 40 อักขระ (รวม)
basePlans[]

object (BasePlan)

ชุดแพ็กเกจเริ่มต้นสำหรับการสมัครใช้บริการนี้ แสดงราคาและระยะเวลาของการสมัครใช้บริการหากไม่มีข้อเสนออื่นๆ
listings[]

object (SubscriptionListing)

ต้องระบุ รายการข้อมูลที่แปลแล้วสำหรับการสมัครใช้บริการนี้ ต้องมีรายการอย่างน้อย 1 รายการสำหรับภาษาเริ่มต้นของแอปหลัก
archived
(deprecated)

boolean

เอาต์พุตเท่านั้น เลิกใช้งานแล้ว: ระบบไม่รองรับการเก็บถาวรการติดตาม
taxAndComplianceSettings

object (SubscriptionTaxAndComplianceSettings)

รายละเอียดเกี่ยวกับภาษีและการปฏิบัติตามกฎหมาย
restrictedPaymentCountries

object (RestrictedPaymentCountries)

ไม่บังคับ ประเทศที่จำกัดการซื้อการสมัครใช้บริการนี้ไว้เฉพาะวิธีการชำระเงินที่จดทะเบียนในประเทศเดียวกัน หากเว้นว่างไว้ จะไม่มีการกำหนดข้อจำกัดสถานที่ชำระเงิน

BasePlan

แพ็กเกจเริ่มต้นเดียวสำหรับการสมัครใช้บริการ

การแสดง JSON 
{   "basePlanId": string,   "state": enum (State),   "regionalConfigs": [     {       object (RegionalBasePlanConfig)     }   ],   "offerTags": [     {       object (OfferTag)     }   ],   "otherRegionsConfig": {     object (OtherRegionsBasePlanConfig)   },    // Union field base_plan_type can be only one of the following:   "autoRenewingBasePlanType": {     object (AutoRenewingBasePlanType)   },   "prepaidBasePlanType": {     object (PrepaidBasePlanType)   },   "installmentsBasePlanType": {     object (InstallmentsBasePlanType)   }   // End of list of possible types for union field base_plan_type. }
ช่อง
basePlanId

string

ต้องระบุ เปลี่ยนแปลงไม่ได้ ตัวระบุที่ไม่ซ้ำกันของแพ็กเกจเริ่มต้นนี้ ต้องไม่ซ้ำกันภายในข้อมูลการติดตาม และเป็นไปตาม RFC-1034 กล่าวคือ รหัสนี้มีได้เฉพาะตัวอักษรพิมพ์เล็ก (a-z) ตัวเลข (0-9) และขีดกลาง (-) เท่านั้น และมีอักขระไม่เกิน 63 ตัว
state

enum (State)

เอาต์พุตเท่านั้น สถานะของ Base Plan เช่น ใช้งานอยู่หรือไม่ คุณเปิดใช้งานหรือลบแพ็กเกจเริ่มต้นฉบับร่างและแพ็กเกจเริ่มต้นที่ไม่ได้ใช้งานได้ คุณทำให้แพ็กเกจเริ่มต้นที่ใช้งานอยู่ไม่ใช้งานได้ คุณยกเลิกแพ็กเกจเริ่มต้นที่ไม่ได้ใช้งานได้ คุณจะเปลี่ยนช่องนี้โดยการอัปเดตทรัพยากรไม่ได้ ให้ใช้ปลายทางเฉพาะแทน
regionalConfigs[]

object (RegionalBasePlanConfig)

ข้อมูลเฉพาะภูมิภาคสำหรับแพ็กเกจเริ่มต้นนี้
offerTags[]

object (OfferTag)

รายการแท็กที่กำหนดเองสูงสุด 20 รายการที่ระบุไว้สำหรับแพ็กเกจเริ่มต้นนี้ และส่งคืนไปยังแอปผ่าน Billing Library ข้อเสนอการสมัครใช้บริการสำหรับแพ็กเกจเริ่มต้นนี้จะได้รับแท็กข้อเสนอเหล่านี้ในคลังการเรียกเก็บเงินด้วย
otherRegionsConfig

object (OtherRegionsBasePlanConfig)

ข้อมูลราคาสำหรับสถานที่ตั้งใหม่ที่ Play อาจเปิดตัวในอนาคต หากไม่ระบุ ระบบจะไม่ทำให้ BasePlan พร้อมใช้งานโดยอัตโนมัติในสถานที่ตั้งใหม่ที่ Play อาจเปิดตัวในอนาคต
ฟิลด์ Union base_plan_type ประเภทของแพ็กเกจเริ่มต้นนี้ ต้องตั้งค่าอย่างใดอย่างหนึ่งเท่านั้น ประเภทแพ็กเกจเริ่มต้นจะเปลี่ยนแปลงไม่ได้หลังจากสร้างแพ็กเกจเริ่มต้นแล้ว base_plan_type ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
autoRenewingBasePlanType

object (AutoRenewingBasePlanType)

กำหนดเวลาที่แพ็กเกจเริ่มต้นจะต่ออายุโดยอัตโนมัติเป็นระยะๆ
prepaidBasePlanType

object (PrepaidBasePlanType)

ตั้งค่าเมื่อ Base Plan ไม่ต่ออายุโดยอัตโนมัติเมื่อสิ้นสุดระยะเวลาการเรียกเก็บเงิน
installmentsBasePlanType

object (InstallmentsBasePlanType)

ตั้งค่าสำหรับแพ็กเกจเริ่มต้นแบบผ่อนชำระที่ผู้ใช้ตกลงที่จะชำระเงินตามจำนวนที่ระบุ

รัฐ

สถานะปัจจุบันของแพ็กเกจเริ่มต้น

Enum
STATE_UNSPECIFIED สถานะที่ไม่ได้ระบุ
DRAFT ปัจจุบันแพ็กเกจเริ่มต้นอยู่ในสถานะฉบับร่างและยังไม่ได้เปิดใช้งาน คุณสามารถลบไฟล์นี้ได้อย่างปลอดภัยในตอนนี้
ACTIVE แพ็กเกจเริ่มต้นใช้งานอยู่และพร้อมให้บริการแก่สมาชิกใหม่
INACTIVE แพ็กเกจเริ่มต้นไม่ได้ใช้งานและพร้อมให้บริการสำหรับสมาชิกปัจจุบันเท่านั้น

AutoRenewingBasePlanType

แสดงแพ็กเกจเริ่มต้นที่จะต่ออายุโดยอัตโนมัติเมื่อสิ้นสุดระยะเวลาการสมัครใช้บริการ

การแสดง JSON 
{   "billingPeriodDuration": string,   "gracePeriodDuration": string,   "accountHoldDuration": string,   "resubscribeState": enum (ResubscribeState),   "prorationMode": enum (SubscriptionProrationMode),   "legacyCompatible": boolean,   "legacyCompatibleSubscriptionOfferId": string }
ช่อง
billingPeriodDuration

string

ต้องระบุ เปลี่ยนแปลงไม่ได้ ระยะเวลาการสมัครใช้บริการที่ระบุในรูปแบบ ISO 8601 ดูรายการระยะเวลาการเรียกเก็บเงินที่ยอมรับได้ในศูนย์ช่วยเหลือ ระยะเวลาจะเปลี่ยนแปลงไม่ได้หลังจากสร้างแพ็กเกจเริ่มต้นแล้ว
gracePeriodDuration

string

ระยะเวลาผ่อนผันของการสมัครใช้บริการที่ระบุในรูปแบบ ISO 8601 ค่าที่ยอมรับได้ต้องเป็นหน่วยวันและอยู่ระหว่าง P0D กับระยะเวลาการเรียกเก็บเงินของแพ็กเกจเริ่มต้นหรือ 30 วัน แล้วแต่ว่าระยะเวลาใดจะสั้นกว่า

หากไม่ได้ระบุ ระบบจะใช้ค่าเริ่มต้นตามรอบการเรียกเก็บเงิน

ผลรวมของ gracePeriodDuration และ accountHoldDuration ต้องอยู่ระหว่าง P30D ถึง P60D โดยไม่แบ่งแยก
accountHoldDuration

string

ไม่บังคับ ระยะเวลาที่ระบบระงับบัญชีของการสมัครใช้บริการ โดยระบุในรูปแบบ ISO 8601 ค่าที่ยอมรับได้ต้องเป็นหน่วยวันและอยู่ระหว่าง P0D ถึง P60D

หากไม่ได้ระบุ ค่าเริ่มต้นจะเป็น P30D

ผลรวมของ gracePeriodDuration และ accountHoldDuration ต้องอยู่ระหว่าง P30D ถึง P60D โดยไม่แบ่งแยก
resubscribeState

enum (ResubscribeState)

ผู้ใช้ควรสมัครใช้บริการแพ็กเกจเริ่มต้นนี้อีกครั้งในแพลตฟอร์มของ Google Play ได้หรือไม่ ค่าเริ่มต้นจะเป็น RESUBSCRIBE_STATE_ACTIVE หากไม่ได้ระบุไว้
prorationMode

enum (SubscriptionProrationMode)

โหมดการปันส่วนสำหรับแพ็กเกจเริ่มต้นจะกำหนดสิ่งที่จะเกิดขึ้นเมื่อผู้ใช้เปลี่ยนจากแพ็กเกจเริ่มต้นอื่นมาใช้แพ็กเกจนี้ หากไม่ได้ระบุไว้ ระบบจะใช้ CHARGE_ON_NEXT_BILLING_DATE เป็นค่าเริ่มต้น
legacyCompatible

boolean

แพ็กเกจเริ่มต้นที่ต่ออายุเข้ากันได้แบบย้อนหลังหรือไม่

ระบบจะส่งแพ็กเกจเริ่มต้นที่เข้ากันได้แบบย้อนหลังกลับโดยวิธี querySkuDetailsAsync() ที่เลิกใช้แล้วของ Google Play Billing Library

คุณทำเครื่องหมายแพ็กเกจเริ่มต้นแบบต่ออายุได้เพียง 1 รายการว่าเข้ากันได้กับแพ็กเกจเดิมสำหรับการสมัครใช้บริการหนึ่งๆ
legacyCompatibleSubscriptionOfferId

string

รหัสข้อเสนอการสมัครใช้บริการที่เข้ากันได้กับรุ่นเดิม

ระบบจะส่งข้อเสนอการสมัครใช้บริการที่เข้ากันได้แบบย้อนหลังโดยวิธี querySkuDetailsAsync() ที่เลิกใช้แล้วของ Google Play Billing Library

คุณทำเครื่องหมายข้อเสนอการสมัครใช้บริการได้เพียงรายการเดียวว่าเข้ากันได้กับแผนเดิมสำหรับแพ็กเกจเริ่มต้นแบบต่ออายุที่กำหนด

หากต้องการไม่ให้มีข้อเสนอการสมัครใช้บริการที่เข้ากันได้กับรุ่นเดิม ให้ตั้งค่าฟิลด์นี้เป็นสตริงว่าง

ResubscribeState

สถานะการสมัครใช้บริการแพ็กเกจเริ่มต้นอีกครั้ง

Enum
RESUBSCRIBE_STATE_UNSPECIFIED สถานะที่ไม่ได้ระบุ
RESUBSCRIBE_STATE_ACTIVE การสมัครอีกครั้งทำงานอยู่
RESUBSCRIBE_STATE_INACTIVE การสมัครใช้บริการอีกครั้งไม่มีผลอยู่

SubscriptionProrationMode

โหมดการปันส่วนที่ใช้สำหรับการต่ออายุแพ็กเกจเริ่มต้น

Enum
SUBSCRIPTION_PRORATION_MODE_UNSPECIFIED โหมดที่ไม่ได้ระบุ
SUBSCRIPTION_PRORATION_MODE_CHARGE_ON_NEXT_BILLING_DATE ระบบจะเรียกเก็บเงินค่าแพ็กเกจพื้นฐานใหม่จากผู้ใช้เมื่อสิ้นสุดช่วงเวลาที่เรียกเก็บเงินงวดปัจจุบัน
SUBSCRIPTION_PRORATION_MODE_CHARGE_FULL_PRICE_IMMEDIATELY ระบบจะเรียกเก็บเงินค่าแพ็กเกจเริ่มต้นใหม่จากผู้ใช้ทันทีและเต็มจำนวน ระบบจะใช้ระยะเวลาที่เหลือของการสมัครใช้บริการที่มีอยู่เพื่อขยายระยะเวลาของแพ็กเกจการเรียกเก็บเงินใหม่

PrepaidBasePlanType

แสดงถึง Base Plan ที่จะไม่ต่ออายุโดยอัตโนมัติเมื่อสิ้นสุด Base Plan และผู้ใช้ต้องต่ออายุด้วยตนเอง

การแสดง JSON 
{   "billingPeriodDuration": string,   "timeExtension": enum (TimeExtension) }
ช่อง
billingPeriodDuration

string

ต้องระบุ เปลี่ยนแปลงไม่ได้ ระยะเวลาการสมัครใช้บริการที่ระบุในรูปแบบ ISO 8601 ดูรายการระยะเวลาการเรียกเก็บเงินที่ยอมรับได้ในศูนย์ช่วยเหลือ ระยะเวลาจะเปลี่ยนแปลงไม่ได้หลังจากสร้างแพ็กเกจเริ่มต้นแล้ว
timeExtension

enum (TimeExtension)

ผู้ใช้ควรต่ออายุแพ็กเกจเริ่มต้นแบบชำระล่วงหน้านี้ในแพลตฟอร์มของ Google Play ได้หรือไม่ ค่าเริ่มต้นจะเป็น TIME_EXTENSION_ACTIVE หากไม่ได้ระบุไว้

TimeExtension

การขยายเวลาแพ็กเกจเริ่มต้น

Enum
TIME_EXTENSION_UNSPECIFIED สถานะที่ไม่ได้ระบุ
TIME_EXTENSION_ACTIVE การขยายเวลาทำงานอยู่ ผู้ใช้ได้รับอนุญาตให้เติมเงินหรือขยายแพ็กเกจแบบชำระเงินล่วงหน้า
TIME_EXTENSION_INACTIVE การขยายเวลาปิดใช้งานอยู่ ผู้ใช้จะเติมเงินหรือต่ออายุแพ็กเกจแบบชำระเงินล่วงหน้าไม่ได้

InstallmentsBasePlanType

แสดงแพ็กเกจเริ่มต้นแบบผ่อนชำระที่ผู้ใช้เลือกจำนวนการชำระเงินที่ระบุ

การแสดง JSON 
{   "billingPeriodDuration": string,   "committedPaymentsCount": integer,   "renewalType": enum (RenewalType),   "gracePeriodDuration": string,   "accountHoldDuration": string,   "resubscribeState": enum (ResubscribeState),   "prorationMode": enum (SubscriptionProrationMode) }
ช่อง
billingPeriodDuration

string

ต้องระบุ เปลี่ยนแปลงไม่ได้ ระยะเวลาการสมัครใช้บริการที่ระบุในรูปแบบ ISO 8601 ดูรายการระยะเวลาการเรียกเก็บเงินที่ยอมรับได้ในศูนย์ช่วยเหลือ ระยะเวลาจะเปลี่ยนแปลงไม่ได้หลังจากสร้างแพ็กเกจเริ่มต้นแล้ว
committedPaymentsCount

integer

ต้องระบุ เปลี่ยนแปลงไม่ได้ จำนวนการชำระเงินที่ผู้ใช้ต้องชำระ โดยจะเปลี่ยนแปลงไม่ได้หลังจากสร้างแพ็กเกจเริ่มต้นแล้ว
renewalType

enum (RenewalType)

ต้องระบุ เปลี่ยนแปลงไม่ได้ ประเภทการต่ออายุแพ็กเกจเริ่มต้นแบบผ่อนชำระ กำหนดลักษณะการทำงานเมื่อสิ้นสุดการผูกมัดเริ่มต้น ประเภทการต่ออายุจะเปลี่ยนแปลงไม่ได้หลังจากสร้างแพ็กเกจเริ่มต้นแล้ว
gracePeriodDuration

string

ระยะเวลาผ่อนผันของการสมัครใช้บริการที่ระบุในรูปแบบ ISO 8601 ค่าที่ยอมรับได้ต้องเป็นหน่วยวันและอยู่ระหว่าง P0D กับระยะเวลาการเรียกเก็บเงินของแพ็กเกจเริ่มต้นหรือ 30 วัน แล้วแต่ว่าระยะเวลาใดจะสั้นกว่า

หากไม่ได้ระบุ ระบบจะใช้ค่าเริ่มต้นตามรอบการเรียกเก็บเงิน

ผลรวมของ gracePeriodDuration และ accountHoldDuration ต้องอยู่ระหว่าง P30D ถึง P60D โดยไม่แบ่งแยก
accountHoldDuration

string

ไม่บังคับ ระยะเวลาที่ระบบระงับบัญชีของการสมัครใช้บริการ โดยระบุในรูปแบบ ISO 8601 ค่าที่ยอมรับได้ต้องเป็นหน่วยวันและอยู่ระหว่าง P0D ถึง P60D

หากไม่ได้ระบุ ค่าเริ่มต้นจะเป็น P30D

ผลรวมของ gracePeriodDuration และ accountHoldDuration ต้องอยู่ระหว่าง P30D ถึง P60D โดยไม่แบ่งแยก
resubscribeState

enum (ResubscribeState)

ผู้ใช้ควรสมัครใช้บริการแพ็กเกจเริ่มต้นนี้อีกครั้งในแพลตฟอร์มของ Google Play ได้หรือไม่ ค่าเริ่มต้นจะเป็น RESUBSCRIBE_STATE_ACTIVE หากไม่ได้ระบุไว้
prorationMode

enum (SubscriptionProrationMode)

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

RenewalType

ประเภทการต่ออายุแพ็กเกจเริ่มต้นแบบผ่อนชำระ กำหนดลักษณะการทำงานเมื่อสิ้นสุดการผูกมัดเริ่มต้น ประเภทการต่ออายุจะเปลี่ยนแปลงไม่ได้หลังจากสร้างแพ็กเกจเริ่มต้นแล้ว

Enum
RENEWAL_TYPE_UNSPECIFIED สถานะที่ไม่ได้ระบุ
RENEWAL_TYPE_RENEWS_WITHOUT_COMMITMENT ต่ออายุเป็นระยะๆ ตามระยะเวลาการเรียกเก็บเงินโดยไม่มีข้อผูกมัด
RENEWAL_TYPE_RENEWS_WITH_COMMITMENT ต่ออายุโดยมีข้อผูกมัดระยะเวลาเดียวกันกับข้อผูกมัดเริ่มต้น

RegionalBasePlanConfig

การกำหนดค่าสำหรับแพ็กเกจเริ่มต้นที่เฉพาะเจาะจงสำหรับภูมิภาค

การแสดง JSON 
{   "regionCode": string,   "newSubscriberAvailability": boolean,   "price": {     object (Money)   } }
ช่อง
regionCode

string

ต้องระบุ รหัสภูมิภาคที่การกำหนดค่านี้มีผลตามที่กำหนดโดย ISO 3166-2 เช่น "US"
newSubscriberAvailability

boolean

ไม่ว่าแพ็กเกจเริ่มต้นในภูมิภาคที่ระบุจะพร้อมให้บริการสำหรับสมาชิกใหม่หรือไม่ ระบบจะไม่ยกเลิกการสมัครใช้บริการของสมาชิกปัจจุบันหากตั้งค่านี้เป็น "false" หากไม่ได้ระบุไว้ ระบบจะใช้ค่าเริ่มต้นเป็น "เท็จ"
price

object (Money)

ราคาของแพ็กเกจเริ่มต้นในภูมิภาคที่ระบุ ต้องตั้งค่าหากแพ็กเกจเริ่มต้นพร้อมให้บริการสำหรับสมาชิกใหม่ ต้องตั้งค่าเป็นสกุลเงินที่ลิงก์กับภูมิภาคที่ระบุ

OtherRegionsBasePlanConfig

ข้อมูลราคาสำหรับสถานที่ใหม่ที่ Play อาจเปิดตัว

การแสดง JSON 
{   "usdPrice": {     object (Money)   },   "eurPrice": {     object (Money)   },   "newSubscriberAvailability": boolean }
ช่อง
usdPrice

object (Money)

ต้องระบุ ราคาใน USD ที่จะใช้สำหรับสถานที่ใหม่ๆ ที่ Play อาจเปิดตัว
eurPrice

object (Money)

ต้องระบุ ราคาในสกุลเงิน EUR ที่จะใช้สำหรับสถานที่ใหม่ๆ ที่ Play อาจเปิดตัว
newSubscriberAvailability

boolean

แพ็กเกจเริ่มต้นพร้อมให้บริการสำหรับสมาชิกใหม่ในสถานที่ตั้งใหม่ที่ Play อาจเปิดตัวหรือไม่ หากไม่ได้ระบุไว้ ระบบจะใช้ค่าเริ่มต้นเป็น "เท็จ"

SubscriptionListing

ข้อมูลเมตาของการสมัครใช้บริการที่ผู้บริโภคเห็น

การแสดง JSON 
{   "languageCode": string,   "title": string,   "benefits": [     string   ],   "description": string }
ช่อง
languageCode

string

ต้องระบุ ภาษาของข้อมูลนี้ตามที่กำหนดโดย BCP-47 เช่น "en-US"
title

string

ต้องระบุ ชื่อของการสมัครใช้บริการนี้ในภาษาของข้อมูลนี้ ข้อความธรรมดา
benefits[]

string

รายการสิทธิประโยชน์ที่แสดงต่อผู้ใช้ในแพลตฟอร์มต่างๆ เช่น Play Store และในขั้นตอนการคืนค่าเป็นภาษาของข้อมูลนี้ ข้อความธรรมดา รายการสิทธิประโยชน์ที่เรียงลำดับแล้วไม่เกิน 4 รายการ
description

string

คำอธิบายของการสมัครใช้บริการนี้ในภาษาของข้อมูลนี้ ความยาวสูงสุด 80 อักขระ ข้อความธรรมดา

เมธอด

archive
(deprecated)

 เลิกใช้งานแล้ว: ระบบไม่รองรับการเก็บถาวรการติดตาม

batchGet

 อ่านการสมัครใช้บริการอย่างน้อย 1 รายการ

batchUpdate

 อัปเดตการสมัครใช้บริการแบบเป็นกลุ่ม

create

 สร้างการสมัครใช้บริการใหม่

delete

 ลบการสมัครใช้บริการ

get

 อ่านการสมัครใช้บริการรายการเดียว

list

 แสดงรายการการสมัครใช้บริการทั้งหมดภายใต้แอปที่ระบุ

patch

 อัปเดตการสมัครใช้บริการที่มีอยู่