REST Resource: monetization.subscriptions

משאב: מינוי

מינוי אחד לאפליקציה.

ייצוג ב-JSON 
{
  "packageName": string,
  "productId": string,
  "basePlans": [
    {
      object (BasePlan)
    }
  ],
  "listings": [
    {
      object (SubscriptionListing)
    }
  ],
  "archived": boolean,
  "taxAndComplianceSettings": {
    object (SubscriptionTaxAndComplianceSettings)
  },
  "restrictedPaymentCountries": {
    object (RestrictedPaymentCountries)
  }
}
שדות
packageName

string

לא ניתן לשינוי. שם החבילה של האפליקציה הראשית.
productId

string

לא ניתן לשינוי. מזהה המוצר הייחודי של המוצר. ייחודי בתוך אפליקציית ההורה. מזהי מוצרים חייבים לכלול אותיות קטנות (a-z), מספרים (0-9), קווים תחתונים (_) ונקודות (.). הם חייבים להתחיל באות קטנה או במספר, ולהיות באורך של 1 עד 40 תווים (כולל).
basePlans[]

object (BasePlan)

קבוצת המינויים הבסיסיים של המינוי הזה. מייצג את המחירים ומשך המינוי אם לא חלים מבצעים אחרים.
listings[]

object (SubscriptionListing)

חובה. רשימת דפי האפליקציה המותאמים לשפות שונות עבור המינוי הזה. חייב להכיל לפחות רשומה אחת לשפת ברירת המחדל של אפליקציית ההורה.
archived
(deprecated)

boolean

פלט בלבד. הוצא משימוש: אין תמיכה בהעברת מינויים לארכיון.
taxAndComplianceSettings

object (SubscriptionTaxAndComplianceSettings)

פרטים על מיסים ועמידה בהוראות הדין.
restrictedPaymentCountries

object (RestrictedPaymentCountries)

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

BasePlan

מינוי בסיסי אחד למינוי.

ייצוג ב-JSON 
{
  "basePlanId": string,
  "state": enum (State),
  "regionalConfigs": [
    {
      object (RegionalBasePlanConfig)
    }
  ],
  "offerTags": [
    {
      object (OfferTag)
    }
  ],
  "otherRegionsConfig": {
    object (OtherRegionsBasePlanConfig)
  },

  // Union field base_plan_type can be only one of the following:
  "autoRenewingBasePlanType": {
    object (AutoRenewingBasePlanType)
  },
  "prepaidBasePlanType": {
    object (PrepaidBasePlanType)
  },
  "installmentsBasePlanType": {
    object (InstallmentsBasePlanType)
  }
  // End of list of possible types for union field base_plan_type.
}
שדות
basePlanId

string

חובה. לא ניתן לשינוי. המזהה הייחודי של מינוי הבסיס הזה. המזהה חייב להיות ייחודי במסגרת המינוי, ולעמוד בדרישות של RFC-1034. כלומר, המזהה יכול להכיל רק אותיות קטנות (a-z), מספרים (0-9) ומקפים (-), והוא יכול להיות באורך של עד 63 תווים.
state

enum (State)

פלט בלבד. מצב המינוי הבסיסי, כלומר אם הוא פעיל. אפשר להפעיל או למחוק מינויים בסיסיים לא פעילים או כאלה שנשמרו כטיוטה. אפשר להשבית מינויים בסיסיים פעילים. אפשר לבטל מינויים בסיסיים לא פעילים. אי אפשר לשנות את השדה הזה על ידי עדכון המשאב. במקום זאת, צריך להשתמש בנקודות הקצה הייעודיות.
regionalConfigs[]

object (RegionalBasePlanConfig)

מידע ספציפי לאזור לגבי המינוי הבסיסי הזה.
offerTags[]

object (OfferTag)

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

object (OtherRegionsBasePlanConfig)

מידע על תמחור בכל מיקום חדש ש-Play תשיק בעתיד. אם משמיטים את השדה הזה, המינוי BasePlan לא יהיה זמין באופן אוטומטי במיקומים חדשים שבהם Play תושק בעתיד.
שדה של איחוד base_plan_type. סוג המינוי הבסיסי הזה. צריך להגדיר רק אחד מהם. אי אפשר לשנות את סוג המינוי הבסיסי אחרי שיוצרים אותו. הערך base_plan_type יכול להיות רק אחד מהבאים:
autoRenewingBasePlanType

object (AutoRenewingBasePlanType)

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

object (PrepaidBasePlanType)

ההגדרה הזו רלוונטית כשמינוי Base Plan לא מתחדש באופן אוטומטי בסוף תקופת החיוב.
installmentsBasePlanType

object (InstallmentsBasePlanType)

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

מדינה (State)

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

טיפוסים בני מנייה (enum)
STATE_UNSPECIFIED מצב לא מוגדר.
DRAFT המינוי הבסיסי נמצא כרגע במצב טיוטה ולא הופעל. בשלב הזה אפשר למחוק אותו.
ACTIVE מינוי הבסיס פעיל וזמין למנויים חדשים.
INACTIVE מינוי בסיסי לא פעיל וזמין רק למנויים קיימים.

AutoRenewingBasePlanType

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

ייצוג ב-JSON 
{
  "billingPeriodDuration": string,
  "gracePeriodDuration": string,
  "accountHoldDuration": string,
  "resubscribeState": enum (ResubscribeState),
  "prorationMode": enum (SubscriptionProrationMode),
  "legacyCompatible": boolean,
  "legacyCompatibleSubscriptionOfferId": string
}
שדות
billingPeriodDuration

string

חובה. לא ניתן לשינוי. תקופת המינוי, בפורמט ISO 8601. רשימה של תקופות חיוב קבילות מופיעה במרכז העזרה. אי אפשר לשנות את משך הזמן אחרי שיוצרים את המינוי הבסיסי.
gracePeriodDuration

string

תקופת החסד של המינוי, בפורמט ISO 8601. הערכים הקבילים צריכים להיות בימים, בין P0D לבין הערך הנמוך מבין 30D ותקופת החיוב של המינוי הבסיסי.

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

המשך הכולל של gracePeriodDuration ו-accountHoldDuration צריך להיות בין P30D ל-P60D ימים, כולל.
accountHoldDuration

string

אופציונלי. תקופת השהיית החשבון בהתאמה אישית של המינוי, בפורמט ISO 8601. הערכים הקבילים צריכים להיות בימים, בין P0D ל-P60D.

שדה ריק מייצג השהיית חשבון מומלצת, שמחושבת לפי 60 יום פחות תקופת החסד.

המשך הכולל של gracePeriodDuration ו-accountHoldDuration צריך להיות בין P30D ל-P60D ימים, כולל.
resubscribeState

enum (ResubscribeState)

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

enum (SubscriptionProrationMode)

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

boolean

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

המינוי הבסיסי שתואם לדורות קודמים מוחזר על ידי השיטה שהוצאה משימוש querySkuDetailsAsync()‎‏, בספריית החיובים ב-Google Play.

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

string

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

המבצע על המינוי שתואם לדור קודם מוחזר על ידי השיטה שהוצאה משימוש querySkuDetailsAsync()‎‏, בספריית החיובים ב-Google Play.

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

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

ResubscribeState

סטטוס ההרשמה מחדש של המינוי הבסיסי.

טיפוסים בני מנייה (enum)
RESUBSCRIBE_STATE_UNSPECIFIED מצב לא מוגדר.
RESUBSCRIBE_STATE_ACTIVE ההרשמה מחדש פעילה.
RESUBSCRIBE_STATE_INACTIVE האפשרות להירשם מחדש לא פעילה.

SubscriptionProrationMode

מצב היחסיות שמשמש לחידוש מינויים בסיסיים.

טיפוסים בני מנייה (enum)
SUBSCRIPTION_PRORATION_MODE_UNSPECIFIED מצב לא מוגדר.
SUBSCRIPTION_PRORATION_MODE_CHARGE_ON_NEXT_BILLING_DATE המשתמשים יחויבו על מינוי הבסיס החדש שלהם בסוף תקופת החיוב הנוכחית.
SUBSCRIPTION_PRORATION_MODE_CHARGE_FULL_PRICE_IMMEDIATELY המשתמשים יחויבו על המינוי הבסיסי החדש שלהם באופן מיידי ובמלואו. התקופה שנותרה במינוי הקיים שלהם תשמש להארכת משך הזמן של תוכנית התשלומים החדשה.

PrepaidBasePlanType

מייצג מינוי בסיסי שלא מתחדש באופן אוטומטי בסוף תקופת המינוי הבסיסי, והמשתמש צריך לחדש אותו באופן ידני.

ייצוג ב-JSON 
{
  "billingPeriodDuration": string,
  "timeExtension": enum (TimeExtension)
}
שדות
billingPeriodDuration

string

חובה. לא ניתן לשינוי. תקופת המינוי, בפורמט ISO 8601. רשימה של תקופות חיוב קבילות מופיעה במרכז העזרה. אי אפשר לשנות את משך הזמן אחרי שיוצרים את המינוי הבסיסי.
timeExtension

enum (TimeExtension)

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

TimeExtension

הארכת זמן של מינוי בסיסי.

טיפוסים בני מנייה (enum)
TIME_EXTENSION_UNSPECIFIED מצב לא מוגדר.
TIME_EXTENSION_ACTIVE הארכת הזמן פעילה. המשתמשים יכולים להוסיף כסף או להאריך את המינוי בתשלום מראש.
TIME_EXTENSION_INACTIVE הארכת הזמן לא פעילה. המשתמשים לא יכולים להוסיף כסף למינוי בתשלום מראש או להאריך אותו.

InstallmentsBasePlanType

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

ייצוג ב-JSON 
{
  "billingPeriodDuration": string,
  "committedPaymentsCount": integer,
  "renewalType": enum (RenewalType),
  "gracePeriodDuration": string,
  "accountHoldDuration": string,
  "resubscribeState": enum (ResubscribeState),
  "prorationMode": enum (SubscriptionProrationMode)
}
שדות
billingPeriodDuration

string

חובה. לא ניתן לשינוי. תקופת המינוי, בפורמט ISO 8601. רשימה של תקופות חיוב קבילות מופיעה במרכז העזרה. אי אפשר לשנות את משך הזמן אחרי שיוצרים את המינוי הבסיסי.
committedPaymentsCount

integer

חובה. לא ניתן לשינוי. מספר התשלומים שהמשתמש התחייב אליהם. אי אפשר לשנות אותו אחרי שיוצרים את המינוי הבסיסי.
renewalType

enum (RenewalType)

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

string

תקופת החסד של המינוי, בפורמט ISO 8601. הערכים הקבילים צריכים להיות בימים, בין P0D לבין הערך הנמוך מבין 30D ותקופת החיוב של המינוי הבסיסי.

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

המשך הכולל של gracePeriodDuration ו-accountHoldDuration צריך להיות בין P30D ל-P60D ימים, כולל.
accountHoldDuration

string

אופציונלי. תקופת השהיית החשבון בהתאמה אישית של המינוי, בפורמט ISO 8601. הערכים הקבילים צריכים להיות בימים, בין P0D ל-P60D.

שדה ריק מייצג השהיית חשבון מומלצת, שמחושבת לפי 60 יום פחות תקופת החסד.

המשך הכולל של gracePeriodDuration ו-accountHoldDuration צריך להיות בין P30D ל-P60D ימים, כולל.
resubscribeState

enum (ResubscribeState)

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

enum (SubscriptionProrationMode)

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

RenewalType

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

טיפוסים בני מנייה (enum)
RENEWAL_TYPE_UNSPECIFIED מצב לא מוגדר.
RENEWAL_TYPE_RENEWS_WITHOUT_COMMITMENT המינוי מתחדש מדי פעם למשך תקופת החיוב ללא התחייבות.
RENEWAL_TYPE_RENEWS_WITH_COMMITMENT המינוי מתחדש עם התחייבות לאותו משך זמן כמו המינוי הראשוני.

RegionalBasePlanConfig

הגדרת מינוי בסיסי ספציפי לאזור.

ייצוג ב-JSON 
{
  "regionCode": string,
  "newSubscriberAvailability": boolean,
  "price": {
    object (Money)
  }
}
שדות
regionCode

string

חובה. קוד האזור שההגדרה הזו חלה עליו, כפי שמוגדר בתקן ISO 3166-1 alpha-2, למשל "US".
newSubscriberAvailability

boolean

אם המינוי הבסיסי באזור שצוין זמין למנויים חדשים. אם הערך הזה מוגדר כ-false, המינוי של מנויים קיימים לא יבוטל. אם לא מציינים ערך, ברירת המחדל היא false.
price

object (Money)

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

OtherRegionsBasePlanConfig

מידע על תמחור בכל מיקום חדש שבו Play תושק.

ייצוג ב-JSON 
{
  "usdPrice": {
    object (Money)
  },
  "eurPrice": {
    object (Money)
  },
  "newSubscriberAvailability": boolean
}
שדות
usdPrice

object (Money)

חובה. המחיר בדולר ארה"ב שבו ייעשה שימוש בכל מיקום חדש שבו Play תושק.
eurPrice

object (Money)

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

boolean

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

SubscriptionListing

המטא-נתונים של מינוי שגלויים לצרכן.

ייצוג ב-JSON 
{
  "languageCode": string,
  "title": string,
  "benefits": [
    string
  ],
  "description": string
}
שדות
languageCode

string

חובה. השפה של דף האפליקציה הזה, כפי שהיא מוגדרת בתקן BCP-47, למשל "en-US".
title

string

חובה. השם של המינוי הזה בשפה של דף האפליקציה הזה. טקסט פשוט.
benefits[]

string

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

string

תיאור המינוי בשפה של דף האפליקציה בחנות. האורך המקסימלי הוא 200 תווים. טקסט פשוט.

Methods

archive
(deprecated)

 הוצא משימוש: אין תמיכה בהעברת מינויים לארכיון.

batchGet

 קריאת מינוי אחד או יותר.

batchUpdate

 עדכון קבוצה של מינויים.

create

 יצירת מינוי חדש.

delete

 מחיקת מינוי.

get

 קריאת מינוי אחד.

list

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

patch

 עדכון של מינוי קיים.

קודי שגיאה

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

קוד שגיאה סיבה תיאור פתרון