REST Resource: purchases.subscriptions

ทรัพยากร: SubscriptionPurchase

ทรัพยากร SubscriptionPurchase จะระบุสถานะการซื้อการสมัครใช้บริการของผู้ใช้

การแสดง 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 สำหรับราคาการสมัครใช้บริการ เช่น หากระบุราคาเป็นสกุลเงินปอนด์สเตอร์ลิงของสหราชอาณาจักร priceCurrencyCode จะเป็น "GBP"
priceAmountMicros

string (int64 format)

ราคาการสมัครใช้บริการ สำหรับประเทศที่ไม่มีภาษี ราคาจะยังไม่รวมภาษี สำหรับประเทศที่รวมภาษีแล้ว ราคาจะรวมภาษีด้วย ราคาจะแสดงเป็นหน่วยไมโคร โดยที่ 1,000,000 หน่วยไมโครแสดงถึงสกุลเงิน 1 หน่วย เช่น หากราคาการสมัครใช้บริการคือ €1.99 ค่า priceAmountMicros จะเป็น 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)

เวลาที่ผู้ใช้ยกเลิกการสมัครใช้บริการเป็นมิลลิวินาทีนับจากจุดเริ่มต้น แสดงเฉพาะในกรณีที่ cancelReason เป็น 0
cancelSurveyResult

object (SubscriptionCancelSurveyResult)

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

string

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

string

โทเค็นการซื้อของการซื้อครั้งแรกเริ่มหากการสมัครใช้บริการนี้เป็นหนึ่งในรายการต่อไปนี้ 0 ลงชื่อสมัครใช้บริการที่ยกเลิกไปแล้วแต่ยังไม่สิ้นสุดลงอีกครั้ง 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. รับทราบแล้ว
externalAccountId

string

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

integer

ประเภทโปรโมชันที่ใช้กับการซื้อครั้งนี้ ระบบจะตั้งค่าช่องนี้เฉพาะในกรณีที่ใช้โปรโมชันเมื่อซื้อการสมัครใช้บริการเท่านั้น ค่าที่เป็นไปได้คือ 0 รหัสแบบครั้งเดียว 1. รหัส Vanity
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 เมื่อทำการซื้อ

IntroductoryPriceInfo

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

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

string

รหัสสกุลเงิน ISO 4217 สำหรับราคาค่าสมัครใช้บริการช่วงแนะนำ เช่น หากระบุราคาเป็นเงินปอนด์สเตอร์ลิงของสหราชอาณาจักร priceCurrencyCode จะเป็น "GBP"
introductoryPriceAmountMicros

string (int64 format)

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

string

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

integer

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

SubscriptionCancelSurveyResult

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

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

integer

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

string

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

SubscriptionPriceChange

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

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

object (Price)

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

integer

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

เมธอด

acknowledge

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

cancel

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

defer

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

get
(deprecated)

 เลิกใช้งานแล้ว: ใช้ purchases.subscriptionsv2.get แทน

refund
(deprecated)

 เลิกใช้งานแล้ว: ใช้ orders.refund แทน

revoke
(deprecated)

 เลิกใช้งานแล้ว: ใช้ purchases.subscriptionsv2.revoke แทน