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

מדינה

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

טיפוסים בני מנייה (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 חודשים תהיה שווה ערך למחיר של 7.2 ש"ח. צריך לציין את ההנחה כחלק שגדול מ-0 וקטן מ-1. המחיר שייווצר יעוגל ליחידת החיוב הקרובה ביותר (למשל, סנטים לדולר ארה"ב). ההנחה היחסית נחשבת לא חוקית אם המחיר המוזל נמוך מהמחיר המינימלי המותר באזור הזה.
absoluteDiscount

object (Money)

הסכום המוחלט של הכסף שמופחת ממחיר המינוי הבסיסי, מחולק לפי משך השלב והמשתמש משלם אותו בשלב המבצע הזה. לדוגמה, אם מחיר המינוי הבסיסי באזור הזה הוא 12 $לתקופה של שנה אחת, הנחה גורפת של 1 $לשלב של 3 חודשים תהיה שווה ערך למחיר של 2$. המחיר שייווצר לא יכול להיות נמוך מהמחיר המינימלי המותר באזור הזה.
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 חודשים תהיה שווה ערך למחיר של 7.2 ש"ח. צריך לציין את ההנחה כחלק שגדול מ-0 וקטן מ-1. המחיר שייווצר יעוגל ליחידת החיוב הקרובה ביותר (למשל, סנטים לדולר ארה"ב). ההנחה היחסית נחשבת לא חוקית אם המחיר המוזל נמוך מהמחיר המינימלי המותר בכל מיקום חדש שבו Play עשוי להשיק את האפליקציה.
absoluteDiscounts

object (OtherRegionsSubscriptionOfferPhasePrices)

הסכום המוחלט של הכסף שמופחת ממחיר המינוי הבסיסי, מחולק לפי משך השלב והמשתמש משלם אותו בשלב המבצע הזה. לדוגמה, אם מחיר המינוי הבסיסי באזור הזה הוא 12 $לתקופה של שנה אחת, הנחה גורפת של 1 $לשלב של 3 חודשים תהיה שווה ערך למחיר של 2$. המחיר שייווצר לא יכול להיות נמוך מהמחיר המינימלי המותר בכל מיקום חדש שבו Play עשוי להשיק את המשחק.
free

object (OtherRegionsSubscriptionOfferPhaseFreePriceOverride)

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

OtherRegionsSubscriptionOfferPhasePrices

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

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

object (Money)

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

object (Money)

חובה. המחיר באירו שישמש בכל מיקום חדש שבו 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, למשל 'US'.
newSubscriberAvailability

boolean

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

OtherRegionsSubscriptionOfferConfig

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

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

boolean

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

Methods

activate

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

batchGet

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

batchUpdate

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

batchUpdateStates

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

create

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

deactivate

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

delete

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

get

 קריאת מבצע יחיד

list

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

patch

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