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

מדינה (State)

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

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

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

השבר של מחיר המינוי הבסיסי שחושב באופן יחסי למשך השלב, שהמשתמש משלם עבור שלב המבצע הזה. לדוגמה, אם המחיר של המינוי הבסיסי באזור הזה הוא 12 $לתקופה של שנה, הנחה של 50% לשלב שנמשך 3 חודשים תתאים למחיר של 1.50$. ההנחה צריכה להיות שבר שגדול מ-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} [עם תקופת חיוב {billingPeriod}].

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

Methods

activate

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

batchGet

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

batchUpdate

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

batchUpdateStates

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

create

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

deactivate

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

delete

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

get

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

list

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

patch

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

קודי שגיאה

הפעולות של המשאב הזה מחזירות את קודי שגיאות ה-HTTP הבאים:

קוד שגיאה סיבה תיאור פתרון