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. אפשר להשתמש גם בשינויים (offsets) אחרים מלבד '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)

הקשר נוסף לגבי מינויים מושהים. השדה הזה מופיע רק אם הערך של subscriptionState הוא SUBSCRIPTION_STATE_PAUSED.
canceledStateContext

object (CanceledStateContext)

הקשר נוסף לגבי מינויים שבוטלו. השדה הזה מופיע רק אם סטטוס המינוי הוא SUBSCRIPTION_STATE_CANCELED או SUBSCRIPTION_STATE_EXPIRED.
testPurchase

object (TestPurchase)

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

enum (AcknowledgementState)

סטטוס האישור של המינוי.
externalAccountIdentifiers

object (ExternalAccountIdentifiers)

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

object (SubscribeWithGoogleInfo)

פרופיל המשתמש שמשויך לרכישות שבוצעו באמצעות 'Subscribe with 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. אפשר להשתמש גם בשינויים (offsets) אחרים מלבד '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. אפשר להשתמש גם בשינויים (offsets) אחרים מלבד '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

מידע שמשויך לרכישות שבוצעו באמצעות '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,
  "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)
  }
  // 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. אפשר להשתמש גם בשינויים (offsets) אחרים מלבד '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)

מידע לגבי החלפת פריט בהשהיה.
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. אפשר להשתמש גם בשינויים (offsets) אחרים מלבד '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. אפשר להשתמש גם בשינויים (offsets) אחרים מלבד '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

ה-productId יחליף את ה-productId הקיים.

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

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