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 عرض الاشتراك غير متاح للمستخدمين الجدد. يحتفظ المستخدمون الحاليون بإمكانية الوصول.

مرحلة عرض الاشتراك

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

تمثيل JSON
{
  "recurrenceCount": integer,
  "duration": string,
  "regionalConfigs": [
    {
      object (RegionalSubscriptionOfferPhaseConfig)
    }
  ],
  "otherRegionsConfig": {
    object (OtherRegionsSubscriptionOfferPhaseConfig)
  }
}
الحقول
recurrenceCount

integer

مطلوبة. عدد مرات تكرار هذه المرحلة. إذا لم تكن مرحلة العرض هذه مجانية، ستحصِّل كل عملية تكرار رسومًا من المستخدم في مرحلة العرض هذه.

duration

string

مطلوبة. مدة التكرار المتكرر لهذه المرحلة. محدّدة بتنسيق ISO 8601.

regionalConfigs[]

object (RegionalSubscriptionOfferPhaseConfig)

مطلوبة. تهيئة مرحلة العرض الخاصة بالمنطقة. يجب أن تتضمن هذه القائمة إدخالاً واحدًا بالضبط لكل منطقة يكون لعرض الاشتراك إعداد إقليمي لها.

otherRegionsConfig

object (OtherRegionsSubscriptionOfferPhaseConfig)

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

إعداد عرض مرحلة اشتراك إقليمي

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

تمثيل 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 أشهر بسعر يساوي دولارين أمريكيين (أو ما يعادلهما بالعملة المحلية). قد لا يكون السعر الناتج أصغر من الحد الأدنى للسعر المسموح به لهذه المنطقة.

free

object

تعيين لتعيين هذا العرض مجانًا للحصول عليه.

OtherRegionsSUBSCRIPTIONOfferStageConfig

يُمكن تشغيل 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 أشهر بسعر يساوي دولارين أمريكيين (أو ما يعادلهما بالعملة المحلية). يجب ألا يقل السعر الناتج عن الحد الأدنى للسعر المسموح به لأي مواقع جغرافية جديدة يتم إطلاق Play عليها.

free

object

تعيين لتعيين هذا العرض مجانًا للحصول عليه.

OtherRegionsSignupOfferOfferPrices

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

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

object (Money)

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

eurPrice

object (Money)

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

استهداف عروض الاشتراكات

لتحديد القاعدة التي يحتاج المستخدم إلى تلبيتها للحصول على هذا العرض.

تمثيل 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)

عرض قاعدة الاستهداف لترقية الخطط الحالية للمستخدمين.

قاعدة استهداف الاكتساب

يمثل قاعدة استهداف بالشكل: لم يكن لدى المستخدم {scope} من قبل.

تمثيل JSON
{
  "scope": {
    object (TargetingRuleScope)
  }
}
الحقول
scope

object (TargetingRuleScope)

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

نطاق قاعدة الاستهداف

تُحدِّد نطاق الاشتراكات التي يمكن أن تُطابقها قاعدة الاستهداف لاستهداف العروض للمستخدمين استنادًا إلى الاستحقاق السابق أو الحالي.

تمثيل JSON
{

  // Union field scope can be only one of the following:
  "thisSubscription": {
    object
  },
  "anySubscriptionInApp": {
    object
  },
  "specificSubscriptionInApp": string
  // End of list of possible types for union field scope.
}
الحقول

حقل الاتحاد scope.

يمكن أن يكون scope واحدًا مما يلي فقط:

thisSubscription

object

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

anySubscriptionInApp

object

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

specificSubscriptionInApp

string

نطاق قاعدة الاستهداف الحالية هو الاشتراك الذي يحمل رقم تعريف الاشتراك المحدد. يجب أن يكون اشتراكًا داخل التطبيق الرئيسي نفسه.

ترقيةTargetRule

يمثل قاعدة استهداف بالشكل: يمتلك المستخدم حاليًا {scope} [مع المدة الزمنية للفوترة {billing_period}].

تمثيل JSON
{
  "oncePerUser": boolean,
  "scope": {
    object (TargetingRuleScope)
  },
  "billingPeriodDuration": string
}
الحقول
oncePerUser

boolean

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

scope

object (TargetingRuleScope)

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

billingPeriodDuration

string

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

إعداد عرض الاشتراك الإقليمي

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

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

string

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

newSubscriberAvailability

boolean

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

OtherRegionsSUBSCRIPTIONOfferOffer

يمكن تهيئة Play لأي مواقع جديدة في Play محدد في عرض الاشتراك.

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

boolean

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

الطُرق

activate

تنشيط عرض الاشتراك.

create

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

deactivate

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

delete

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

get

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

list

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

patch

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