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 دولار أمريكي لمدة عام واحد، سيعادل السعر 1.50 دولار أمريكي عند الحصول على خصم بنسبة% 50 لمرحلة مدتها 3 أشهر. يجب تحديد الخصم ككسر أكبر من 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 (خطأ).

OtherRegionsSubscriptionOfferConfig

إعدادات أي مواقع جغرافية جديدة يمكن إطلاق Play فيها ضمن عرض اشتراك محدَّد

تمثيل JSON
{
  "otherRegionsNewSubscriberAvailability": boolean
}
الحقول
otherRegionsNewSubscriberAvailability

boolean

ما إذا كان سيتم إطلاق عرض الاشتراك في أي مواقع جغرافية جديدة في Play في المستقبل إذا لم يتم تحديده، سيتم ضبطه تلقائيًا على false (خطأ).

الطُرق

activate

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

batchGet

يقرأ عرضًا واحدًا أو أكثر من عروض الاشتراك

batchUpdate

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

batchUpdateStates

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

create

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

deactivate

لإيقاف عرض اشتراك معيّن

delete

يؤدي هذا الإجراء إلى حذف عرض اشتراك.

get

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

list

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

patch

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