REST Resource: monetization.subscriptions.basePlans.offers

משאב: SubscriptionOffer

מבצע זמני אחד

ייצוג JSON 
{
  "packageName": string,
  "productId": string,
  "basePlanId": string,
  "offerId": string,
  "state": enum (State),
  "phases": [
    {
      object (SubscriptionOfferPhase)
    }
  ],
  "targeting": {
    object (SubscriptionOfferTargeting)
  },
  "regionalConfigs": [
    {
      object (RegionalSubscriptionOfferConfig)
    }
  ],
  "otherRegionsConfig": {
    object (OtherRegionsSubscriptionOfferConfig)
  },
  "offerTags": [
    {
      object (OfferTag)
    }
  ]
}
שדות
packageName

string

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

string

חובה. בלתי משתנה. המזהה של מינוי ההורה שאליו שייך המבצע הזה.
basePlanId

string

חובה. בלתי משתנה. המזהה של המינוי הבסיסי שעבורו המבצע הזה הוא תוסף.
offerId

string

חובה. בלתי משתנה. המזהה הייחודי של המבצע על המינוי. חייב להיות ייחודי במסגרת המינוי הבסיסי.
state

enum (State)

פלט בלבד. המצב הנוכחי של המבצע הזה. ניתן לשנות אותן באמצעות פעולות 'הפעלה' ו'השבתה'. הערה: מצב המינוי הבסיסי מחליף את המצב הזה, ולכן יכול להיות שמוצר פעיל לא יהיה זמין אם המינוי הבסיסי לא פעיל.
phases[]

object (SubscriptionOfferPhase)

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

object (SubscriptionOfferTargeting)

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

object (RegionalSubscriptionOfferConfig)

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

object (OtherRegionsSubscriptionOfferConfig)

ההגדרה של מיקומים חדשים ב-Play עשויה להיות זמינה בעתיד.
offerTags[]

object (OfferTag)

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

ארץ

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

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

SubscriptionOfferPhase

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

ייצוג JSON 
{
  "recurrenceCount": integer,
  "duration": string,
  "regionalConfigs": [
    {
      object (RegionalSubscriptionOfferPhaseConfig)
    }
  ],
  "otherRegionsConfig": {
    object (OtherRegionsSubscriptionOfferPhaseConfig)
  }
}
שדות
recurrenceCount

integer

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

string

חובה. משך הזמן של חזרה בודדת של השלב הזה. קביעה בפורמט ISO 8601.
regionalConfigs[]

object (RegionalSubscriptionOfferPhaseConfig)

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

object (OtherRegionsSubscriptionOfferPhaseConfig)

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

RegionalSubscriptionOfferPhaseConfig

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

ייצוג JSON 
{
  "regionCode": string,

  // Union field price_override can be only one of the following:
  "price": {
    object (Money)
  },
  "relativeDiscount": number,
  "absoluteDiscount": {
    object (Money)
  },
  "free": {
    object
  }
  // End of list of possible types for union field price_override.
}
שדות
regionCode

string

חובה. בלתי משתנה. האזור שעליו חלה ההגדרה הזו.
שדה איחוד price_override. שינוי המחיר בשלב הזה. חובה. price_override יכול להיות רק אחד מהבאים:
price

object (Money)

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

number

החלק היחסי של מחיר המינוי הבסיסי שמחושב באופן יחסי על פני משך השלב שהמשתמש משלם עבור שלב המבצע הזה. לדוגמה, אם מחיר המינוי הבסיסי באזור הזה הוא 48 ש"ח לתקופה של שנה, מחיר של 6.00 ש"ח יהיה שווה ל-50% הנחה לתקופה של 3 חודשים. יש לציין את ההנחה כשבר גדול מ-0 ורק קטן מ-1. המחיר שיתקבל יעוגל ליחידת החיוב הקרובה ביותר (למשל, סנט לדולר ארה"ב). ההנחה היחסית נחשבת לא חוקית אם המחיר המוזל יהיה נמוך מהמחיר המינימלי שמותר באזור הזה.
absoluteDiscount

object (Money)

סכום הכסף המוחלט מנוכה ממחיר המינוי הבסיסי, שמחולק באופן יחסי למשך הזמן שהמשתמש משלם עבור שלב המבצע הזה. לדוגמה, אם מחיר המינוי הבסיסי באזור הזה הוא 48 ש"ח לתקופה של שנה, הנחה מוחלטת של 4 ש"ח לתקופה של 3 חודשים תתאים למחיר של 8 ש"ח. המחיר שיתקבל אינו יכול להיות נמוך מהמחיר המינימלי המותר באזור זה.
free

object

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

OtherRegionsSubscriptionOfferPhaseConfig

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

ייצוג JSON 
{

  // Union field price_override can be only one of the following:
  "otherRegionsPrices": {
    object (OtherRegionsSubscriptionOfferPhasePrices)
  },
  "relativeDiscount": number,
  "absoluteDiscounts": {
    object (OtherRegionsSubscriptionOfferPhasePrices)
  },
  "free": {
    object
  }
  // End of list of possible types for union field price_override.
}
שדות
שדה איחוד price_override. שינוי המחיר בשלב הזה. חובה. price_override יכול להיות רק אחד מהבאים:
otherRegionsPrices

object (OtherRegionsSubscriptionOfferPhasePrices)

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

number

החלק היחסי של מחיר המינוי הבסיסי שמחושב באופן יחסי על פני משך השלב שהמשתמש משלם עבור שלב המבצע הזה. לדוגמה, אם מחיר המינוי הבסיסי באזור הזה הוא 48 ש"ח לתקופה של שנה, מחיר של 6.00 ש"ח יהיה שווה ל-50% הנחה לתקופה של 3 חודשים. יש לציין את ההנחה כשבר גדול מ-0 ורק קטן מ-1. המחיר שיתקבל יעוגל ליחידת החיוב הקרובה ביותר (למשל, סנט לדולר ארה"ב). ההנחה היחסית נחשבת לא חוקית אם המחיר המוזל יהיה נמוך מהמחיר המינימלי המותר במיקומים חדשים שבהם אפשר להשיק את Play.
absoluteDiscounts

object (OtherRegionsSubscriptionOfferPhasePrices)

סכום הכסף המוחלט מנוכה ממחיר המינוי הבסיסי, שמחולק באופן יחסי למשך הזמן שהמשתמש משלם עבור שלב המבצע הזה. לדוגמה, אם מחיר המינוי הבסיסי באזור הזה הוא 48 ש"ח לתקופה של שנה, הנחה מוחלטת של 4 ש"ח לתקופה של 3 חודשים תתאים למחיר של 8 ש"ח. המחיר שייווצר לא יהיה נמוך מהמחיר המינימלי המותר למיקומים חדשים שתושק ב-Play.
free

object

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

OtherRegionsSubscriptionOfferPhasePrices

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

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

object (Money)

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

object (Money)

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

SubscriptionOfferTargeting

מגדיר את הכלל שמשתמש צריך לעמוד בו כדי לקבל את המבצע.

ייצוג JSON 
{

  // Union field rule can be only one of the following:
  "acquisitionRule": {
    object (AcquisitionTargetingRule)
  },
  "upgradeRule": {
    object (UpgradeTargetingRule)
  }
  // End of list of possible types for union field rule.
}
שדות
שדה איחוד rule. יש להשאיר את השדה ריק עבור זכאות למבצע שנקבע על ידי המפתח. rule יכול להיות רק אחד מהבאים:
acquisitionRule

object (AcquisitionTargetingRule)

כלל טירגוט של מבצעים לצירוף משתמשים חדשים.
upgradeRule

object (UpgradeTargetingRule)

כלל טירגוט של מבצעים לשדרוג התוכניות הקיימות של משתמשים.

AcquisitionTargetingRule

מייצג כלל טירגוט בצורה: למשתמש אף פעם לא היה {scope}.

ייצוג JSON 
{
  "scope": {
    object (TargetingRuleScope)
  }
}
שדות
scope

object (TargetingRuleScope)

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

TargetingRuleScope

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

ייצוג JSON 
{

  // Union field scope can be only one of the following:
  "thisSubscription": {
    object (TargetingRuleScopeThisSubscription)
  },
  "anySubscriptionInApp": {
    object (TargetingRuleScopeAnySubscriptionInApp)
  },
  "specificSubscriptionInApp": string
  // End of list of possible types for union field scope.
}
שדות

שדה איחוד scope.

scope יכול להיות רק אחד מהבאים:
thisSubscription

object (TargetingRuleScopeThisSubscription)

ההיקף של כלל הטירגוט הנוכחי הוא המינוי שבו המבצע הזה מוגדר.
anySubscriptionInApp

object (TargetingRuleScopeAnySubscriptionInApp)

ההיקף של כלל הטירגוט הנוכחי הוא כל מינוי באפליקציה ההורה.
specificSubscriptionInApp

string

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

TargetingRuleScopeThisSubscription

אין שדות בסוג הזה.

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

TargetingRuleScopeAnySubscriptionInApp

אין שדות בסוג הזה.

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

UpgradeTargetingRule

מייצג כלל טירגוט בצורה: למשתמש יש כרגע {scope} [עם תקופת חיוב {billing_period}].

ייצוג JSON 
{
  "oncePerUser": boolean,
  "scope": {
    object (TargetingRuleScope)
  },
  "billingPeriodDuration": string
}
שדות
oncePerUser

boolean

המבצע מוגבל לפעם אחת בלבד לכל משתמש. אם המדיניות מוגדרת כ-True, המשתמש לא יהיה זכאי שוב למבצע הזה אם הוא נרשם למבצע הזה.
scope

object (TargetingRuleScope)

חובה. היקף המינויים שהכלל הזה מתייחס אליהם. מותר לציין רק את 'המינוי הזה' ו'מינוי ספציפי באפליקציה'.
billingPeriodDuration

string

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

RegionalSubscriptionOfferConfig

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

ייצוג JSON 
{
  "regionCode": string,
  "newSubscriberAvailability": boolean
}
שדות
regionCode

string

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

boolean

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

OtherRegionsSubscriptionOfferConfig

הגדרות המיקומים של כל מיקום חדש ש-Play עשויה להשיק במסגרת מבצע על מינוי.

ייצוג JSON 
{
  "otherRegionsNewSubscriberAvailability": boolean
}
שדות
otherRegionsNewSubscriberAvailability

boolean

האם המבצע של המינוי במקומות חדשים ש-Play יושק בעתיד. אם לא תציינו, ברירת המחדל תהיה FALSE.

שיטות

activate

 מפעיל מבצע על מינוי.

batchGet

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

batchUpdate

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

batchUpdateStates

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

create

 יצירת הצעה חדשה למינוי.

deactivate

 משבית מבצע על מינוי.

delete

 מוחק הצעה למינוי.

get

 קריאה של מבצע יחיד

list

 הצגת כל ההצעות במינוי נתון.

patch

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