REST Resource: purchases.subscriptionsv2

משאב: SubscriptionPurchaseV2

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

ייצוג JSON 
{
  "kind": string,
  "regionCode": string,
  "lineItems": [
    {
      object (SubscriptionPurchaseLineItem)
    }
  ],
  "startTime": string,
  "subscriptionState": enum (SubscriptionState),
  "latestOrderId": string,
  "linkedPurchaseToken": string,
  "pausedStateContext": {
    object (PausedStateContext)
  },
  "canceledStateContext": {
    object (CanceledStateContext)
  },
  "testPurchase": {
    object (TestPurchase)
  },
  "acknowledgementState": enum (AcknowledgementState),
  "externalAccountIdentifiers": {
    object (ExternalAccountIdentifiers)
  },
  "subscribeWithGoogleInfo": {
    object (SubscribeWithGoogleInfo)
  }
}
שדות
kind

string

סוג זה מייצג אובייקט SubscriptionPurchaseV2 בשירות androidpublisher.
regionCode

string

קוד המדינה/האזור לחיוב לפי תקן ISO 3166-1 alpha-2 של המשתמש במועד שבו הוענק המינוי.
lineItems[]

object (SubscriptionPurchaseLineItem)

מידע ברמת הפריט לרכישת מינוי. כל הפריטים באותה רכישה צריכים להיכלל ב-AutoRenewingPlan או בכולם עם PrepaidPlan.
startTime

string (Timestamp format)

השעה שבה ניתנה המינוי. לא מוגדר למינויים בהמתנה (המינוי נוצר אבל ממתין לתשלום במהלך ההרשמה).

חותמת זמן בפורמט "זולו" RFC3339 UTC, ברזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".
subscriptionState

enum (SubscriptionState)

המצב הנוכחי של המינוי.
latestOrderId

string

מזהה ההזמנה של ההזמנה האחרונה המשויכת לרכישת המינוי. במינויים לחידוש אוטומטי, זהו מזהה ההזמנה של הזמנת ההרשמה אם היא עדיין לא חודשה, או מזהה ההזמנה החוזרת האחרונה (ההזמנה בוצעה בהצלחה, בהמתנה או נדחתה). עבור מינוי בתשלום מראש, זהו מזהה ההזמנה שמשויך לאסימון הרכישה שהשאילתה נשלחה אליו.
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'.

SubscriptionState

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

טיפוסים בני מנייה (enums)
SUBSCRIPTION_STATE_UNSPECIFIED מצב המינוי לא צוין.
SUBSCRIPTION_STATE_PENDING המינוי נוצר אבל ממתין לתשלום במהלך ההרשמה. במצב הזה, כל הפריטים נמצאים בהמתנה לתשלום.
SUBSCRIPTION_STATE_ACTIVE המינוי פעיל. - (1) אם המינוי הוא תוכנית שמתחדשת אוטומטית, לפחות פריט אחד במצב autoRenewEnabled ולא פג התוקף. - (2) אם המינוי הוא תוכנית בתשלום מראש, פג התוקף של לפחות פריט אחד.
SUBSCRIPTION_STATE_PAUSED המינוי מושהה. המדינה זמינה רק כשהמינוי הוא תוכנית מתחדשת אוטומטית. במצב הזה, כל הפריטים נמצאים במצב השהיה.
SUBSCRIPTION_STATE_IN_GRACE_PERIOD המינוי נמצא בתקופת חסד. המדינה זמינה רק כשהמינוי הוא תוכנית מתחדשת אוטומטית. במצב הזה, כל הפריטים נמצאים בתקופת חסד.
SUBSCRIPTION_STATE_ON_HOLD המינוי מושהה (מושעה). המדינה זמינה רק כשהמינוי הוא תוכנית מתחדשת אוטומטית. במצב הזה, כל הפריטים נמצאים בהמתנה.
SUBSCRIPTION_STATE_CANCELED המינוי בוטל אבל עדיין לא פג תוקפו. המדינה זמינה רק כשהמינוי הוא תוכנית מתחדשת אוטומטית. בכל הפריטים מוגדר הערך autoRenewEnabled כ-False.
SUBSCRIPTION_STATE_EXPIRED המינוי כבר לא בתוקף. לכל הפריטים יש expiryTime בעבר.

PausedStateContext

מידע ספציפי למינוי במצב מושהה.

ייצוג JSON 
{
  "autoResumeTime": string
}
שדות
autoResumeTime

string (Timestamp format)

השעה שבה המינוי יחודש באופן אוטומטי.

חותמת זמן בפורמט "זולו" RFC3339 UTC, ברזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".

CanceledStateContext

מידע ספציפי למינוי במצב מבוטל.

ייצוג 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.
}
שדות
שדה איחוד cancellation_reason. הסיבה לביטול המינוי. הערך של cancellation_reason יכול להיות רק אחת מהאפשרויות הבאות:
userInitiatedCancellation

object (UserInitiatedCancellation)

המינוי בוטל על ידי המשתמש.
systemInitiatedCancellation

object (SystemInitiatedCancellation)

המינוי בוטל על ידי המערכת, למשל בגלל בעיית חיוב.
developerInitiatedCancellation

object (DeveloperInitiatedCancellation)

המינוי בוטל על ידי המפתח.
replacementCancellation

object (ReplacementCancellation)

המינוי הוחלף במינוי חדש.

UserInitiatedCancellation

מידע ספציפי על ביטולים שהמשתמשים יזמו.

ייצוג JSON 
{
  "cancelSurveyResult": {
    object (CancelSurveyResult)
  },
  "cancelTime": string
}
שדות
cancelSurveyResult

object (CancelSurveyResult)

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

string (Timestamp format)

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

חותמת זמן בפורמט "זולו" RFC3339 UTC, ברזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".

CancelSurveyResult

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

ייצוג JSON 
{
  "reason": enum (CancelSurveyReason),
  "reasonUserInput": string
}
שדות
reason

enum (CancelSurveyReason)

הסיבה שבגללה המשתמש בחר בסקר הביטול.
reasonUserInput

string

מוגדר רק עבור CANCEL_SURVEY_REASON_OTHERS. זו התשובה החופשית של המשתמש לסקר.

CancelSurveyReason

הסיבה שבגללה המשתמש בחר בסקר הביטול.

טיפוסים בני מנייה (enums)
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 סיבות אחרות.

SystemInitiatedCancellation

אין שדות בסוג הזה.

מידע ספציפי על ביטולים שמערכת Google יזמה.

DeveloperInitiatedCancellation

אין שדות בסוג הזה.

מידע ספציפי על ביטולים שיזמו המפתחים.

ReplacementCancellation

אין שדות בסוג הזה.

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

TestPurchase

אין שדות בסוג הזה.

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

AcknowledgementState

מצבי האישור האפשריים של המינוי.

טיפוסים בני מנייה (enums)
ACKNOWLEDGEMENT_STATE_UNSPECIFIED מצב האישור לא צוין.
ACKNOWLEDGEMENT_STATE_PENDING עדיין לא התקבל אישור למינוי.
ACKNOWLEDGEMENT_STATE_ACKNOWLEDGED ההרשמה אושרה.

ExternalAccountIdentifiers

מזהה חשבון משתמש בשירות של הצד השלישי.

ייצוג 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 כשהרכישה בוצעה.

SubscribeWithGoogleInfo

מידע שמשויך לרכישות שבוצעו באמצעות התכונה Subscribe with Google.

ייצוג JSON 
{
  "profileId": string,
  "profileName": string,
  "emailAddress": string,
  "givenName": string,
  "familyName": string
}
שדות
profileId

string

מזהה הפרופיל ב-Google של המשתמש בעת רכישת המינוי.
profileName

string

שם הפרופיל של המשתמש כשהמינוי נרכש.
emailAddress

string

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

string

השם הנתון של המשתמש כשהמינוי נרכש.
familyName

string

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

SubscriptionPurchaseLineItem

מידע ברמת הפריט לרכישת מינוי.

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

  // Union field deferred_item_change can be only one of the following:
  "deferredItemReplacement": {
    object (DeferredItemReplacement)
  }
  // End of list of possible types for union field deferred_item_change.
}
שדות
productId

string

מזהה המוצר שנרכש (לדוגמה, 'month001').
expiryTime

string (Timestamp format)

הזמן שבו המינוי פג או שבו הוא יפקע, אלא אם הגישה תוארך (לדוגמה: מתחדשת).

חותמת זמן בפורמט "זולו" RFC3339 UTC, ברזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".
שדה איחוד plan_type. הסוג של תוכנית המינוי. הערך של plan_type יכול להיות רק אחת מהאפשרויות הבאות:
autoRenewingPlan

object (AutoRenewingPlan)

הפריט מתחדש אוטומטית.
prepaidPlan

object (PrepaidPlan)

הפריט שולם מראש.
offerDetails

object (OfferDetails)

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

object (DeferredItemReplacement)

מידע על החלפת פריט שנדחית.

AutoRenewingPlan

מידע שקשור לתוכנית מתחדשת אוטומטית.

ייצוג JSON 
{
  "autoRenewEnabled": boolean,
  "priceChangeDetails": {
    object (SubscriptionItemPriceChangeDetails)
  }
}
שדות
autoRenewEnabled

boolean

אם המינוי מוגדר כרגע לחידוש אוטומטי, למשל: המשתמש לא ביטל את המינוי
priceChangeDetails

object (SubscriptionItemPriceChangeDetails)

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

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, ברזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".

PriceChangeMode

המצב שבו המחיר משתנה.

טיפוסים בני מנייה (enums)
PRICE_CHANGE_MODE_UNSPECIFIED לא צוין מצב שינוי מחיר. אין להגדיר את הערך הזה אף פעם.
PRICE_DECREASE אם מחיר המינוי בירידה.
PRICE_INCREASE אם מחיר המינוי עולה והמשתמש צריך לאשר אותו.
OPT_OUT_PRICE_INCREASE אם מחיר המינוי עולה במצב ביטול ההסכמה.

PriceChangeState

מצב השינוי במחיר.

טיפוסים בני מנייה (enums)
PRICE_CHANGE_STATE_UNSPECIFIED לא צוין מצב השינוי במחיר. אין להשתמש בערך הזה.
OUTSTANDING בהמתנה שהמשתמש יסכים לשינוי במחיר.
CONFIRMED אנחנו בטוחים ששינוי המחיר יתבצע עבור המשתמש.
APPLIED השינוי במחיר חל, כלומר, המשתמש התחיל לחייב את המשתמש במחיר החדש.

PrepaidPlan

מידע שקשור למינוי בתשלום מראש.

ייצוג JSON 
{
  "allowExtendAfterTime": string
}
שדות
allowExtendAfterTime

string (Timestamp format)

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

חותמת זמן בפורמט "זולו" RFC3339 UTC, ברזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".

OfferDetails

מידע על פרטי המבצע שקשור לפריט שנרכש.

ייצוג JSON 
{
  "offerTags": [
    string
  ],
  "basePlanId": string,
  "offerId": string
}
שדות
offerTags[]

string

תגי המבצע האחרונים המשויכים למבצע. הוא כולל תגים שהועברו בירושה מהמינוי הבסיסי.
basePlanId

string

מזהה המינוי הבסיסי. הצגה בכל המינויים הבסיסיים והמבצעים.
offerId

string

מזהה המבצע. מוצג רק למבצעים בהנחה.

DeferredItemReplacement

מידע שקשור להחלפה של פריט שנדחה.

ייצוג JSON 
{
  "productId": string
}
שדות
productId

string

מזהה המוצר שיחליף את מזהה המוצר הקיים.

שיטות

get

 קבלת מטא-נתונים של מינוי

revoke

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