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)

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

offerTags[]

object (OfferTag)

قائمة بما يصل إلى 20 علامة مخصّصة محدّدة لهذا العرض، ويتم عرضها في التطبيق من خلال Billing Library.

ولاية

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

عمليات التعداد
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)

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

RegionalSubscriptionOfferPhaseConfig

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

تمثيل JSON
{
  "regionCode": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "price": {
    object (Money)
  },
  "relativeDiscount": number,
  "absoluteDiscount": {
    object (Money)
  },
  "free": {
    object (RegionalSubscriptionOfferPhaseFreePriceOverride)
  }
  // End of mutually exclusive fields.
}
الحقول
regionCode

string

الحقل مطلوب. غير قابل للتغيير المنطقة التي تنطبق عليها هذه الإعدادات

تمثّل هذه السمة السعر الذي تم تجاوزه في هذه المرحلة. الحقل مطلوب. في ما يلي قائمة بالحقول التي يستبعد بعضها بعضًا. سيتم ضبط حقل واحد على الأكثر في الرد:
price

object (Money)

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

relativeDiscount

number

تمثّل هذه السمة نسبة الخصم المئوية التي يتم طرحها من سعر الخطة الأساسية بالتناسب مع مدة المرحلة، ويتم تحديدها ككسر أكبر من 0 وأصغر من 1. على سبيل المثال، تمثّل القيمة 0.8 خصمًا بنسبة ‎80%، ما يعني أنّه إذا كان سعر الخطة الأساسية التناسبية هو 100 دولار أمريكي، سيكون سعر العرض الترويجي 20 دولارًا أمريكيًا. سيتم تقريب السعر الناتج إلى أقرب وحدة قابلة للفوترة (مثل السنتات للدولار الأمريكي). يُعتبر الخصم النسبي غير صالح إذا كان السعر المخفَّض أقل من الحدّ الأدنى للسعر المسموح به في هذه المنطقة.

absoluteDiscount

object (Money)

هو المبلغ المطلق الذي يتم طرحه من سعر الخطة الأساسية بشكل نسبي على مدار مدة المرحلة. على سبيل المثال، إذا كان سعر الخطة الأساسية في هذه المنطقة هو 12 دولار أمريكي لمدة عام واحد، فإنّ مبلغ الخصم الدقيق بقيمة دولار أمريكي واحد لمرحلة مدتها 3 أشهر سيؤدي إلى سعر يبلغ دولارَين أمريكيَين. قد لا يكون السعر الناتج أقل من الحد الأدنى للسعر المسموح به في هذه المنطقة.

free

object (RegionalSubscriptionOfferPhaseFreePriceOverride)

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

نهاية الحقول التي يستبعد كلّ منها الآخر

RegionalSubscriptionOfferPhaseFreePriceOverride

هذا النوع لا يحتوي على حقول.

تمثّل إعدادات إلغاء السعر المجاني لمرحلة واحدة من عرض الاشتراك

OtherRegionsSubscriptionOfferPhaseConfig

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

تمثيل JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "otherRegionsPrices": {
    object (OtherRegionsSubscriptionOfferPhasePrices)
  },
  "relativeDiscount": number,
  "absoluteDiscounts": {
    object (OtherRegionsSubscriptionOfferPhasePrices)
  },
  "free": {
    object (OtherRegionsSubscriptionOfferPhaseFreePriceOverride)
  }
  // End of mutually exclusive fields.
}
الحقول
تمثّل هذه السمة السعر الذي تم تجاوزه في هذه المرحلة. الحقل مطلوب. في ما يلي قائمة بالحقول التي يستبعد بعضها بعضًا. سيتم ضبط حقل واحد على الأكثر في الرد:
otherRegionsPrices

object (OtherRegionsSubscriptionOfferPhasePrices)

السعر المطلق الذي يدفعه المستخدم مقابل مرحلة العرض هذه. يجب ألا يقل السعر عن الحدّ الأدنى المسموح به لأي مواقع جغرافية جديدة قد يطلقها Google Play.

relativeDiscount

number

تمثّل هذه السمة نسبة الخصم المئوية التي يتم طرحها من سعر الخطة الأساسية بالتناسب مع مدة المرحلة، ويتم تحديدها ككسر أكبر من 0 وأصغر من 1. على سبيل المثال، تمثّل القيمة 0.8 خصمًا بنسبة% 80، ما يعني أنّه إذا كان سعر الخطة الأساسية التناسبية هو 100 دولار أمريكي، سيكون سعر العرض الترويجي 20 دولار أمريكي. سيتم تقريب السعر الناتج إلى أقرب وحدة قابلة للفوترة (مثل السنتات للدولار الأمريكي). يُعدّ الخصم النسبي غير صالح إذا كان السعر المخفَّض أقل من الحدّ الأدنى للسعر المسموح به في أي مواقع جغرافية جديدة قد يتم إطلاق Google Play فيها.

absoluteDiscounts

object (OtherRegionsSubscriptionOfferPhasePrices)

هو المبلغ المطلق الذي يتم طرحه من سعر الخطة الأساسية بشكل نسبي على مدار مدة المرحلة. على سبيل المثال، إذا كان سعر الخطة الأساسية في هذه المنطقة هو 12 دولار أمريكي لمدة عام واحد، فإنّ مبلغ الخصم الدقيق بقيمة دولار أمريكي واحد لمرحلة مدتها 3 أشهر سيؤدي إلى سعر يبلغ دولارَين أمريكيَين. قد لا يكون السعر الناتج أقل من الحدّ الأدنى للسعر المسموح به في أي مواقع جغرافية جديدة قد يتم إطلاق Play فيها.

free

object (OtherRegionsSubscriptionOfferPhaseFreePriceOverride)

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

نهاية الحقول التي يستبعد كلّ منها الآخر

OtherRegionsSubscriptionOfferPhasePrices

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

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

object (Money)

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

eurPrice

object (Money)

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

OtherRegionsSubscriptionOfferPhaseFreePriceOverride

هذا النوع لا يحتوي على حقول.

يمثّل هذا الحقل إعدادات تجاوز السعر المجاني لأي مواقع جغرافية جديدة قد يطلقها Google Play لمرحلة عرض واحدة.

SubscriptionOfferTargeting

تحدّد هذه السمة القاعدة التي يجب أن يستوفيها المستخدم للاستفادة من هذا العرض.

تمثيل JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "acquisitionRule": {
    object (AcquisitionTargetingRule)
  },
  "upgradeRule": {
    object (UpgradeTargetingRule)
  }
  // End of mutually exclusive fields.
}
الحقول
اترك هذا الحقل فارغًا لتحديد أهلية الاستفادة من العرض من قِبل المطوّر. في ما يلي قائمة بالحقول التي يستبعد بعضها بعضًا. سيتم ضبط حقل واحد على الأكثر في الرد:
acquisitionRule

object (AcquisitionTargetingRule)

قاعدة استهداف العرض لاكتساب مستخدمين جدد

upgradeRule

object (UpgradeTargetingRule)

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

نهاية الحقول التي يستبعد كلّ منها الآخر

AcquisitionTargetingRule

تمثّل قاعدة استهداف بالصيغة التالية: لم يسبق للمستخدم الحصول على {scope}.

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

object (TargetingRuleScope)

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

TargetingRuleScope

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

تمثيل JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "thisSubscription": {
    object (TargetingRuleScopeThisSubscription)
  },
  "anySubscriptionInApp": {
    object (TargetingRuleScopeAnySubscriptionInApp)
  },
  "specificSubscriptionInApp": string
  // End of mutually exclusive fields.
}
الحقول
في ما يلي قائمة بالحقول التي يستبعد بعضها بعضًا. سيتم ضبط حقل واحد على الأكثر في الرد:
thisSubscription

object (TargetingRuleScopeThisSubscription)

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

anySubscriptionInApp

object (TargetingRuleScopeAnySubscriptionInApp)

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

specificSubscriptionInApp

string

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

نهاية الحقول التي يستبعد كلّ منها الآخر

TargetingRuleScopeThisSubscription

هذا النوع لا يحتوي على حقول.

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

TargetingRuleScopeAnySubscriptionInApp

هذا النوع لا يحتوي على حقول.

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

UpgradeTargetingRule

تمثّل قاعدة استهداف بالصيغة التالية: يمتلك المستخدم حاليًا {scope} [مع مدة الفوترة {billingPeriod}].

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

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

رموز الخطأ

تعرض عمليات هذا المورد رموز الخطأ التالية في بروتوكول HTTP:

رمز الخطأ السبب الوصف الدقة