REST Resource: purchases.subscriptionsv2

משאב: SubscriptionPurchaseV2

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

ייצוג ב-JSON
{
  "kind": string,
  "regionCode": string,
  "lineItems": [
    {
      object (SubscriptionPurchaseLineItem)
    }
  ],
  "startTime": string,
  "subscriptionState": enum (SubscriptionState),
  "linkedPurchaseToken": string,
  "pausedStateContext": {
    object (PausedStateContext)
  },
  "canceledStateContext": {
    object (CanceledStateContext)
  },
  "testPurchase": {
    object (TestPurchase)
  },
  "acknowledgementState": enum (AcknowledgementState),
  "externalAccountIdentifiers": {
    object (ExternalAccountIdentifiers)
  },
  "subscribeWithGoogleInfo": {
    object (SubscribeWithGoogleInfo)
  },
  "etag": string,
  "outOfAppPurchaseContext": {
    object (OutOfAppPurchaseContext)
  },
  "onHoldStateContext": {
    object (OnHoldStateContext)
  },
  "inGracePeriodStateContext": {
    object (InGracePeriodStateContext)
  }
}
שדות
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)

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

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)

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

etag

string

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

outOfAppPurchaseContext

object (OutOfAppPurchaseContext)

הקשר נוסף לגבי רכישות מחוץ לאפליקציה. המידע הזה מוצג רק לגבי רכישות של מינויים חוזרים (רכישות של מינויים שבוצעו אחרי שהמינוי הקודם לאותו מוצר פג) שבוצעו דרך מרכז המינויים של Google Play. השדה הזה יוסר אחרי שתאשרו את המינוי.

onHoldStateContext

object (OnHoldStateContext)

אופציונלי. הקשר נוסף לגבי מינויים במצב ON_HOLD. מוצג רק אם המינוי נמצא כרגע במצב SUBSCRIPTION_STATE_ON_HOLD.

inGracePeriodStateContext

object (InGracePeriodStateContext)

אופציונלי. הקשר נוסף לגבי מינויים במצב IN_GRACE_PERIOD. מוצג רק אם המינוי נמצא כרגע במצב SUBSCRIPTION_STATE_IN_GRACE_PERIOD.

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
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "userInitiatedCancellation": {
    object (UserInitiatedCancellation)
  },
  "systemInitiatedCancellation": {
    object (SystemInitiatedCancellation)
  },
  "developerInitiatedCancellation": {
    object (DeveloperInitiatedCancellation)
  },
  "replacementCancellation": {
    object (ReplacementCancellation)
  }
  // End of mutually exclusive fields.
}
שדות
הסיבה לביטול המינוי. ברשימה הבאה מפורטים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
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

מידע שקשור לרכישות שבוצעו באמצעות 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,
  "developerTargetedOffers": [
    {
      object (DeveloperTargetedOffer)
    }
  ],
  "latestSuccessfulOrderId": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "autoRenewingPlan": {
    object (AutoRenewingPlan)
  },
  "prepaidPlan": {
    object (PrepaidPlan)
  }
  // End of mutually exclusive fields.
  "offerDetails": {
    object (OfferDetails)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "deferredItemReplacement": {
    object (DeferredItemReplacement)
  },
  "deferredItemRemoval": {
    object (DeferredItemRemoval)
  }
  // End of mutually exclusive fields.
  "signupPromotion": {
    object (SignupPromotion)
  },
  "itemReplacement": {
    object (ItemReplacement)
  },
  "offerPhase": {
    object (OfferPhase)
  }
}
שדות
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".

developerTargetedOffers[]

object (DeveloperTargetedOffer)

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

latestSuccessfulOrderId

string

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

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

object (AutoRenewingPlan)

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

prepaidPlan

object (PrepaidPlan)

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

סוף השדות שמוציאים זה את זה.
offerDetails

object (OfferDetails)

פרטי המבצע של הפריט הזה.

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

object (DeferredItemReplacement)

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

deferredItemRemoval

object (DeferredItemRemoval)

מידע על הסרת פריטים מושהים.

סוף השדות שמוציאים זה את זה.
signupPromotion

object (SignupPromotion)

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

itemReplacement

object (ItemReplacement)

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

offerPhase

object (OfferPhase)

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

AutoRenewingPlan

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

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

boolean

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

recurringPrice

object (Money)

המחיר הקבוע הנוכחי של התוכנית שמתחדשת אוטומטית. חשוב לזכור שהמחיר לא כולל הנחות ומיסים. אם אתם צריכים את פרטי העסקה, בתמחור ללא מס צריך להפעיל את ה-API של orders.get.

priceChangeDetails

object (SubscriptionItemPriceChangeDetails)

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

installmentDetails

object (InstallmentPlan)

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

planTransitionDetails

object (PlanTransitionDetails)

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

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

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

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

PlanTransitionDetails

מידע שקשור למעבר בין תוכניות.

ייצוג ב-JSON
{
  "productId": string,
  "basePlanId": string,
  "offerId": string,
  "transitionInfo": {
    object (TransitionInfo)
  }
}
שדות
productId

string

[חובה] מזהה המוצר שאליו התוכנית הזו תועבר (לדוגמה, "monthly001").

basePlanId

string

[חובה] המזהה של המינוי הבסיסי שאליו המינוי הזה יועבר.

offerId

string

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

transitionInfo

object (TransitionInfo)

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

TransitionInfo

מידע שקשור למעבר מתוזמן בין תוכניות.

ייצוג ב-JSON
{
  "transitionState": enum (TransitionState),
  "price": {
    object (Money)
  },
  "expectedTransitionTime": string
}
שדות
transitionState

enum (TransitionState)

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

price

object (Money)

מחיר ברירת המחדל של המינוי הבסיסי שאליו המינוי יועבר.

expectedTransitionTime

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".

TransitionState

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

טיפוסים בני מנייה (enum)
TRANSITION_STATE_UNSPECIFIED מצב מעבר לא מוגדר.
SCHEDULED המעבר מתוזמן להתחיל בעתיד.
IN_PROGRESS תהליך המעבר התחיל וההודעה הראשונית על המעבר נשלחה למשתמש.
COMPLETED המעבר הושלם.
CANCELED המעבר בוטל.

PriceStepUpConsentDetails

מידע שקשור להעלאת מחיר שדורשת הסכמה מהמשתמש.

ייצוג ב-JSON
{
  "state": enum (ConsentState),
  "consentDeadlineTime": string,
  "newPrice": {
    object (Money)
  }
}
שדות
state

enum (ConsentState)

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

consentDeadlineTime

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".

newPrice

object (Money)

המחיר החדש שדורש הסכמה מהמשתמש.

ConsentState

מצב ההסכמה להעלאת המחיר.

טיפוסים בני מנייה (enum)
CONSENT_STATE_UNSPECIFIED מצב ההסכמה לא צוין.
PENDING המשתמש עדיין לא הביע הסכמה.
CONFIRMED המשתמש הסכים, והמחיר החדש יתעדכן בקרוב.
COMPLETED המשתמש הסכים והמחיר החדש נכנס לתוקף.

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
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "oneTimeCode": {
    object (OneTimeCode)
  },
  "vanityCode": {
    object (VanityCode)
  }
  // End of mutually exclusive fields.
}
שדות
סוג המבצע שהוחל על הפריט. ברשימה הבאה מפורטים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
oneTimeCode

object (OneTimeCode)

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

vanityCode

object (VanityCode)

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

סוף השדות שמוציאים זה את זה.

OneTimeCode

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

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

VanityCode

קוד הטבה מוגדר מראש לשימוש מרובה.

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

string

קוד ההטבה.

ItemReplacement

פרטים על פריט במינוי שמוחלף.

ייצוג ב-JSON
{
  "productId": string,
  "replacementMode": enum (ReplacementMode),
  "basePlanId": string,
  "offerId": string
}
שדות
productId

string

מזהה המוצר של פריט המינוי שמוחלף.

replacementMode

enum (ReplacementMode)

מצב ההחלפה שהופעל במהלך הרכישה.

basePlanId

string

המזהה של המינוי הבסיסי של פריט המינוי שמוחלף.

offerId

string

מזהה המבצע של פריט המינוי שמוחלף, אם רלוונטי.

ReplacementMode

אופן ההחלפה של מינוי.

טיפוסים בני מנייה (enum)
REPLACEMENT_MODE_UNSPECIFIED מצב החלפה לא מוגדר.
WITH_TIME_PRORATION התוכנית החדשה תהיה יחסית ותזוכה מהתוכנית הישנה.
CHARGE_PRORATED_PRICE המשתמש יחויב במחיר יחסי על התוכנית החדשה.
WITHOUT_PRORATION התוכנית החדשה תחליף את התוכנית הישנה בלי לחשב את הזמן באופן יחסי.
CHARGE_FULL_PRICE המשתמש יחויב במחיר המלא של התוכנית החדשה.
DEFERRED התוכנית הישנה תבוטל והתוכנית החדשה תיכנס לתוקף אחרי שהתוכנית הישנה תסתיים.
KEEP_EXISTING התוכנית לא תשתנה בעקבות ההחלפה הזו.

OfferPhase

פרטי שלב המבצע.

ייצוג ב-JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "prorationPeriod": {
    object (ProrationPeriodOfferPhase)
  },
  "freeTrial": {
    object (FreeTrialOfferPhase)
  },
  "introductoryPrice": {
    object (IntroductoryPriceOfferPhase)
  },
  "basePrice": {
    object (BasePriceOfferPhase)
  }
  // End of mutually exclusive fields.
}
שדות
פרטי שלב המבצע. ברשימה הבאה מפורטים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
prorationPeriod

object (ProrationPeriodOfferPhase)

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

freeTrial

object (FreeTrialOfferPhase)

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

introductoryPrice

object (IntroductoryPriceOfferPhase)

השדה הזה מוגדר כששלב המבצע הוא שלב של מבצע מחיר היכרות.

basePrice

object (BasePriceOfferPhase)

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

סוף השדות שמוציאים זה את זה.

ProrationPeriodOfferPhase

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

ייצוג ב-JSON
{
  "originalOfferPhaseType": enum (OriginalOfferPhaseType)
}
שדות
originalOfferPhaseType

enum (OriginalOfferPhaseType)

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

OriginalOfferPhaseType

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

טיפוסים בני מנייה (enum)
ORIGINAL_OFFER_PHASE_TYPE_UNSPECIFIED סוג שלב המבצע המקורי לא צוין.
BASE המינוי נמצא בשלב של מחיר הבסיס (למשל, מחיר מלא).
INTRODUCTORY המינוי נמצא בשלב של מחיר היכרות.
FREE_TRIAL המינוי נמצא בתקופת ניסיון בחינם.

FreeTrialOfferPhase

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

פרטים על שלב תקופת הניסיון בחינם.

IntroductoryPriceOfferPhase

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

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

BasePriceOfferPhase

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

פרטים על שלב ההצעה של מחיר הבסיס.

DeveloperTargetedOffer

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

ייצוג ב-JSON
{
  "offerId": string,
  "activateTime": string
}
שדות
offerId

string

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

activateTime

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".

OutOfAppPurchaseContext

מידע ספציפי על רכישה מחוץ לאפליקציה.

ייצוג ב-JSON
{
  "expiredExternalAccountIdentifiers": {
    object (ExternalAccountIdentifiers)
  },
  "expiredPurchaseToken": string
}
שדות
expiredExternalAccountIdentifiers

object (ExternalAccountIdentifiers)

מזהה חשבון המשתמש מהמינוי האחרון שפג תוקפו למק"ט הזה.

expiredPurchaseToken

string

אסימון הרכישה של המינוי האחרון שתוקפו פג. צריך להשתמש באסימון הרכישה הזה רק כדי לזהות את המשתמש אם הקישור בין ה-purchaseToken למשתמש מאוחסן במסד הנתונים שלכם. אי אפשר להשתמש בזה כדי לשלוח קריאה ל-Google Developer API אם עברו יותר מ-60 ימים מאז שתוקף המינוי פג.

OnHoldStateContext

הקשר נוסף לגבי מינויים במצב ON_HOLD.

ייצוג ב-JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "renewalDeclined": {
    object (RenewalDeclinedContext)
  }
  // End of mutually exclusive fields.
}
שדות
הסיבה לכך שהמינוי נמצא במצב ON_HOLD. ברשימה הבאה מפורטים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
renewalDeclined

object (RenewalDeclinedContext)

אופציונלי. התשלום על החידוש נדחה.

סוף השדות שמוציאים זה את זה.

RenewalDeclinedContext

הקשר שקשור לתרחיש של דחיית חידוש.

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

string

חובה. המזהה של ההזמנה בהמתנה או ההזמנה שנכשלה שגרמה למצב הזה.

InGracePeriodStateContext

הקשר נוסף לגבי מינויים במצב IN_GRACE_PERIOD.

ייצוג ב-JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "renewalDeclined": {
    object (RenewalDeclinedContext)
  }
  // End of mutually exclusive fields.
}
שדות
הסיבה לכך שהמינוי נמצא במצב IN_GRACE_PERIOD. ברשימה הבאה מפורטים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
renewalDeclined

object (RenewalDeclinedContext)

אופציונלי. התשלום על החידוש נדחה.

סוף השדות שמוציאים זה את זה.

Methods

activateoffertargeting

מפעיל טירגוט למוצר ספציפי.

cancel

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

cancelplantransition

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

deactivateoffertargeting

השבתת הטירגוט של מבצע ספציפי.

defer

דחיית החידוש של מינוי.

get

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

revoke

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

scheduleplantransition

לתזמן מעבר בין תוכניות במינוי.

קודי שגיאה

הפעולות של המשאב הזה מחזירות את קודי שגיאות ה-HTTP הבאים:

קוד שגיאה סיבה תיאור רזולוציה
400 / 410 subscriptionExpired המינוי פג ואי אפשר לבצע את הפעולה שביקשת. בודקים את זמן התפוגה של המינוי. אי אפשר לבצע את הפעולה הזו במינויים שפג תוקפם.
400 subscriptionInvalidArgument הארגומנט שצוין בבקשה למינוי לא תקין. צריך לעיין במאמרי העזרה של ה-API ולוודא שכל שדות החובה מולאו ושהפורמט שלהם נכון.
400 invalidPurchaseState הרכישה לא במצב תקין לביצוע הפעולה המבוקשת. לדוגמה, יכול להיות שניסיתם לאשר רכישה שכבר נוצלה או לבטל מינוי לא פעיל. לפני שמנסים לבצע את הפעולה, צריך לבדוק את המצב הנוכחי של המשאב באמצעות ה-API המתאים מסוג Get. צריך לוודא שהמשאב נמצא במצב שמתאים לפעולה.
400 invalidValue הבקשה כללה ערך לא תקין. השגיאה הזו מוחזרת בדרך כלל כשהפורמט של אסימון הרכישה שגוי או כשהאסימון לא תקין. מתקנים את הערך הלא תקין בשדה בגוף הבקשה או בפרמטרים, בהתאם למאמרי העזרה של ה-API.
400 prepaidSubscriptionNotSupported הפעולה שביקשת לא נתמכת במינויים בתשלום מראש. מוודאים שהפעולה רלוונטית לסוג המינוי. השגיאה הזו ספציפית לשיטות כמו Cancel.
400 productNotOwnedByUser אסימון הרכישה שסופק תקין, אבל המוצר לא בבעלות המשתמש כרגע. זה יכול לקרות אם הרכישה בוטלה, פג תוקפה או בוצע עבורה החזר כספי לפני האישור. לפני שמנסים לבצע את הפעולה, צריך לבדוק את המצב הנוכחי של המשאב באמצעות ה-API המתאים מסוג Get. צריך לוודא שהמשאב נמצא במצב שמתאים לפעולה.
400 purchaseTokenMismatch אסימון הרכישה שסופק לא תואם לרכישה, לשם החבילה, למזהה המינוי או למזהה המוצר. מוודאים שכל הפרטים בבקשה נכונים ותואמים זה לזה.
400 required חסר בבקשה שדה או פרמטר חובה. כדאי לעיין במאמרי העזרה של ה-API כדי לוודא שכל שדות החובה והפרמטרים נכללים.
400 unsupportedIabType הפעולה לא נתמכת בסוג החיוב על רכישות באפליקציות שצוין. צריך לוודא ששיטת ה-API תואמת לסוג הפריט שמנוהל.
403 userInsufficientPermission למשתמש אין הרשאה מספיקה לביצוע הפעולה המבוקשת. מוודאים שלמשתמש המאומת יש את ההרשאות הנדרשות ב-Google Play Console. פרטים נוספים מופיעים במאמר שימוש בחשבון שירות.
404 notFound המשאב המבוקש לא נמצא. מוודאים שהמזהים (למשל, אסימון הרכישה, שם החבילה, מזהה המוצר, מזהה המינוי) נכונים.
409 concurrentUpdate היה ניסיון לעדכן אובייקט שנמצא בתהליך עדכון בו-זמני. מנסים שוב לשלוח את הבקשה עם השהיה מעריכית לפני ניסיון חוזר (exponential backoff). אל תבצעו שינויים בו-זמנית באותו משאב.
410 purchaseTokenNoLongerValid אסימון הרכישה לא חוקי באופן סופי כי חשבון המשתמש המשויך נמחק או שרשומת הרכישה כבר לא קיימת. להפסיק להשתמש בטוקן הרכישה הזה.
410 subscriptionNoLongerAvailable אי אפשר יותר לשלוח שאילתה לגבי רכישת המינוי כי פג התוקף שלו לפני יותר מדי זמן. השגיאה הזו מציינת שהמינוי פג לפני יותר מ-60 יום. לא כדאי יותר לשלוח שאילתות לגבי המינויים האלה.
5xx Generic error שגיאה כללית בשרת של Google Play. נסו לשלוח שוב את הבקשה.

אם הבעיה נמשכת, פנו למנהל החשבון שלכם ב-Google Play או שלחו בקשת תמיכה. כדאי לבדוק בלוח הבקרה של סטטוס Play אם יש הפסקות זמניות בשירות.