REST Resource: monetization.subscriptions

المورد: الاشتراك

اشتراك واحد لتطبيق.

تمثيل JSON 
{
  "packageName": string,
  "productId": string,
  "basePlans": [
    {
      object (BasePlan)
    }
  ],
  "listings": [
    {
      object (SubscriptionListing)
    }
  ],
  "archived": boolean,
  "taxAndComplianceSettings": {
    object (SubscriptionTaxAndComplianceSettings)
  }
}
الحقول
packageName

string

غير قابل للتغيير. اسم حزمة التطبيق الرئيسي.
productId

string

غير قابل للتغيير. معرّف المنتج الفريد فريدة داخل التطبيق الرئيسي. يجب أن تتألف أرقام تعريف المنتجات من أحرف صغيرة (a-z) وأرقام (0-9) وشرطات سفلية (_) ونقاط (.). ويجب أن تبدأ بأحرف صغيرة أو أرقام، وأن يتراوح طولها من 1 إلى 40 حرفًا (شاملاً) طولاً.
basePlans[]

object (BasePlan)

مجموعة الخطط الأساسية لهذا الاشتراك. تمثّل هذه السمة أسعار الاشتراك ومدته إذا لم يتم تطبيق أي عروض أخرى.
listings[]

object (SubscriptionListing)

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

boolean

الإخراج فقط. ما إذا كان هذا الاشتراك مؤرشفًا أم لا. لم تعد الاشتراكات المؤرشفة متوفرة لأي مشترك بعد الآن، ولا يمكن تحديثها، ولا يتم إرجاعها في طلبات القوائم ما لم يتم تمرير علامة العرض المؤرشفة.
taxAndComplianceSettings

object (SubscriptionTaxAndComplianceSettings)

تفاصيل حول الضرائب والامتثال القانوني.

الخطة الأساسية

خطة أساسية واحدة للاشتراك.

تمثيل JSON 
{
  "basePlanId": string,
  "state": enum (State),
  "regionalConfigs": [
    {
      object (RegionalBasePlanConfig)
    }
  ],
  "offerTags": [
    {
      object (OfferTag)
    }
  ],
  "otherRegionsConfig": {
    object (OtherRegionsBasePlanConfig)
  },

  // Union field base_plan_type can be only one of the following:
  "autoRenewingBasePlanType": {
    object (AutoRenewingBasePlanType)
  },
  "prepaidBasePlanType": {
    object (PrepaidBasePlanType)
  }
  // End of list of possible types for union field base_plan_type.
}
الحقول
basePlanId

string

مطلوبة. غير قابل للتغيير. المعرّف الفريد لهذه الخطة الأساسية. يجب أن يكون فريدًا في الاشتراك، وأن يتوافق مع RFC-1034. ويعني هذا أنه لا يمكن أن يحتوي هذا المعرّف إلا على أحرف صغيرة (a-z) وأرقام (0-9) وواصلات (-)، ولا يمكن أن يتألف من أكثر من 63 حرفًا.
state

enum (State)

الإخراج فقط. حالة الخطة الأساسية، أي ما إذا كانت نشطة أم لا. يمكن تفعيل مسودة أو خطة أساسية غير نشطة أو حذفها. يمكن إلغاء تفعيل الخطط الأساسية النشطة. يمكن إلغاء الخطط الأساسية غير النشطة. لا يمكن تغيير هذا الحقل من خلال تحديث المورد. استخدِم نقاط النهاية المخصّصة بدلاً من ذلك.
regionalConfigs[]

object (RegionalBasePlanConfig)

معلومات خاصة بالمنطقة لهذه الخطة الأساسية.
offerTags[]

object (OfferTag)

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

object (OtherRegionsBasePlanConfig)

معلومات الأسعار لأي مواقع جغرافية جديدة قد يتم إطلاقها في Play في المستقبل. وفي حال حذفه، لن تتوفّر في الخطة الأساسية تلقائيًا أي مواقع جغرافية جديدة سيتم إطلاقها في Play في المستقبل.
حقل الاتحاد base_plan_type. نوع هذه الخطة الأساسية. يجب تحديد واحد بالضبط. يمكن أن يكون base_plan_type واحدًا مما يلي فقط:
autoRenewingBasePlanType

object (AutoRenewingBasePlanType)

يمكنك تحديد وقت تجديد الخطة الأساسية تلقائيًا على فترات منتظمة.
prepaidBasePlanType

object (PrepaidBasePlanType)

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

الحالة

الحالة الحالية لخطة أساسية

عمليات التعداد
STATE_UNSPECIFIED حالة غير محدّدة
DRAFT خطتك الأساسية حاليًا في حالة "مسودة"، ولم يتم تفعيلها. ويمكن حذفه بأمان في هذه المرحلة.
ACTIVE إنّ الخطة الأساسية نشطة ومتاحة للمشتركين الجدد.
INACTIVE الخطة الأساسية غير نشطة ولا تتوفّر إلا للمشتركين الحاليين.

نوع التجديد التلقائي للتجديد التلقائي

يمثل خطة أساسية يتم تجديدها تلقائيًا في نهاية فترة الاشتراك.

تمثيل JSON 
{
  "billingPeriodDuration": string,
  "gracePeriodDuration": string,
  "resubscribeState": enum (ResubscribeState),
  "prorationMode": enum (SubscriptionProrationMode),
  "legacyCompatible": boolean,
  "legacyCompatibleSubscriptionOfferId": string
}
الحقول
billingPeriodDuration

string

مطلوبة. فترة الاشتراك المحدَّدة بتنسيق ISO 8601. للحصول على قائمة بمُدد الفوترة المقبولة، يُرجى الرجوع إلى مركز المساعدة.
gracePeriodDuration

string

فترة السماح للاشتراك، محددة بتنسيق ISO 8601. القيم المقبولة هي P0D (صفر أيام)، وP3D (3 أيام)، وP7D (7 أيام)، وP14D (14 يومًا)، وP30D (30 يومًا). وفي حال عدم تحديده، سيتم استخدام قيمة تلقائية استنادًا إلى مدة الفترة المتكررة.
resubscribeState

enum (ResubscribeState)

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

enum (SubscriptionProrationMode)

يحدد وضع التوزيع النسبي للخطة الأساسية ما يحدث عندما ينتقل المستخدم إلى هذه الخطة من خطة أساسية أخرى. إذا لم يتم تحديدها، فستكون الإعدادات الافتراضية هي CHARGE_ON_NEXT_BILLING_DATE.
legacyCompatible

boolean

ما إذا كانت خطة التجديد الأساسية متوافقة مع الإصدارات السابقة

يتم عرض الخطة الأساسية المتوافقة مع الأنظمة القديمة من خلال الإجراء querySkuDetailsAsync() المتوقّف نهائيًا والخاص بواجهة برمجة التطبيقات Google Play Billing Library.

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

string

معرّف عرض الاشتراك المتوافق مع الإصدارات القديمة.

يتم عرض عرض الاشتراك المتوافق مع الإصدارات القديمة من خلال الإجراء querySkuDetailsAsync() المتوقف نهائيًا والخاص بواجهة برمجة التطبيقات Google Play Billing Library.

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

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

حالة إعادة الاشتراك

حالة إعادة الاشتراك في الخطة الأساسية

عمليات التعداد
RESUBSCRIBE_STATE_UNSPECIFIED حالة غير محدّدة
RESUBSCRIBE_STATE_ACTIVE ميزة إعادة الاشتراك مفعّلة.
RESUBSCRIBE_STATE_INACTIVE إعادة الاشتراك غير نشطة.

وضع التوزيع

وضع التوزيع النسبي المُستخدَم لتجديد الخطط الأساسية

عمليات التعداد
SUBSCRIPTION_PRORATION_MODE_UNSPECIFIED وضع غير محدد.
SUBSCRIPTION_PRORATION_MODE_CHARGE_ON_NEXT_BILLING_DATE سيتم تحصيل الرسوم من المستخدمين مقابل الخطة الأساسية الجديدة في نهاية المدة الزمنية الحالية للفوترة.
SUBSCRIPTION_PRORATION_MODE_CHARGE_FULL_PRICE_IMMEDIATELY سيتم تحصيل الرسوم من المستخدمين مقابل الخطة الأساسية الجديدة على الفور وكاملاً. وسيتم استخدام أي فترة متبقية من الاشتراك الحالي لتمديد مدة خطة الفوترة الجديدة.

خطة الدفع المسبق الأساسية

تمثل الخطة الأساسية التي لا يتم تجديدها تلقائيًا في نهاية الخطة الأساسية، ويجب تجديدها يدويًا بواسطة المستخدم.

تمثيل JSON 
{
  "billingPeriodDuration": string,
  "timeExtension": enum (TimeExtension)
}
الحقول
billingPeriodDuration

string

مطلوبة. فترة الاشتراك المحدَّدة بتنسيق ISO 8601. للحصول على قائمة بمُدد الفوترة المقبولة، يُرجى الرجوع إلى مركز المساعدة.
timeExtension

enum (TimeExtension)

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

إضافة الوقت

تمديد وقت الخطة الأساسية.

عمليات التعداد
TIME_EXTENSION_UNSPECIFIED حالة غير محدّدة
TIME_EXTENSION_ACTIVE إضافة الوقت نشطة. يُسمح للمستخدمين بإضافة رصيد إلى خطة الدفع المُسبَق أو تمديد فترتهم.
TIME_EXTENSION_INACTIVE امتداد الوقت غير نشط. لا يمكن للمستخدمين إضافة رصيد إلى خطة الدفع المُسبَق أو تمديد فترتهم.

إعداد RegionalBasePlan

تهيئة خطة أساسية خاصة بمنطقة.

تمثيل JSON 
{
  "regionCode": string,
  "newSubscriberAvailability": boolean,
  "price": {
    object (Money)
  }
}
الحقول
regionCode

string

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

boolean

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

object (Money)

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

OtherRegionsBasePlanConfig

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

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

object (Money)

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

object (Money)

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

boolean

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

قائمة الاشتراك

البيانات الوصفية المرئية للمستهلك من أحد الاشتراكات.

تمثيل JSON 
{
  "languageCode": string,
  "title": string,
  "benefits": [
    string
  ],
  "description": string
}
الحقول
languageCode

string

مطلوبة. لغة بطاقة البيانات هذه، وفق تعريف BCP-47، مثل "en-US".
title

string

مطلوبة. عنوان هذا الاشتراك بلغة بطاقة البيانات هذه. نص عادي.
benefits[]

string

قائمة المزايا التي تظهر للمستخدم على الأنظمة الأساسية مثل "متجر Play" وفي تدفقات الاستعادة بلغة بطاقة البيانات هذه. نص عادي. قائمة مرتبة تضم أربع مزايا على الأكثر.
description

string

وصف هذا الاشتراك بلغة بطاقة البيانات هذه. الحد الأقصى للطول - 80 حرفًا. نص عادي.

الطُرق

archive

 وضع اشتراك في الأرشيف.

create

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

delete

 حذف اشتراك.

get

 قراءة اشتراك واحد.

list

 يدرج جميع الاشتراكات ضمن تطبيق معين.

patch

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