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

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

absoluteDiscounts

object (OtherRegionsSubscriptionOfferPhasePrices)

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

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

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 التالية:

رمز الخطأ السبب الوصف الدقة
400 invalidValue تم إدخال قيمة غير صالحة في الطلب. يتم عرض هذا الرمز غالبًا عند تقديم رمز مميّز غير صالح أو غير مكتمل لعملية الشراء. صحِّح قيمة الحقل غير الصالحة في نص الطلب أو المَعلمات استنادًا إلى مرجع واجهة برمجة التطبيقات.
400 required لم يتم إدخال حقل أو مَعلمة مطلوبة في الطلب. راجِع مستندات واجهة برمجة التطبيقات للتأكّد من تضمين جميع الحقول والمَعلمات الإلزامية.
403 userInsufficientPermission لا يملك المستخدم الإذن الكافي لتنفيذ العملية المطلوبة. تأكَّد من أنّ المستخدم المصادَق عليه لديه الأذونات اللازمة في Google Play Console. لمزيد من التفاصيل، يُرجى الاطّلاع على استخدام حساب خدمة.
404 notFound تعذَّر العثور على المورد المطلوب. تأكَّد من صحة المعرّفات (مثل رمز الشراء أو اسم الحزمة أو معرّف المنتج أو معرّف الاشتراك).
409 concurrentUpdate تمت محاولة تعديل عنصر يتم تعديله في الوقت نفسه. أعِد محاولة إرسال الطلب باستخدام خوارزمية الرقود الأسي الثنائي. تجنَّب إجراء تعديلات متزامنة على المرجع نفسه.
5xx Generic error حدث خطأ عام في خادم Google Play. أعِد محاولة إرسال طلبك.

إذا استمرت المشكلة، يُرجى التواصل مع مدير حسابك على Google Play أو إرسال طلب دعم. ننصحك بالاطّلاع على لوحة البيانات الخاصة بحالة Play لمعرفة أي انقطاع معروف في الخدمة.