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_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 دولار أمريكي لمدة عام واحد، سيكون الخصم المطلق الذي يبلغ دولار أمريكي واحد لمرحلة مدتها 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 دولار أمريكي لمدة عام واحد، سيكون الخصم المطلق الذي يبلغ دولار أمريكي واحد لمرحلة مدتها 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 في المستقبل إذا لم يتم تحديده، سيتم ضبطه تلقائيًا على false (خطأ).

الطُرق

activate

تفعيل عرض اشتراك

batchGet

قراءة عرض اشتراك واحد أو أكثر

batchUpdate

تعديل مجموعة من عروض الاشتراك

batchUpdateStates

تعديل مجموعة من حالات عروض الاشتراك

create

لإنشاء عرض اشتراك جديد

deactivate

إيقاف عرض اشتراك

delete

لحذف عرض اشتراك

get

قراءة عرض واحد

list

يتم سرد جميع العروض ضمن اشتراك معيّن.

patch

تعديل عرض اشتراك حالي