REST Resource: purchases.subscriptions

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

แหล่งข้อมูลการสมัครใช้บริการจะระบุสถานะของการซื้อการสมัครใช้บริการของผู้ใช้

การแสดง JSON 
{
  "kind": string,
  "startTimeMillis": string,
  "expiryTimeMillis": string,
  "autoResumeTimeMillis": string,
  "autoRenewing": boolean,
  "priceCurrencyCode": string,
  "priceAmountMicros": string,
  "introductoryPriceInfo": {
    object (IntroductoryPriceInfo)
  },
  "countryCode": string,
  "developerPayload": string,
  "paymentState": integer,
  "cancelReason": integer,
  "userCancellationTimeMillis": string,
  "cancelSurveyResult": {
    object (SubscriptionCancelSurveyResult)
  },
  "orderId": string,
  "linkedPurchaseToken": string,
  "purchaseType": integer,
  "priceChange": {
    object (SubscriptionPriceChange)
  },
  "profileName": string,
  "emailAddress": string,
  "givenName": string,
  "familyName": string,
  "profileId": string,
  "acknowledgementState": integer,
  "externalAccountId": string,
  "promotionType": integer,
  "promotionCode": string,
  "obfuscatedExternalAccountId": string,
  "obfuscatedExternalProfileId": string
}
ช่อง
kind

string

ประเภทนี้แสดงถึงออบเจ็กต์ subscriptionpurchase ในบริการ androidpublisher
startTimeMillis

string (int64 format)

เวลาที่การสมัครใช้บริการ (หน่วยเป็นมิลลิวินาที) นับตั้งแต่ Epoch
expiryTimeMillis

string (int64 format)

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

string (int64 format)

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

boolean

การสมัครใช้บริการจะได้รับการต่ออายุโดยอัตโนมัติเมื่อใกล้ถึงวันหมดอายุหรือไม่
priceCurrencyCode

string

รหัสสกุลเงิน ISO 4217 ของค่าสมัครใช้บริการ เช่น หากระบุราคาเป็นเงินปอนด์สเตอร์ลิงอังกฤษ สกุลเงิน priceCurrency คือ "GBP"
priceAmountMicros

string (int64 format)

ราคาค่าสมัครใช้บริการ (ไม่รวมภาษี) สําหรับประเทศไม่รวมภาษี ราคายังไม่รวมภาษีในประเทศที่รวมภาษีแล้ว ราคาจะแสดงเป็นหน่วยไมโคร โดย 1,000,000 หน่วยไมโครจะแสดงหน่วยสกุลเงิน เช่น หากค่าสมัครใช้บริการคือ €1.99 ราคา priceAmount คือ 1990000
introductoryPriceInfo

object (IntroductoryPriceInfo)

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

ช่องนี้ไม่ได้ระบุว่าการสมัครใช้บริการอยู่ในช่วงราคาช่วงแนะนํา
countryCode

string

รหัสประเทศ/ภูมิภาคที่เรียกเก็บเงินของ ISO 3166-1 alpha-2 ของผู้ใช้ในขณะที่สมัครใช้บริการ
developerPayload

string

สตริงที่นักพัฒนาแอประบุซึ่งมีข้อมูลเพิ่มเติมเกี่ยวกับคําสั่งซื้อ
paymentState

integer

สถานะการชําระเงินของการสมัครใช้บริการ ค่าที่เป็นไปได้คือ 0 การชําระเงินที่รอดําเนินการ 1 ได้รับการชําระเงินแล้ว 2. ทดลองใช้ฟรี 3. รอเลื่อนการอัปเกรด/ดาวน์เกรด

ไม่มีสําหรับการสมัครใช้บริการที่ยกเลิกและหมดอายุ
cancelReason

integer

เหตุผลที่การสมัครใช้บริการถูกยกเลิกหรือไม่มีการต่ออายุใหม่อัตโนมัติ ค่าที่เป็นไปได้คือ 0 ผู้ใช้ยกเลิกการสมัครใช้บริการ 1 การสมัครใช้บริการถูกยกเลิกโดยระบบ เช่น เนื่องจากการเรียกเก็บเงินมีปัญหา 2 มีการแทนที่การสมัครใช้บริการใหม่ด้วยการสมัครใช้บริการใหม่ 3 การสมัครใช้บริการถูกยกเลิกโดยนักพัฒนาแอป
userCancellationTimeMillis

string (int64 format)

เวลาที่ผู้ใช้ยกเลิกการสมัครใช้บริการ หน่วยเป็นมิลลิวินาทีนับตั้งแต่ Epoch แสดงเมื่อยกเลิกเหตุผลเท่านั้นเป็น 0 เท่านั้น
cancelSurveyResult

object (SubscriptionCancelSurveyResult)

ข้อมูลที่ผู้ใช้ให้ไว้เมื่อผู้ใช้ดําเนินการยกเลิกการสมัครใช้บริการ (แบบสํารวจเหตุผลการยกเลิก)
orderId

string

รหัสคําสั่งซื้อของคําสั่งซื้อที่เกิดซ้ําล่าสุดซึ่งเชื่อมโยงกับการซื้อการสมัครใช้บริการ หากการสมัครใช้บริการถูกยกเลิกเนื่องจากการชําระเงินถูกปฏิเสธ นี่จะเป็นรหัสคําสั่งซื้อจากคําสั่งซื้อที่ถูกปฏิเสธการชําระเงิน
linkedPurchaseToken

string

โทเค็นการซื้อของการซื้อครั้งแรกหากการสมัครใช้บริการเป็นอย่างใดอย่างหนึ่งต่อไปนี้ ลงชื่อสมัครใช้การสมัครใช้บริการที่ยกเลิกแต่ยังไม่หมดอายุ 1 อัปเกรด/ดาวน์เกรดจากการสมัครใช้บริการก่อนหน้า

ตัวอย่างเช่น สมมติว่าตอนแรกผู้ใช้ลงชื่อสมัครใช้และคุณได้รับโทเค็นการซื้อ X ผู้ใช้ก็ยกเลิกและดําเนินการตามขั้นตอนการลงชื่อสมัครใช้อีกครั้ง (ก่อนการสมัครใช้บริการจะสิ้นสุดลง) และคุณจะได้รับโทเค็นการซื้อ Y และท้ายที่สุดผู้ใช้ก็จะอัปเกรดการสมัครใช้บริการและคุณได้รับโทเค็นการซื้อ Z หากคุณเรียกใช้ API นี้ด้วยโทเค็นการซื้อ Z ช่องนี้จะมีค่าเป็น Y หากคุณเรียกใช้ API ที่มีโทเค็นการซื้อ Y ช่องนี้จะมีค่าเป็น X หากคุณเรียกใช้ API นี้ด้วยโทเค็นการซื้อ X ระบบจะไม่ตั้งค่าช่องนี้
purchaseType

integer

ประเภทของการซื้อการสมัครใช้บริการ ช่องนี้จะมีการตั้งค่าเฉพาะในกรณีที่การซื้อนี้ไม่ได้ดําเนินการโดยใช้ขั้นตอนการเรียกเก็บเงินในแอปแบบมาตรฐาน ค่าที่เป็นไปได้คือ 0 ทดสอบ (เช่น ซื้อจากบัญชีทดสอบใบอนุญาต) 1. โปรโมชัน (เช่น ซื้อโดยใช้รหัสโปรโมชัน)
priceChange

object (SubscriptionPriceChange)

ข้อมูลการเปลี่ยนแปลงราคาล่าสุดที่มีอยู่ ซึ่งจะแสดงก็ต่อเมื่อมีการเปลี่ยนแปลงราคาค่าสมัครใช้บริการที่จะเกิดขึ้นเท่านั้น

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

string

ชื่อโปรไฟล์ของผู้ใช้เมื่อซื้อการสมัครใช้บริการ แสดงเฉพาะสําหรับการซื้อที่ดําเนินการด้วย 'สมัครผ่าน Google'
emailAddress

string

อีเมลของผู้ใช้เมื่อซื้อการสมัครใช้บริการ แสดงเฉพาะสําหรับการซื้อที่ดําเนินการด้วย 'สมัครผ่าน Google'
givenName

string

ชื่อที่กําหนดของผู้ใช้เมื่อซื้อการสมัครใช้บริการ แสดงเฉพาะสําหรับการซื้อที่ดําเนินการด้วย 'สมัครผ่าน Google'
familyName

string

นามสกุลของผู้ใช้เมื่อซื้อการสมัครใช้บริการ แสดงเฉพาะสําหรับการซื้อที่ดําเนินการด้วย 'สมัครผ่าน Google'
profileId

string

รหัสโปรไฟล์ Google ของผู้ใช้เมื่อซื้อการสมัครใช้บริการ แสดงเฉพาะสําหรับการซื้อที่ดําเนินการด้วย 'สมัครผ่าน Google'
acknowledgementState

integer

สถานะการรับทราบของผลิตภัณฑ์ที่ต้องสมัครใช้บริการ ค่าที่เป็นไปได้คือ 0 1. รับทราบ 1. ได้รับแล้ว
externalAccountId

string

ตัวระบุบัญชีผู้ใช้ในบริการของบุคคลที่สาม แสดงเมื่อการลิงก์บัญชีเกิดขึ้นในขั้นตอนการซื้อการสมัครใช้บริการเท่านั้น
promotionType

integer

ประเภทของโปรโมชันที่ใช้ในการซื้อนี้ ช่องนี้จะมีการตั้งค่าก็ต่อเมื่อมีการใช้โปรโมชันเมื่อซื้อการสมัครใช้บริการ ค่าที่เป็นไปได้คือ 0 รหัสแบบใช้ครั้งเดียว 1 รหัสแบบสั้น
promotionCode

string

รหัสโปรโมชันที่ใช้กับการซื้อนี้แล้ว ช่องนี้จะมีการตั้งค่าก็ต่อเมื่อมีการใช้โปรโมชันตามตัวอักษรเมื่อซื้อการสมัครใช้บริการ
obfuscatedExternalAccountId

string

รหัสเวอร์ชันที่ไม่ชัดเจนซึ่งเชื่อมโยงกับบัญชีของผู้ใช้ในแอปแบบไม่ซ้ํากัน นําเสนอสําหรับการซื้อต่อไปนี้: * หากการลิงก์บัญชีเกิดขึ้นในขั้นตอนการซื้อการสมัครใช้บริการ * ระบุโดยใช้ https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedaccountid ตอนที่ทําการซื้อ
obfuscatedExternalProfileId

string

รหัสเวอร์ชันที่สร้างความสับสนและเชื่อมโยงกับโปรไฟล์ของผู้ใช้ในแอปแบบไม่เหมือนใคร จะปรากฏก็ต่อเมื่อระบุโดยใช้ https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedprofileid เมื่อซื้อเท่านั้น

ข้อมูลราคาช่วงแนะนํา

มีข้อมูลราคาช่วงแนะนําสําหรับการสมัครใช้บริการ

การแสดง JSON 
{
  "introductoryPriceCurrencyCode": string,
  "introductoryPriceAmountMicros": string,
  "introductoryPricePeriod": string,
  "introductoryPriceCycles": integer
}
ช่อง
introductoryPriceCurrencyCode

string

รหัสสกุลเงิน ISO 4217 สําหรับราคาช่วงแนะนํา เช่น หากระบุราคาเป็นเงินปอนด์สเตอร์ลิงอังกฤษ สกุลเงิน priceCurrency คือ "GBP"
introductoryPriceAmountMicros

string (int64 format)

ราคาช่วงแนะนําของการสมัครใช้บริการ ไม่รวมภาษี สกุลเงินที่ใช้คือ priceCurrency ราคาจะแสดงเป็นหน่วยไมโคร โดย 1,000,000 หน่วยไมโครจะแสดงหน่วยสกุลเงิน เช่น หากค่าสมัครใช้บริการคือ €1.99 ราคา priceAmount คือ 1990000
introductoryPricePeriod

string

ระยะเวลาราคาช่วงแนะนําที่ระบุในรูปแบบ ISO 8601 ค่าทั่วไปคือ (แต่ไม่จํากัดเฉพาะ) "P1W" (1 สัปดาห์) "P1M" (1 เดือน) "P3M" (3 เดือน) "P6M" (6 เดือน) และ "P1Y" (1 ปี)
introductoryPriceCycles

integer

จํานวนช่วงเวลาที่เรียกเก็บเงินเพื่อเสนอราคาช่วงแนะนํา

ผลการยกเลิกการสํารวจการสมัครใช้บริการ

ข้อมูลที่ผู้ใช้ให้ไว้เมื่อผู้ใช้ดําเนินการยกเลิกการสมัครใช้บริการ (แบบสํารวจเหตุผลการยกเลิก)

การแสดง JSON 
{
  "cancelSurveyReason": integer,
  "userInputCancelReason": string
}
ช่อง
cancelSurveyReason

integer

เหตุผลการยกเลิกที่ผู้ใช้เลือกในแบบสํารวจ ค่าที่เป็นไปได้คือ 0 อื่นๆ 1. ฉันไม่ค่อยได้ใช้บริการนี้ 2. ปัญหาทางเทคนิค 3. เหตุผลเกี่ยวกับค่าใช้จ่าย 4. ฉันเจอแอปที่ดีกว่า
userInputCancelReason

string

อินพุตที่ปรับแต่งเองยกเลิกเหตุผลจากผู้ใช้ แสดงเมื่อยกเลิกเหตุผลเท่านั้นเป็น 0 เท่านั้น

การเปลี่ยนแปลงราคาการสมัครใช้บริการ

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

การแสดง JSON 
{
  "newPrice": {
    object (Price)
  },
  "state": integer
}
ช่อง
newPrice

object (Price)

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

integer

สถานะปัจจุบันของการเปลี่ยนแปลงราคา ค่าที่เป็นไปได้คือ 0 ค้างชําระ: สถานะการเปลี่ยนแปลงราคาที่รอดําเนินการเพื่อให้ผู้ใช้ยอมรับ ในกรณีนี้ คุณขอการยืนยันจากผู้ใช้ได้โดยใช้ API ในแอป 1. ยอมรับ: สถานะการเปลี่ยนแปลงราคาที่ยอมรับซึ่งจะมีการต่ออายุการสมัครใช้บริการ เว้นแต่จะมีการยกเลิก การเปลี่ยนแปลงราคาจะมีผลในอนาคตเมื่อมีการต่ออายุการสมัครใช้บริการ โปรดทราบว่าการเปลี่ยนแปลงจะไม่เกิดขึ้นเมื่อมีการต่ออายุการสมัครใช้บริการครั้งถัดไป

เมธอด

acknowledge

 รับทราบการซื้อการสมัครใช้บริการ

cancel

 ยกเลิกการสมัครใช้บริการของผู้ใช้

defer

 เลื่อนการซื้อการสมัครใช้บริการของผู้ใช้จนกว่าจะหมดอายุในอนาคต

get

 ตรวจสอบว่าการซื้อการสมัครใช้บริการของผู้ใช้ถูกต้องและส่งคืนเวลาหมดอายุหรือไม่

refund

 คืนเงินค่าสมัครใช้บริการของผู้ใช้ แต่การสมัครใช้บริการยังใช้ได้จนถึงวันที่หมดอายุและจะมีการชําระเงินซ้ําอีก

revoke

 คืนเงินและเพิกถอนการซื้อการสมัครใช้บริการของผู้ใช้ทันที