REST Resource: purchases.subscriptions

משאב: SubscriptionPurchase

משאב SubscribePurchase מציין את הסטטוס של רכישת מינוי על ידי משתמש.

ייצוג 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)

השעה שבה הוענק המינוי, באלפיות השנייה מאז תחילת התקופה.
expiryTimeMillis

string (int64 format)

השעה שבה יפוג תוקף המינוי, באלפיות שנייה מאז Epoch.
autoResumeTimeMillis

string (int64 format)

השעה שבה המינוי יחודש באופן אוטומטי, באלפיות השנייה מאז תחילת התקופה. מוצג רק אם המשתמש ביקש להשהות את המינוי.
autoRenewing

boolean

האם המינוי יחודש באופן אוטומטי כשיפוג התוקף הנוכחי שלו.
priceCurrencyCode

string

קוד מטבע לפי תקן ISO 4217 של מחיר המינוי. לדוגמה, אם המחיר צוין בלירה שטרלינג בריטית, priceCurrencyCode הוא 'GBP'.
priceAmountMicros

string (int64 format)

מחיר המינוי. במדינות שלא כוללות מס, המחיר לא כולל מס. במדינות שכוללות מיסים, המחיר כולל מס. המחיר מבוטא ביחידות מיקרו, כאשר 1,000,000 מיקרו יחידות מייצגת יחידה אחת של המטבע. לדוגמה, אם מחיר המינוי הוא 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)

השעה שבה המינוי בוטל על ידי המשתמש, באלפיות שנייה מתחילת התקופה. מוצג רק אם הסיבה לביטול היא 0.
cancelSurveyResult

object (SubscriptionCancelSurveyResult)

מידע שהמשתמש מספק כשהוא משלים את תהליך ביטול המינוי (סקר סיבת הביטול).
orderId

string

מזהה ההזמנה של ההזמנה החוזרת האחרונה שמשויכת לרכישת המינוי. אם המינוי בוטל כי התשלום נדחה, זה יהיה מזהה ההזמנה מהתשלום שנדחתה.
linkedPurchaseToken

string

אסימון הרכישה של הרכישה המקורית אם המינוי הזה הוא אחד מהבאים: 0. הרשמה מחדש של מינוי שבוטל אבל לא בתוקף 1. שדרוג או שדרוג לאחור של מינוי קודם

לדוגמה, נניח שמשתמש נרשם במקור וקיבלתם אסימון רכישה X, אז המשתמש מבטל את ההרשמה מחדש ועובר את תהליך ההרשמה מחדש (לפני שפג התוקף של המינוי שלו) וקיבלתם את אסימון הרכישה Y, ולבסוף המשתמש משדרג את המינוי שלו וקיבלתם את אסימון הרכישה ג'. אם תתבצע קריאה ל-API הזה עם אסימון רכישה Z, השדה הזה יוגדר להיות Y. אם תתבצע קריאה ל-API הזה עם אסימון רכישה Y, השדה הזה יוגדר להיות X. אם תתבצע קריאה ל-API הזה עם אסימון רכישה X, השדה הזה לא יוגדר.
purchaseType

integer

סוג רכישת המינוי. השדה הזה מוגדר רק אם הרכישה הזו לא בוצעה באמצעות התהליך הרגיל של חיוב על רכישות באפליקציות. הערכים האפשריים הם: 0. בדיקה (כלומר, נרכש מחשבון לבדיקת רישיון) 1. מבצע (כלומר, הפריט נרכש באמצעות קוד הטבה)
priceChange

object (SubscriptionPriceChange)

יש מידע עדכני על השינוי במחיר. האפשרות הזו מופיעה רק אם מחיר המינוי ישתנה בקרוב.

ברגע שהמינוי יתחדש במחיר החדש או אם המינוי יבוטל, לא יוחזר מידע על שינויים במחיר.
profileName

string

שם הפרופיל של המשתמש בזמן רכישת המינוי. מוצג רק לרכישות שבוצעו באמצעות Subscribe with Google.
emailAddress

string

כתובת האימייל של המשתמש בזמן רכישת המינוי. מוצג רק לרכישות שבוצעו באמצעות Subscribe with Google.
givenName

string

השם הפרטי של המשתמש בזמן רכישת המינוי. מוצג רק לרכישות שבוצעו באמצעות Subscribe with Google.
familyName

string

שם המשפחה של המשתמש בזמן רכישת המינוי. מוצג רק לרכישות שבוצעו באמצעות Subscribe with Google.
profileId

string

מזהה פרופיל Google של המשתמש כשהמינוי נרכש. מוצג רק לרכישות שבוצעו באמצעות Subscribe with Google.
acknowledgementState

integer

מצב האישור של מוצר המינוי. הערכים האפשריים הם: 0. עדיין לא אישרנו 1. התקבל אישור
externalAccountId

string

מזהה חשבון המשתמש בשירות הצד השלישי. מוצג רק אם בוצע קישור של החשבון כחלק מתהליך רכישת המינוי.
promotionType

integer

סוג המבצע שהוחל על הרכישה הזו. השדה הזה מוגדר רק אם חל מבצע בזמן רכישת המינוי. הערכים האפשריים הם: 0. קוד חד-פעמי 1. קוד שידת איפור
promotionCode

string

קוד השובר שהוחל על הרכישה הזו. השדה הזה מוגדר רק אם חל קידום מכירות עם קוד שם בעת רכישת המינוי.
obfuscatedExternalAccountId

string

גרסה עם ערפול קוד (obfuscated) של המזהה שמשויכת באופן ייחודי לחשבון המשתמש באפליקציה שלכם. הצגה ברכישות הבאות: * אם קישור החשבונות בוצע כחלק מתהליך רכישת המינוי. * הוא צוין באמצעות 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.99€, ה-priceAmountMicros הוא 1990000.
introductoryPricePeriod

string

תקופה של מחיר היכרות, המצוינת בפורמט ISO 8601. הערכים הנפוצים הם (בין היתר) "P1W" (שבוע אחד), "P1M" (חודש אחד), "P3M" (שלושה חודשים), "P6M" (שישה חודשים) ו-P1Y (שנה אחת).
introductoryPriceCycles

integer

מספר תקופת החיוב שבה ניתן להציע מחיר היכרות.

SubscriptionCancelSurveyResult

מידע שהמשתמש מספק כשהוא משלים את תהליך ביטול המינוי (סקר סיבת הביטול).

ייצוג JSON 
{
  "cancelSurveyReason": integer,
  "userInputCancelReason": string
}
שדות
cancelSurveyReason

integer

סיבת הביטול שהמשתמש בחר בסקר. הערכים האפשריים הם: 0. אחר 1. השירות הזה לא משמש אותי מספיק 2. בעיות טכניות 3. סיבות שקשורות לעלויות 4. מצאתי אפליקציה טובה יותר
userInputCancelReason

string

סיבת הביטול של הקלט המותאם אישית על ידי המשתמש. מוצג רק כשהסיבה לביטול היא 0.

SubscriptionPriceChange

מכיל את פרטי השינוי במחיר של מינוי, שיכולים לשמש כדי לשלוט בתהליך שעובר המשתמש עד לשינוי המחיר באפליקציה. הדרך לעשות את זה היא לבקש אישור מהמשתמש או להתאים את החוויה להשגת המרה מוצלחת.

ייצוג JSON 
{
  "newPrice": {
    object (Price)
  },
  "state": integer
}
שדות
newPrice

object (Price)

המחיר החדש שבו המינוי יחודש אם המשתמש יאשר את השינוי במחיר.
state

integer

המצב הנוכחי של השינוי במחיר. הערכים האפשריים הם: 0. בהמתנה: מצוין אם יש שינוי במחיר בהמתנה לאישור המשתמש. במצב הזה, ניתן לבקש אישור מהמשתמש באמצעות In-App API. 1. אושר: מצוין בהם אם המחיר ישתנה אם המינוי יחודש, אלא אם הוא יבוטל. השינוי במחיר ייכנס לתוקף בתאריך עתידי שבו המינוי יחודש. לתשומת ליבך: יכול להיות שהשינוי לא יתבצע במועד החידוש הבא של המינוי.

שיטות

acknowledge

 אישור רכישה של מינוי.

cancel

 מבטל את רכישת המינוי של משתמש.

defer

 דחיית רכישת המינוי של המשתמש עד למועד תפוגה עתידי שצוין.

get

 הפונקציה בודקת אם רכישת המינוי של המשתמש תקפה ומחזירה את תאריך התפוגה שלה.

refund

 מתבצע החזר כספי על רכישת מינוי של משתמש, אבל המינוי נשאר בתוקף עד למועד התפוגה שלו, והוא ימשיך להתחדש.

revoke

 קבלת החזר כספי וביטול מיידי של רכישת מינוי של משתמש.