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)

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

הפלט שנוצר תמיד יהיה בפורמט RFC 3339, עם נורמליזציה של Z ושימוש ב-0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
subscriptionState

enum (SubscriptionState)

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

string

הוצא משימוש: במקומו צריך להשתמש ב-lineItems.latest_successful_order_id. מזהה ההזמנה של ההזמנה האחרונה שמשויכת לרכישת המינוי. במינוי עם חידוש אוטומטי, זהו מזהה ההזמנה של ההרשמה אם המינוי עדיין לא חודש, או מזהה ההזמנה האחרונה שחוזרת על עצמה (הזמנה שהצליחה, בהמתנה או שנדחתה). במינוי בתשלום מראש, זהו מזהה ההזמנה שמשויך לאסימון הרכישה שנשלח בשאילתה.
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) אם המינוי הוא תוכנית עם חידוש אוטומטי, לפחות פריט אחד הוא autoRenewEnabled ולא פג התוקף שלו. ‫– (2) אם המינוי הוא מינוי בתשלום מראש, לפחות פריט אחד לא פג תוקף.
SUBSCRIPTION_STATE_PAUSED המינוי מושהה. הסטטוס הזה זמין רק אם המינוי הוא מינוי שמתחדש אוטומטית. במצב הזה, כל הפריטים מושהים.
SUBSCRIPTION_STATE_IN_GRACE_PERIOD המינוי נמצא בתקופת חסד. הסטטוס הזה זמין רק אם המינוי הוא מינוי שמתחדש אוטומטית. במצב הזה, כל הפריטים נמצאים בתקופת חסד.
SUBSCRIPTION_STATE_ON_HOLD המינוי נמצא בהמתנה (מושעה). הסטטוס הזה זמין רק אם המינוי הוא מינוי שמתחדש אוטומטית. במצב הזה, כל הפריטים בהמתנה.
SUBSCRIPTION_STATE_CANCELED המינוי בוטל אבל עדיין לא פג תוקפו. הסטטוס הזה זמין רק אם המינוי הוא מינוי שמתחדש אוטומטית. בכל הפריטים, הערך של autoRenewEnabled מוגדר כ-false.
SUBSCRIPTION_STATE_EXPIRED המינוי הסתיים. לכל הפריטים יש ערך של expiryTime (תאריך תפוגה) בעבר.
SUBSCRIPTION_STATE_PENDING_PURCHASE_CANCELED עסקה בהמתנה למינוי בוטלה. אם הרכישה בהמתנה היא של מינוי קיים, אפשר להשתמש ב-linkedPurchaseToken כדי לקבל את הסטטוס הנוכחי של המינוי.

PausedStateContext

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

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

string (Timestamp format)

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

הפלט שנוצר תמיד יהיה בפורמט RFC 3339, עם נורמליזציה של Z ושימוש ב-0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".

CanceledStateContext

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

ייצוג ב-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.

הפלט שנוצר תמיד יהיה בפורמט RFC 3339, עם נורמליזציה של Z ושימוש ב-0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".

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

גרסה מעורפלת של המזהה שמשויך באופן ייחודי לחשבון של המשתמש באפליקציה. הערך הזה מופיע ברכישות הבאות: * אם קישור החשבון התבצע כחלק מתהליך רכישת המינוי. * הוא צוין באמצעות 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,
  "latestSuccessfulOrderId": 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)
  },
  "deferredItemRemoval": {
    object (DeferredItemRemoval)
  }
  // End of list of possible types for union field deferred_item_change.
  "signupPromotion": {
    object (SignupPromotion)
  }
}
שדות
productId

string

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

string (Timestamp format)

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

הפלט שנוצר תמיד יהיה בפורמט RFC 3339, עם נורמליזציה של Z ושימוש ב-0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
latestSuccessfulOrderId

string

מזהה ההזמנה של ההזמנה האחרונה שבוצעה בהצלחה ומשויכת לפריט הזה. המאפיין לא מופיע אם הפריט עדיין לא נמצא בבעלות המשתמש (למשל, אם הפריט הוחלף בפריט אחר).
שדה איחוד plan_type. סוג תוכנית המינוי. הערך plan_type יכול להיות רק אחד מהבאים:
autoRenewingPlan

object (AutoRenewingPlan)

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

object (PrepaidPlan)

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

object (OfferDetails)

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

object (DeferredItemReplacement)

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

object (DeferredItemRemoval)

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

object (SignupPromotion)

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

AutoRenewingPlan

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

ייצוג ב-JSON 
{
  "autoRenewEnabled": boolean,
  "recurringPrice": {
    object (Money)
  },
  "priceChangeDetails": {
    object (SubscriptionItemPriceChangeDetails)
  },
  "installmentDetails": {
    object (InstallmentPlan)
  }
}
שדות
autoRenewEnabled

boolean

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

object (Money)

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

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

הפלט שנוצר תמיד יהיה בפורמט RFC 3339, עם נורמליזציה של Z ושימוש ב-0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".

PriceChangeMode

אופן השינוי במחיר.

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

PriceChangeState

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

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

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)

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

הפלט שנוצר תמיד יהיה בפורמט RFC 3339, עם נורמליזציה של Z ושימוש ב-0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".

OfferDetails

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

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

string

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

string

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

string

מזהה המוצר. המאפיין הזה מוצג רק במבצעים עם הנחה.

DeferredItemReplacement

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

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

string

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

DeferredItemRemoval

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

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

SignupPromotion

המבצע שהוחל על הפריט הזה בזמן הרכישה.

ייצוג ב-JSON 
{

  // Union field promotion_type can be only one of the following:
  "oneTimeCode": {
    object (OneTimeCode)
  },
  "vanityCode": {
    object (VanityCode)
  }
  // End of list of possible types for union field promotion_type.
}
שדות
שדה איחוד promotion_type. סוג המבצע שחל על הפריט. הערך promotion_type יכול להיות רק אחד מהבאים:
oneTimeCode

object (OneTimeCode)

הוחל קוד חד-פעמי.
vanityCode

object (VanityCode)

הופעל קוד מותאם אישית.

OneTimeCode

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

קוד שובר לשימוש חד-פעמי.

VanityCode

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

ייצוג ב-JSON 
{
  "promotionCode": string
}
שדות
promotionCode

string

קוד השובר.

Methods

get

 אחזור מטא-נתונים של מינוי

revoke

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