REST Resource: purchases.subscriptions

משאב: צירוף משתמשים למינוי

משאב מסוג צירוף משתמשים למינויים מציין את הסטטוס של רכישת מינוי של המשתמש.

ייצוג 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 של שירות Android Publisher.
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)

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

פרטי מחיר היכרות

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

ייצוג 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" (6 חודשים) ו-"P1Y" (שנה אחת).
introductoryPriceCycles

integer

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

תוצאת הביטול של המינוי

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

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

integer

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

string

סיבת הביטול של הקלט המותאם אישית מהמשתמש. יש להציג את הפרמטר הזה רק אם ערך הסיבה לביטול הוא 0.

שינוי מחיר המינוי

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

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

object (Price)

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

integer

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

שיטות

acknowledge

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

cancel

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

defer

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

get

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

refund

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

revoke

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