REST Resource: monetization.subscriptions

משאב: Subscription

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

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

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

object (RegionalBasePlanConfig)

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

object (OfferTag)

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

object (OtherRegionsBasePlanConfig)

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

object (AutoRenewingBasePlanType)

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

object (PrepaidBasePlanType)

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

object (InstallmentsBasePlanType)

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

מדינה

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

טיפוסים בני מנייה (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 לבין הערך הנמוך מבין 30 ימים ותקופת החיובים של תוכנית הבסיס.

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

הסכום של gracePeriodDuration ו-accountHoldDuration חייב להיות בין P30D ל-P60D ימים, כולל.
accountHoldDuration

string

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

אם לא מציינים ערך, ערך ברירת המחדל הוא P30D.

הסכום של 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)

חובה. לא ניתן לשינוי. סוג החידוש של מינוי Base Plan בתשלומים. מגדירה את ההתנהגות בסוף ההתחייבות הראשונית. אי אפשר לשנות את סוג החידוש אחרי יצירת תוכנית Base Plan.
gracePeriodDuration

string

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

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

הסכום של gracePeriodDuration ו-accountHoldDuration חייב להיות בין P30D ל-P60D ימים, כולל.
accountHoldDuration

string

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

אם לא מציינים ערך, ערך ברירת המחדל הוא P30D.

הסכום של gracePeriodDuration ו-accountHoldDuration חייב להיות בין P30D ל-P60D ימים, כולל.
resubscribeState

enum (ResubscribeState)

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

enum (SubscriptionProrationMode)

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

RenewalType

סוג החידוש של מינוי Base Plan בתשלומים. מגדירה את ההתנהגות בסוף ההתחייבות הראשונית. אי אפשר לשנות את סוג החידוש אחרי יצירת תוכנית Base Plan.

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

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

RestrictedPaymentCountries

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

ייצוג ב-JSON 
{
  "regionCodes": [
    string
  ]
}
שדות
regionCodes[]

string

חובה. קודי אזורים להטלת הגבלות תשלום, כפי שמוגדרים בתקן ISO 3166-2, למשל 'US'.

Methods

archive
(deprecated)

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

batchGet

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

batchUpdate

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

create

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

delete

 מחיקה של מינוי.

get

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

list

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

patch

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