REST Resource: purchases.subscriptionsv2

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

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

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

การแสดง JSON 
{
  "kind": string,
  "regionCode": string,
  "latestOrderId": string,
  "lineItems": [
    {
      object (SubscriptionPurchaseLineItem)
    }
  ],
  "startTime": string,
  "subscriptionState": enum (SubscriptionState),
  "linkedPurchaseToken": string,
  "pausedStateContext": {
    object (PausedStateContext)
  },
  "canceledStateContext": {
    object (CanceledStateContext)
  },
  "testPurchase": {
    object (TestPurchase)
  },
  "acknowledgementState": enum (AcknowledgementState),
  "externalAccountIdentifiers": {
    object (ExternalAccountIdentifiers)
  },
  "subscribeWithGoogleInfo": {
    object (SubscribeWithGoogleInfo)
  }
}
ช่อง
kind

string

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

string

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

string

รหัสคําสั่งซื้อของคําสั่งซื้อล่าสุดที่เชื่อมโยงกับการซื้อการสมัครใช้บริการ สําหรับการสมัครใช้บริการแบบต่ออายุใหม่อัตโนมัติ นี่คือรหัสคําสั่งซื้อของคําสั่งซื้อการลงชื่อสมัครใช้หากยังไม่ได้ต่ออายุ หรือรหัสคําสั่งซื้อแบบเป็นลําดับสุดท้าย (สําเร็จ รอดําเนินการ หรือปฏิเสธคําสั่งซื้อ) สําหรับการสมัครใช้บริการแบบชําระเงินล่วงหน้า นี่คือรหัสคําสั่งซื้อที่เชื่อมโยงกับโทเค็นการซื้อที่ค้นหา
lineItems[]

object (SubscriptionPurchaseLineItem)

ข้อมูลระดับสินค้าสําหรับการซื้อการสมัครใช้บริการ สินค้าที่ซื้อในคราวเดียวควรทั้งหมดโดยใช้ AutoRenewingPlan หรือสินค้าทั้งหมดที่มี PrepaidPlan
startTime

string (Timestamp format)

เวลาที่อนุญาตให้มีการสมัครใช้บริการ ไม่ได้ตั้งค่าสําหรับการสมัครใช้บริการที่รอดําเนินการ (มีการสมัครใช้บริการแต่กําลังรอการชําระเงินระหว่างลงชื่อสมัครใช้)

การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "ซูลู" ที่มีความละเอียดในระดับนาโนวินาทีและอาจใช้ตัวเลขไม่เกิน 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"
subscriptionState

enum (SubscriptionState)

สถานะปัจจุบันของการสมัครใช้บริการ
linkedPurchaseToken

string

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

object (PausedStateContext)

บริบทเพิ่มเติมเกี่ยวกับการสมัครใช้บริการที่หยุดชั่วคราว แสดงเมื่อการสมัครใช้บริการตอนนี้มี subscriptionState SUBSCRIPTION_state_PAused เท่านั้น
canceledStateContext

object (CanceledStateContext)

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

object (TestPurchase)

แสดงเมื่อการซื้อการสมัครใช้บริการนี้เป็นการซื้อทดสอบเท่านั้น
acknowledgementState

enum (AcknowledgementState)

สถานะการรับทราบของการสมัครใช้บริการ
externalAccountIdentifiers

object (ExternalAccountIdentifiers)

ตัวระบุบัญชีผู้ใช้ในบริการของบุคคลที่สาม
subscribeWithGoogleInfo

object (SubscribeWithGoogleInfo)

โปรไฟล์ผู้ใช้ที่เชื่อมโยงกับการซื้อที่ดําเนินการด้วย "สมัครผ่าน Google"

สถานะการติดตาม

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

Enum
SUBSCRIPTION_STATE_UNSPECIFIED สถานะการสมัครใช้บริการที่ไม่ระบุ
SUBSCRIPTION_STATE_PENDING สร้างการสมัครใช้บริการแล้ว แต่รอการชําระเงินระหว่างลงชื่อสมัครใช้ อยู่ในสถานะนี้ สินค้าทั้งหมดกําลังรอการชําระเงิน
SUBSCRIPTION_STATE_ACTIVE การสมัครใช้บริการทํางานอยู่ - (1) หากการสมัครใช้บริการเป็นแพ็กเกจต่ออายุใหม่อัตโนมัติ จะมีอย่างน้อย 1 รายการที่ระบบต่ออายุโดยอัตโนมัติและยังไม่หมดอายุ - (2) หากการสมัครใช้บริการเป็นแพ็กเกจแบบชําระเงินล่วงหน้า อย่างน้อยอีก 1 รายการจะไม่หมดอายุ
SUBSCRIPTION_STATE_PAUSED การสมัครใช้บริการหยุดชั่วคราว รัฐจะใช้ได้กับการสมัครใช้บริการเป็นแพ็กเกจต่ออายุใหม่อัตโนมัติเท่านั้น และไม่ว่าในสถานะนี้ สินค้าทั้งหมดจะอยู่ในสถานะหยุดชั่วคราว
SUBSCRIPTION_STATE_IN_GRACE_PERIOD การสมัครใช้บริการอยู่ในช่วงระยะเวลาผ่อนผัน รัฐจะใช้ได้กับการสมัครใช้บริการเป็นแพ็กเกจต่ออายุใหม่อัตโนมัติเท่านั้น อยู่ในสถานะนี้ สินค้าทั้งหมดอยู่ในระยะเวลาผ่อนผัน
SUBSCRIPTION_STATE_ON_HOLD การสมัครใช้บริการถูกระงับ (ถูกระงับ) รัฐจะใช้ได้กับการสมัครใช้บริการเป็นแพ็กเกจต่ออายุใหม่อัตโนมัติเท่านั้น ในรายการนี้ ระบบจะระงับทุกรายการ
SUBSCRIPTION_STATE_CANCELED การสมัครใช้บริการถูกยกเลิกแต่ยังไม่หมดอายุ รัฐจะใช้ได้กับการสมัครใช้บริการเป็นแพ็กเกจต่ออายุใหม่อัตโนมัติเท่านั้น รายการทั้งหมดมีการตั้งค่า autoRenewEnabled เป็น "เท็จ"
SUBSCRIPTION_STATE_EXPIRED การสมัครใช้บริการหมดอายุแล้ว สินค้าทุกรายการมีวันหมดอายุหมดอายุ

หยุดข้อความตามบริบทชั่วคราว

ข้อมูลเฉพาะสําหรับการสมัครใช้บริการในสถานะหยุดชั่วคราว

การแสดง JSON 
{
  "autoResumeTime": string
}
ช่อง
autoResumeTime

string (Timestamp format)

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

การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "ซูลู" ที่มีความละเอียดในระดับนาโนวินาทีและอาจใช้ตัวเลขไม่เกิน 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"

ข้อความสถานะที่ยกเลิก

ข้อมูลเฉพาะสําหรับการสมัครใช้บริการในสถานะที่ยกเลิก

การแสดง JSON 
{

  // Union field cancellation_reason can be only one of the following:
  "userInitiatedCancellation": {
    object (UserInitiatedCancellation)
  },
  "systemInitiatedCancellation": {
    object (SystemInitiatedCancellation)
  },
  "developerInitiatedCancellation": {
    object (DeveloperInitiatedCancellation)
  },
  "replacementCancellation": {
    object (ReplacementCancellation)
  }
  // End of list of possible types for union field cancellation_reason.
}
ช่อง
ช่อง Union cancellation_reason เหตุผลที่การสมัครใช้บริการถูกยกเลิก cancellation_reason ต้องเป็นอย่างใดอย่างหนึ่งต่อไปนี้เท่านั้น
userInitiatedCancellation

object (UserInitiatedCancellation)

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

object (SystemInitiatedCancellation)

การสมัครใช้บริการถูกยกเลิกโดยระบบ เช่น ปัญหาเกี่ยวกับการเรียกเก็บเงิน
developerInitiatedCancellation

object (DeveloperInitiatedCancellation)

การสมัครใช้บริการถูกยกเลิกโดยนักพัฒนาแอป
replacementCancellation

object (ReplacementCancellation)

มีการแทนที่การสมัครใช้บริการใหม่

ผู้ใช้ยกเลิกแล้ว

ข้อมูลเฉพาะสําหรับการยกเลิกที่เริ่มโดยผู้ใช้

การแสดง JSON 
{
  "cancelSurveyResult": {
    object (CancelSurveyResult)
  },
  "cancelTime": string
}
ช่อง
cancelSurveyResult

object (CancelSurveyResult)

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

string (Timestamp format)

เวลาที่ผู้ใช้ยกเลิกการสมัครใช้บริการ ผู้ใช้อาจยังมีสิทธิ์เข้าถึงการสมัครใช้บริการหลังวันดังกล่าว ใช้ lineItems.expiry_time เพื่อระบุว่าผู้ใช้ยังคงมีสิทธิ์เข้าถึงหรือไม่

การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "ซูลู" ที่มีความละเอียดในระดับนาโนวินาทีและอาจใช้ตัวเลขไม่เกิน 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"

ยกเลิกผลการสํารวจ

ผลจากการยกเลิกแบบสํารวจเมื่อผู้ใช้ยกเลิกการสมัครใช้บริการ

การแสดง JSON 
{
  "reason": enum (CancelSurveyReason),
  "reasonUserInput": string
}
ช่อง
reason

enum (CancelSurveyReason)

เหตุผลที่ผู้ใช้เลือกในแบบสํารวจการยกเลิก
reasonUserInput

string

ตั้งไว้สําหรับ LINK_SURVEY_REASON_OTHERS เท่านั้น นี่คือคําตอบรูปแบบอิสระแบบสํารวจ

เหตุผลการยกเลิกแบบสํารวจ

เหตุผลที่ผู้ใช้เลือกในแบบสํารวจการยกเลิก

Enum
CANCEL_SURVEY_REASON_UNSPECIFIED ไม่ระบุเหตุผลการยกเลิกแบบสํารวจ
CANCEL_SURVEY_REASON_NOT_ENOUGH_USAGE การสมัครใช้บริการไม่เพียงพอ
CANCEL_SURVEY_REASON_TECHNICAL_ISSUES ปัญหาทางเทคนิคขณะใช้แอป
CANCEL_SURVEY_REASON_FOUND_BETTER_APP ผู้ใช้พบแอปที่ดีกว่า
CANCEL_SURVEY_REASON_OTHERS เหตุผลอื่นๆ

ยกเลิกระบบแล้ว

ข้อมูลเฉพาะสําหรับการยกเลิกที่ดําเนินการโดยระบบ Google

ยกเลิกโดยนักพัฒนาซอฟต์แวร์

ข้อมูลเฉพาะเกี่ยวกับการยกเลิกที่เริ่มโดยนักพัฒนาแอป

การยกเลิกการจองอุปกรณ์เปลี่ยนทดแทน

ข้อมูลเฉพาะสําหรับการยกเลิกที่เกิดจากการแทนที่การสมัครใช้บริการ

ทดสอบการซื้อ

การซื้อการสมัครใช้บริการนี้เป็นการซื้อทดสอบหรือไม่

สถานะรับทราบ

รับทราบสถานะการสมัครใช้บริการที่เป็นไปได้

Enum
ACKNOWLEDGEMENT_STATE_UNSPECIFIED สถานะการรับทราบที่ไม่ระบุ
ACKNOWLEDGEMENT_STATE_PENDING การสมัครใช้บริการยังไม่ได้รับการยอมรับ
ACKNOWLEDGEMENT_STATE_ACKNOWLEDGED รับทราบการสมัครใช้บริการแล้ว

ตัวระบุบัญชีภายนอก

ตัวระบุบัญชีผู้ใช้ในบริการของบุคคลที่สาม

การแสดง JSON 
{
  "externalAccountId": string,
  "obfuscatedExternalAccountId": string,
  "obfuscatedExternalProfileId": string
}
ช่อง
externalAccountId

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 เมื่อซื้อเท่านั้น

สมัครผ่าน GoogleInfo

ข้อมูลที่เชื่อมโยงกับการซื้อที่ดําเนินการด้วย "สมัครผ่าน Google"

การแสดง JSON 
{
  "profileId": string,
  "profileName": string,
  "emailAddress": string,
  "givenName": string,
  "familyName": string
}
ช่อง
profileId

string

รหัสโปรไฟล์ Google ของผู้ใช้เมื่อซื้อการสมัครใช้บริการ
profileName

string

ชื่อโปรไฟล์ของผู้ใช้เมื่อซื้อการสมัครใช้บริการ
emailAddress

string

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

string

ชื่อที่กําหนดของผู้ใช้เมื่อซื้อการสมัครใช้บริการ
familyName

string

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

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

ข้อมูลระดับสินค้าสําหรับการซื้อการสมัครใช้บริการ

การแสดง JSON 
{
  "productId": string,
  "expiryTime": string,

  // Union field plan_type can be only one of the following:
  "autoRenewingPlan": {
    object (AutoRenewingPlan)
  },
  "prepaidPlan": {
    object (PrepaidPlan)
  }
  // End of list of possible types for union field plan_type.
  "offerDetails": {
    object (OfferDetails)
  }
}
ช่อง
productId

string

รหัสผลิตภัณฑ์ที่ซื้อ (เช่น "month001")
expiryTime

string (Timestamp format)

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

การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "ซูลู" ที่มีความละเอียดในระดับนาโนวินาทีและอาจใช้ตัวเลขไม่เกิน 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"
ช่อง Union plan_type ประเภทแพ็กเกจการสมัครใช้บริการ plan_type ต้องเป็นอย่างใดอย่างหนึ่งต่อไปนี้เท่านั้น
autoRenewingPlan

object (AutoRenewingPlan)

รายการดังกล่าวเป็นการต่ออายุอัตโนมัติ
prepaidPlan

object (PrepaidPlan)

รายการนี้เป็นแบบชําระล่วงหน้า
offerDetails

object (OfferDetails)

รายละเอียดข้อเสนอสําหรับรายการนี้

แพ็กเกจต่ออายุใหม่อัตโนมัติ

ข้อมูลเกี่ยวกับแพ็กเกจการต่ออายุใหม่อัตโนมัติ

การแสดง JSON 
{
  "autoRenewEnabled": boolean,
  "priceChangeDetails": {
    object (SubscriptionItemPriceChangeDetails)
  }
}
ช่อง
autoRenewEnabled

boolean

หากการสมัครใช้บริการปัจจุบันตั้งค่าเป็นการต่ออายุอัตโนมัติอยู่ เช่น ผู้ใช้ไม่ได้ยกเลิกการสมัครใช้บริการ
priceChangeDetails

object (SubscriptionItemPriceChangeDetails)

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

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

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

การแสดง JSON 
{
  "newPrice": {
    object (Money)
  },
  "priceChangeMode": enum (PriceChangeMode),
  "priceChangeState": enum (PriceChangeState),
  "expectedNewPriceChargeTime": string
}
ช่อง
newPrice

object (Money)

ราคาที่เรียกเก็บประจําสําหรับรายการการสมัครใช้บริการ
priceChangeMode

enum (PriceChangeMode)

โหมดการเปลี่ยนแปลงราคาจะระบุการเปลี่ยนแปลงของราคาการสมัครใช้บริการ
priceChangeState

enum (PriceChangeState)

ระบุการเปลี่ยนแปลงราคาในปัจจุบัน
expectedNewPriceChargeTime

string (Timestamp format)

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

การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "ซูลู" ที่มีความละเอียดในระดับนาโนวินาทีและอาจใช้ตัวเลขไม่เกิน 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"

โหมดการเปลี่ยนแปลงราคา

โหมดของการเปลี่ยนแปลงราคา

Enum
PRICE_CHANGE_MODE_UNSPECIFIED ไม่ได้ระบุโหมดการเปลี่ยนแปลงราคา ไม่ควรมีการตั้งค่านี้
PRICE_DECREASE หากค่าสมัครใช้บริการลดลง
PRICE_INCREASE หากการสมัครใช้บริการมีราคาสูงขึ้นและผู้ใช้ต้องยอมรับการสมัครใช้บริการ

สถานะการเปลี่ยนแปลงราคา

สถานะของการเปลี่ยนแปลงราคา

Enum
PRICE_CHANGE_STATE_UNSPECIFIED ไม่ได้ระบุสถานะการเปลี่ยนแปลงราคา ไม่ควรใช้ค่านี้
OUTSTANDING กําลังรอให้ผู้ใช้ยอมรับการเปลี่ยนแปลงราคา
CONFIRMED การเปลี่ยนแปลงราคาจะเกิดขึ้นกับผู้ใช้
APPLIED การเปลี่ยนแปลงราคาจะมีผลแล้ว กล่าวคือ ผู้ใช้เริ่มเรียกเก็บค่าบริการในราคาใหม่

แพ็กเกจชําระล่วงหน้า

ข้อมูลเกี่ยวกับแพ็กเกจแบบชําระเงินล่วงหน้า

การแสดง JSON 
{
  "allowExtendAfterTime": string
}
ช่อง
allowExtendAfterTime

string (Timestamp format)

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

การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "ซูลู" ที่มีความละเอียดในระดับนาโนวินาทีและอาจใช้ตัวเลขไม่เกิน 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"

รายละเอียดข้อเสนอ

ข้อมูลรายละเอียดข้อเสนอที่เกี่ยวข้องกับรายการโฆษณาที่ซื้อ

การแสดง JSON 
{
  "offerTags": [
    string
  ],
  "basePlanId": string,
  "offerId": string
}
ช่อง
offerTags[]

string

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

string

รหัสแพ็กเกจเริ่มต้น แสดงสําหรับแพ็กเกจเริ่มต้นและข้อเสนอทั้งหมด
offerId

string

รหัสข้อเสนอ แสดงเฉพาะในข้อเสนอส่วนลด

วิธีการ

get

 รับข้อมูลเมตาเกี่ยวกับการสมัครใช้บริการ