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 תווים (כולל) הוא בין 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)

מגדירים מתי המינוי הבסיסי לא יתחדש באופן אוטומטי בסוף תקופת החיוב.
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 (אפס ימים), P3D (3 ימים), P7D (7 ימים), P14D (14 ימים) ו-P30D (30 ימים). אם לא מציינים זאת, המערכת תשתמש בערך ברירת מחדל על סמך משך התקופה החוזרת.
accountHoldDuration

string

זה שינוי אופציונלי. תקופת השהיית חשבון של המינוי, המצוינת בפורמט ISO 8601. הערכים הקבילים חייבים להיות ב-DAYS ובטווח P0D (אפס ימים) עד P30D (30 ימים). אם לא מציינים זאת, ערך ברירת המחדל הוא P30D (30 ימים).
resubscribeState

enum (ResubscribeState)

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

enum (SubscriptionProrationMode)

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

boolean

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

המינוי הבסיסי בתאימות לאחור מוחזר על ידי ה-method שהוצאה משימוש 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_תוספים_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 (אפס ימים), P3D (3 ימים), P7D (7 ימים), P14D (14 ימים) ו-P30D (30 ימים). אם לא מציינים זאת, המערכת תשתמש בערך ברירת מחדל על סמך משך התקופה החוזרת.
accountHoldDuration

string

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

enum (ResubscribeState)

האם משתמשים יכולים להירשם מחדש למינוי הבסיסי הזה בפלטפורמות של Google Play. אם לא מגדירים ערך לפרמטר הזה, ברירת המחדל שלו היא REsignup_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-2, למשל. "IL".
newSubscriberAvailability

boolean

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

object (Money)

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

OtherRegionsBasePlanConfig

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

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

object (Money)

חובה. המחיר בדולר ארה"ב (USD) לשימוש במיקומים חדשים ש-Play עשויה להשיק בהם.
eurPrice

object (Money)

חובה. המחיר באירו (EUR) לשימוש במיקומים חדשים ש-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, למשל. "IL".

שיטות

archive
(deprecated)

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

batchGet

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

batchUpdate

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

create

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

delete

 מוחק מינוי.

get

 קריאה של מינוי יחיד.

list

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

patch

 מעדכנים מינוי קיים.