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)

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

object (SubscriptionOfferPhase)

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

object (SubscriptionOfferTargeting)

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

object (RegionalSubscriptionOfferConfig)

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

object (OtherRegionsSubscriptionOfferConfig)

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

object (OfferTag)

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

מדינה

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

טיפוסים בני מנייה (enum)
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 (RegionalSubscriptionOfferPhaseFreePriceOverride)
  }
  // End of list of possible types for union field price_override.
}
שדות
regionCode

string

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

object (Money)

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

number

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

object (Money)

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

object (RegionalSubscriptionOfferPhaseFreePriceOverride)

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

RegionalSubscriptionOfferPhaseFreePriceOverride

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

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

OtherRegionsSubscriptionOfferPhaseConfig

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

ייצוג JSON 
{

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

object (OtherRegionsSubscriptionOfferPhasePrices)

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

number

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

object (OtherRegionsSubscriptionOfferPhasePrices)

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

object (OtherRegionsSubscriptionOfferPhaseFreePriceOverride)

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

OtherRegionsSubscriptionOfferPhasePrices

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

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

object (Money)

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

object (Money)

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

OtherRegionsSubscriptionOfferPhaseFreePriceOverride

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

מייצג את הגדרת השינוי בחינם של המחיר עבור מיקומים חדשים ש-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, למשל. "IL".
newSubscriberAvailability

boolean

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

OtherRegionsSubscriptionOfferConfig

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

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

boolean

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

שיטות

activate

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

batchGet

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

batchUpdate

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

batchUpdateStates

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

create

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

deactivate

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

delete

 מחיקת מבצע על מינוי.

get

 קריאת הצעה אחת

list

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

patch

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