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)

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

autoResumeTimeMillis

string (int64 format)

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

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)

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

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

שיטות

acknowledge

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

cancel

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

defer

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

get

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

refund

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

revoke

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