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) وشرطات سفلية (_) ونقاط (.)، ويجب أن تبدأ بحرف صغير أو رقم، وأن يتراوح طولها بين حرف واحد و40 حرفًا (شاملاً).
basePlans[]

object (BasePlan)

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

object (SubscriptionListing)

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

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

object (OtherRegionsBasePlanConfig)

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

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

string

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

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

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

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

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

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

عمليات التعداد
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 إذا لم يتم تحديدها.

تمديد الوقت

إضافة الوقت للخطة الأساسية

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

إعداد RegionalBasePlan

ضبط خطة أساسية خاصة بمنطقة معيّنة

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

string

مطلوبة. رمز المنطقة الذي ينطبق عليه هذا الضبط، وفقًا لتعريف ISO 3166-2، مثل "US&quot.
newSubscriberAvailability

boolean

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

object (Money)

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

غير ذلك في مناطق الخطة الأساسية

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

JSON representation 
{
  "usdPrice": {
    object (Money)
  },
  "eurPrice": {
    object (Money)
  },
  "newSubscriberAvailability": boolean
}
الحقول
usdPrice

object (Money)

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

object (Money)

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

boolean

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

الاشتراك في الخدمة

البيانات الوصفية المرئية للعميل في اشتراك

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

string

مطلوبة. لغة هذه البيانات على النحو المحدّد في BCP-47، مثل "en;US"
title

string

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

string

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

string

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

Methods

archive

 تتم أرشفة اشتراك.

create

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

delete

 حذف اشتراك

get

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

list

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

patch

 يتم تعديل اشتراك حالي.