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

boolean

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

object (SubscriptionTaxAndComplianceSettings)

פרטים על המיסים והתאימות לחוק.

מינוי בסיסי

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

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

יכול להיות שמידע על מחירים של מיקומים חדשים יושק בעתיד. אם היא תושמט, BaseBase לא יהיה זמין אוטומטית למיקומים חדשים ש-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,
  "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 ימים). אם לא בחרת ערך, המערכת תשתמש בערך ברירת מחדל שמבוסס על משך הזמן של החזרה.
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.

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

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

הרשמה מחדש

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

Enums
RESUBSCRIBE_STATE_UNSPECIFIED מצב לא מוגדר.
RESUBSCRIBE_STATE_ACTIVE ההרשמה מחדש פעילה.
RESUBSCRIBE_STATE_INACTIVE ההרשמה מחדש לא פעילה.

מצב מינוי פרוגרמטי

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

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

סוג של מינוי בתשלום מראש

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

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

string

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

enum (TimeExtension)

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

תוסף זמן

תוסף זמן של מינוי בסיסי.

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

הגדרות של BaseBasePlanConfig

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

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

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

object (Money)

חובה. המחיר באירו (EUR) לשימוש בכל מיקום חדש שבו Play עשוי לפעול.
newSubscriberAvailability

boolean

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

רישום מינויים

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

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

string

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

string

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

string

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

string

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

שיטות

archive

 העברה של מינוי לארכיון.

create

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

delete

 מחיקת מינוי.

get

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

list

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

patch

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