REST Resource: monetization.subscriptions

المرجع: الاشتراك

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

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

string

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

string

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

object (BasePlan)

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

object (SubscriptionListing)

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

boolean

النتائج فقط. ميزة متوقّفة نهائيًا: ميزة أرشفة الاشتراكات غير متاحة.
taxAndComplianceSettings

object (SubscriptionTaxAndComplianceSettings)

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

object (RestrictedPaymentCountries)

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

BasePlan

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

تمثيل 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)
  },
  "installmentsBasePlanType": {
    object (InstallmentsBasePlanType)
  }
  // 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)

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

object (InstallmentsBasePlanType)

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

الحالة

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

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

AutoRenewingBasePlanType

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

تمثيل JSON 
{
  "billingPeriodDuration": string,
  "gracePeriodDuration": string,
  "accountHoldDuration": 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 يومًا). في حال عدم تحديد قيمة، سيتم استخدام قيمة تلقائية استنادًا إلى مدة الفترة المتكرّرة.
accountHoldDuration

string

اختياريّ. فترة تعليق الاشتراك المحدّدة بتنسيق ISO 8601 يجب أن تكون القيم المقبولة بالأيام DAYS وفي النطاق P0D (صفر أيام) إلى P30D (30 يومًا). إذا لم يتم تحديد القيمة، ستكون القيمة التلقائية هي P30D (30 يومًا).
resubscribeState

enum (ResubscribeState)

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

enum (SubscriptionProrationMode)

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

boolean

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

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

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

string

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

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

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

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

ResubscribeState

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

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

SubscriptionProrationMode

وضع تقسيم الأرباح المُستخدَم لتجديد الخطط الأساسية

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

PrepaidBasePlanType

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

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

string

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

enum (TimeExtension)

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

TimeExtension

إضافة مدة الخطة الأساسية

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

InstallmentsBasePlanType

تمثّل هذه السمة خطة أساسية للتقسيط حيث يلتزم المستخدم بعدد محدّد من الدفعات.

تمثيل JSON 
{
  "billingPeriodDuration": string,
  "committedPaymentsCount": integer,
  "renewalType": enum (RenewalType),
  "gracePeriodDuration": string,
  "accountHoldDuration": string,
  "resubscribeState": enum (ResubscribeState),
  "prorationMode": enum (SubscriptionProrationMode)
}
الحقول
billingPeriodDuration

string

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

integer

مطلوب. عدد الدفعات التي يلتزم بها المستخدم
renewalType

enum (RenewalType)

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

string

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

string

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

enum (ResubscribeState)

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

enum (SubscriptionProrationMode)

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

RenewalType

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

عمليات التعداد
RENEWAL_TYPE_UNSPECIFIED حالة غير محدَّدة.
RENEWAL_TYPE_RENEWS_WITHOUT_COMMITMENT يتم تجديد الاشتراك بشكل دوري طوال مدة الفوترة بدون أي التزام.
RENEWAL_TYPE_RENEWS_WITH_COMMITMENT ويتمّ تجديد الاشتراك مع الالتزام بالمدة نفسها التي حدّدتها لمدة البداية.

RegionalBasePlanConfig

إعدادات خطة أساسية خاصة بمنطقة معيّنة

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

string

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

boolean

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

object (Money)

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

OtherRegionsBasePlanConfig

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

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

object (Money)

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

object (Money)

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

boolean

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

SubscriptionListing

البيانات الوصفية التي تظهر للمستهلكين عند شراء اشتراك

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

string

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

string

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

string

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

string

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

RestrictedPaymentCountries

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

تمثيل JSON 
{
  "regionCodes": [
    string
  ]
}
الحقول
regionCodes[]

string

مطلوب. رموز المناطق التي سيتم فرض قيود الدفع عليها، وفقًا للمعيار ISO 3166-2، على سبيل المثال "US".

الطُرق

archive
(deprecated)

 ميزة متوقّفة نهائيًا: ميزة أرشفة الاشتراكات غير متاحة.

batchGet

 يقرأ اشتراك واحد أو أكثر.

batchUpdate

 تعمل هذه السياسة على تعديل مجموعة من الاشتراكات.

create

 يؤدي الزرّ إلى إنشاء اشتراك جديد.

delete

 يؤدي هذا الإجراء إلى حذف اشتراك.

get

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

list

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

patch

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