REST Resource: monetization.subscriptions

משאב: מנוי

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

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

string

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

productId

string

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

basePlans[]

object (BasePlan)

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

listings[]

object (SubscriptionListing)

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

archived
(deprecated)

boolean

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

taxAndComplianceSettings

object (SubscriptionTaxAndComplianceSettings)

פרטים לגבי מיסים ותאימות לחוק.

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)
  }
  // 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)

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

ארץ

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

טיפוסים בני מנייה (enums)
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. אם לא צוין ערך, ברירת המחדל היא REROW_STATE_ACTIVE.

prorationMode

enum (SubscriptionProrationMode)

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

legacyCompatible

boolean

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

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

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

legacyCompatibleSubscriptionOfferId

string

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

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

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

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

ResubscribeState

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

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

SubscriptionProrationMode

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

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

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

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

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 תווים. טקסט פשוט.

שיטות

archive
(deprecated)

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

batchGet

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

batchUpdate

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

create

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

delete

מחיקת מינוי.

get

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

list

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

patch

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