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
  }
  // 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

يجب تحديد أنّ هذا العرض متاح مجانًا.

OtherRegionsSubscriptionOfferPhaseConfig

قد يتم إطلاق Play في أي مواقع جغرافية جديدة لمرحلة عرض واحدة.

تمثيل JSON
{

  // Union field price_override can be only one of the following:
  "otherRegionsPrices": {
    object (OtherRegionsSubscriptionOfferPhasePrices)
  },
  "relativeDiscount": number,
  "absoluteDiscounts": {
    object (OtherRegionsSubscriptionOfferPhasePrices)
  },
  "free": {
    object
  }
  // 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

يجب تحديد أنّ هذا العرض متاح مجانًا.

OtherRegionsSubscriptionOfferPhasePrices

معلومات الأسعار لأي مواقع جغرافية جديدة قد يتم إطلاق Play فيها

تمثيل JSON
{
  "usdPrice": {
    object (Money)
  },
  "eurPrice": {
    object (Money)
  }
}
الحقول
usdPrice

object (Money)

مطلوبة. السعر بالدولار الأمريكي للاستخدام في أي مواقع جغرافية جديدة قد يتم إطلاق Play فيها

eurPrice

object (Money)

مطلوبة. السعر باليورو الذي يمكن استخدامه في أي مواقع جغرافية جديدة قد يتم إطلاق 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

يمكنك حصر هذا العرض مرة واحدة فقط لكل مستخدم. في حال ضبطها على "صحيح"، لا يمكن للمستخدم أن يكون مؤهلاً للاستفادة من هذا العرض مجددًا إذا سبق له الاشتراك فيه.

scope

object (TargetingRuleScope)

مطلوبة. نطاق الاشتراكات التي تراعيها هذه القاعدة. السماح "بهذا الاشتراك" و "الاشتراك المحدد في التطبيق" فقط.

billingPeriodDuration

string

هي مدة المدد الزمنية المحدّدة للفوترة، المحددة بتنسيق ISO 8601، والتي يجب أن يكون المستخدم مشتركًا فيها حاليًا ليكون مؤهلاً لهذه القاعدة. وفي حال عدم تحديد أي مدة، ستتم مطابقة المستخدمين المشتركين في أي مدة زمنية للفوترة.

RegionalSubscriptionOfferConfig

إعدادات عرض الاشتراك في منطقة واحدة

تمثيل JSON
{
  "regionCode": string,
  "newSubscriberAvailability": boolean
}
الحقول
regionCode

string

مطلوبة. غير قابل للتغيير. رمز المنطقة الذي ينطبق عليه هذا الإعداد، وفقًا لمعيار ISO 3166-2، مثل "US".

newSubscriberAvailability

boolean

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

OtherRegionsSubscriptionOfferConfig

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

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

boolean

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

الطُرق

activate

تفعِّل هذا الخيار عرض اشتراك.

batchGet

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

batchUpdate

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

batchUpdateStates

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

create

ينشئ عرض اشتراك جديد.

deactivate

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

delete

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

get

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

list

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

patch

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