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

enum (SubscriptionState)

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

string

מזהה ההזמנה של ההזמנה האחרונה שמשויכת לרכישת המינוי. כשמדובר בחידוש אוטומטי של מינוי, זהו מזהה ההזמנה של הזמנת ההרשמה אם היא עדיין לא חודשה, או מזהה ההזמנה החוזרת האחרונה (הזמנה חוזרת, הזמנה בהמתנה או הזמנה שנדחתה). במינוי בתשלום מראש, זהו מזהה ההזמנה שמשויך לאסימון הרכישה בשאילתה.
linkedPurchaseToken

string

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

object (PausedStateContext)

הקשר נוסף לגבי מינויים מושהים. מוצג רק אם המינוי כולל כרגע SUBSCRIPTION_STATE_PAUSED.
canceledStateContext

object (CanceledStateContext)

הקשר נוסף לגבי מינויים שבוטלו. מוצג רק אם במינוי יש כרגע סטטוס מינוי subscription_STATE_CANCELED או SUBSCRIPTION_STATE_EXPIRED.
testPurchase

object (TestPurchase)

מוצג רק אם רכישת המינוי הזו היא רכישה לניסיון.
acknowledgementState

enum (AcknowledgementState)

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

object (ExternalAccountIdentifiers)

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

object (SubscribeWithGoogleInfo)

פרופיל המשתמש המשויך לרכישות שבוצעו באמצעות 'הרשמה באמצעות Google'.

SubscriptionState

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

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

PausedStateContext

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

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

string (Timestamp format)

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

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

CanceledStateContext

מידע ספציפי למינוי במצב SUBSCRIPTION_STATE_CANCELED או SUBSCRIPTION_STATE_VIOLATIOND.

ייצוג 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 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "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

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

טיפוסים בני מנייה (enum)
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

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

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

ExternalAccountIdentifiers

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

ייצוג JSON 
{
  "externalAccountId": string,
  "obfuscatedExternalAccountId": string,
  "obfuscatedExternalProfileId": string
}
שדות
externalAccountId

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

SubscribeWithGoogleInfo

מידע המשויך לרכישות שבוצעו באמצעות התכונה 'הרשמה באמצעות 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

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

string (Timestamp format)

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

חותמת זמן ב-RFC3339 UTC 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "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)
  },
  "installmentDetails": {
    object (InstallmentPlan)
  }
}
שדות
autoRenewEnabled

boolean

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

object (SubscriptionItemPriceChangeDetails)

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

object (InstallmentPlan)

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

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

PriceChangeMode

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

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

PriceChangeState

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

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

InstallmentPlan

מידע על תוכנית תשלומים.

ייצוג JSON 
{
  "initialCommittedPaymentsCount": integer,
  "subsequentCommittedPaymentsCount": integer,
  "remainingCommittedPaymentsCount": integer,
  "pendingCancellation": {
    object (PendingCancellation)
  }
}
שדות
initialCommittedPaymentsCount

integer

המספר הכולל של התשלומים שהמשתמש התחייב עליהם בהתחלה.
subsequentCommittedPaymentsCount

integer

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

integer

המספר הכולל של התשלומים שהתחייבת אליהם שצריך לשלם במחזור החידוש הזה.
pendingCancellation

object (PendingCancellation)

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

PendingCancellation

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

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

PrepaidPlan

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

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

string (Timestamp format)

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

חותמת זמן ב-RFC3339 UTC 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "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

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