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.99 priceAmountMicros จะเป็น 1990,000
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 แสดงเมื่อ 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 รหัสที่กำหนดเอง
promotionCode

string

รหัสโปรโมชันที่ใช้กับการซื้อนี้ ช่องนี้จะกำหนดเมื่อมีการใช้โปรโมชันรหัสโปรโมชันเมื่อซื้อการสมัครใช้บริการเท่านั้น
obfuscatedExternalAccountId

string

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

string

รหัสเวอร์ชันที่ปรับให้ยากต่อการอ่าน (Obfuscate) ซึ่งเชื่อมโยงกับโปรไฟล์ของผู้ใช้ในแอปของคุณโดยไม่ซ้ำกัน แสดงหากระบุโดยใช้ 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.99 priceAmountMicros จะเป็น 1990,000
introductoryPricePeriod

string

ระยะเวลาราคาช่วงแนะนำที่ระบุในรูปแบบ ISO 8601 ค่าทั่วไปคือ (แต่ไม่จำกัดเพียง) "P1W" (1 สัปดาห์), "P1M" (หนึ่งเดือน), "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

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

refund

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

revoke

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