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)

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

string (int64 format)

המועד שבו יפוג התוקף של המינוי, באלפיות שנייה מאז תחילת התקופה של זמן מערכת.
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)

הזמן שבו המשתמש ביטל את המינוי, באלפיות שנייה מאז תחילת המילניום. השדה הזה מופיע רק אם הערך של 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

שם הפרופיל של המשתמש בזמן רכישת המינוי. האפשרות הזו מוצגת רק לרכישות שבוצעו באמצעות '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

גרסה מעורפלת של המזהה שמשויך באופן ייחודי לחשבון של המשתמש באפליקציה. המזהה הזה מופיע ברכישות הבאות: * אם קישור החשבון התרחש כחלק מתהליך הרכישה של המינוי. * הוא צוין באמצעות 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

הסיבה בהתאמה אישית לביטול שהמשתמש הזין. השדה הזה מופיע רק כשהערך של cancelReason הוא 0.

SubscriptionPriceChange

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

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

object (Price)

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

integer

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

Methods

acknowledge

 אישור רכישת מינוי.

cancel

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

defer

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

get

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

refund

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

revoke

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