REST Resource: purchases.subscriptionsv2

المرجع: SubscriptionPurchaseV2

يشير إلى حالة شراء اشتراك المستخدم.

تمثيل JSON
{
  "kind": string,
  "regionCode": string,
  "lineItems": [
    {
      object (SubscriptionPurchaseLineItem)
    }
  ],
  "startTime": string,
  "subscriptionState": enum (SubscriptionState),
  "linkedPurchaseToken": string,
  "pausedStateContext": {
    object (PausedStateContext)
  },
  "canceledStateContext": {
    object (CanceledStateContext)
  },
  "testPurchase": {
    object (TestPurchase)
  },
  "acknowledgementState": enum (AcknowledgementState),
  "externalAccountIdentifiers": {
    object (ExternalAccountIdentifiers)
  },
  "subscribeWithGoogleInfo": {
    object (SubscribeWithGoogleInfo)
  },
  "etag": string,
  "outOfAppPurchaseContext": {
    object (OutOfAppPurchaseContext)
  },
  "onHoldStateContext": {
    object (OnHoldStateContext)
  },
  "inGracePeriodStateContext": {
    object (InGracePeriodStateContext)
  }
}
الحقول
kind

string

يمثّل هذا النوع عنصر SubscriptionPurchaseV2 في خدمة androidpublisher.

regionCode

string

رمز المنطقة أو بلد إرسال الفواتير للمستخدم وفقًا لمعيار ISO 3166-1 alpha-2 في وقت منح الاشتراك

lineItems[]

object (SubscriptionPurchaseLineItem)

معلومات على مستوى السلعة لعملية شراء اشتراك يجب أن تكون جميع السلع في عملية الشراء نفسها إمّا من نوع AutoRenewingPlan أو PrepaidPlan.

startTime

string (Timestamp format)

الوقت الذي تم فيه منح الاشتراك لا يتم ضبطها للاشتراكات في انتظار المراجعة (تم إنشاء الاشتراك ولكن في انتظار الدفع أثناء الاشتراك).

يستخدم المعيار RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه مُمثلاً بالتوقيت العالمي المنسَّق مع حرف Z في النهاية ويستخدم الأرقام الجزئية 0 أو 3 أو 6 أو 9. تُقبل أيضًا المعادلات الأخرى التي لا تستخدم حرف Z. أمثلة: "2014-10-02T15:01:23Z" أو "2014-10-02T15:01:23.045123456Z" أو "2014-10-02T15:01:23+05:30"

subscriptionState

enum (SubscriptionState)

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

linkedPurchaseToken

string

رمز الشراء المميّز للاشتراك القديم إذا كان هذا الاشتراك أحد ما يلي: * إعادة الاشتراك في اشتراك تم إلغاؤه ولكن لم تنتهِ صلاحيته * الترقية أو الرجوع إلى إصدار سابق من اشتراك سابق. * التحويل من خطة دفع مُسبق إلى اشتراك يتجدّد تلقائيًا * التحويل من اشتراك يتجدّد تلقائيًا إلى اشتراك بنظام الدفع المُسبق * إضافة رصيد إلى اشتراك مدفوع مسبقًا

pausedStateContext

object (PausedStateContext)

سياق إضافي حول الاشتراكات المتوقفة مؤقتًا لا تظهر هذه القيمة إلا إذا كانت حالة الاشتراك الحالية هي SUBSCRIPTION_STATE_PAUSED.

canceledStateContext

object (CanceledStateContext)

سياق إضافي حول الاشتراكات المُلغاة لا يظهر هذا الحقل إلا إذا كانت حالة الاشتراك الحالية هي SUBSCRIPTION_STATE_CANCELED أو SUBSCRIPTION_STATE_EXPIRED.

testPurchase

object (TestPurchase)

لا تظهر هذه السمة إلا إذا كانت عملية شراء الاشتراك هذه تجريبية.

acknowledgementState

enum (AcknowledgementState)

حالة الإقرار بالاشتراك

externalAccountIdentifiers

object (ExternalAccountIdentifiers)

معرّف حساب المستخدم في الخدمة التابعة لجهة خارجية

subscribeWithGoogleInfo

object (SubscribeWithGoogleInfo)

ملف المستخدم الشخصي المرتبط بعمليات الشراء التي تم إجراؤها باستخدام ميزة "اشترِك مع Google"

etag

string

علامة الكيان التي تمثّل الحالة الحالية للاشتراك سيقدّم المطوّر علامة etag هذه لإجراءات الاشتراك. تتوفّر علامة etag هذه دائمًا للاشتراكات المدفوعة مسبقًا والتي يتم تجديدها تلقائيًا.

outOfAppPurchaseContext

object (OutOfAppPurchaseContext)

سياق إضافي لعمليات الشراء خارج التطبيق لا تظهر هذه المعلومات إلا لعمليات إعادة الاشتراك (عمليات شراء الاشتراك التي تتم بعد انتهاء صلاحية الاشتراك السابق للمنتج نفسه) التي تتم من خلال مركز الاشتراكات في Google Play. ستتم إزالة هذا الحقل بعد تأكيد الاشتراك.

onHoldStateContext

object (OnHoldStateContext)

اختيارية: سياق إضافي حول الاشتراكات في حالة ON_HOLD لا تظهر هذه القيمة إلا إذا كانت قيمة subscriptionState للاشتراك حاليًا هي SUBSCRIPTION_STATE_ON_HOLD.

inGracePeriodStateContext

object (InGracePeriodStateContext)

اختيارية: سياق إضافي حول الاشتراكات في حالة فترة السماح. لا تظهر هذه القيمة إلا إذا كانت حالة الاشتراك الحالية هي SUBSCRIPTION_STATE_IN_GRACE_PERIOD.

SubscriptionState

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

عمليات التعداد
SUBSCRIPTION_STATE_UNSPECIFIED حالة الاشتراك غير محدّدة.
SUBSCRIPTION_STATE_PENDING تم إنشاء الاشتراك ولكن في انتظار الدفع أثناء الاشتراك. في هذه الحالة، تكون جميع السلع في انتظار الدفع.
SUBSCRIPTION_STATE_ACTIVE الاشتراك نشط. ‫- (1) إذا كان الاشتراك عبارة عن خطة تجديد تلقائي، يكون عنصر واحد على الأقل من النوع autoRenewEnabled ولم تنتهِ صلاحيته. - (2) إذا كان الاشتراك عبارة عن خطة دفع مُسبَق، يجب ألا يكون عنصر واحد على الأقل منتهي الصلاحية.
SUBSCRIPTION_STATE_PAUSED تم إيقاف الاشتراك مؤقتًا. لا تتوفّر هذه الحالة إلا عندما يكون الاشتراك خطة تجديد تلقائي. في هذه الحالة، تكون جميع العناصر متوقفة مؤقتًا.
SUBSCRIPTION_STATE_IN_GRACE_PERIOD الاشتراك في فترة السماح. لا تتوفّر هذه الحالة إلا عندما يكون الاشتراك خطة تجديد تلقائي. في هذه الحالة، تكون جميع العناصر في فترة السماح.
SUBSCRIPTION_STATE_ON_HOLD الاشتراك معلَّق. لا تتوفّر هذه الحالة إلا عندما يكون الاشتراك خطة تجديد تلقائي. في هذه الحالة، يتم تجميد جميع العناصر.
SUBSCRIPTION_STATE_CANCELED تم إلغاء الاشتراك ولكن لم تنتهِ صلاحيته بعد. لا تتوفّر هذه الحالة إلا عندما يكون الاشتراك خطة تجديد تلقائي. تم ضبط autoRenewEnabled على "خطأ" لجميع العناصر.
SUBSCRIPTION_STATE_EXPIRED انتهت صلاحية الاشتراك. انتهت صلاحية جميع العناصر في الماضي.
SUBSCRIPTION_STATE_PENDING_PURCHASE_CANCELED تم إلغاء المعاملة في انتظار المعالجة للاشتراك. إذا كانت عملية الشراء المُعلّقة هذه لاشتراك حالي، استخدِم linkedPurchaseToken للحصول على الحالة الحالية لهذا الاشتراك.

PausedStateContext

معلومات خاصة باشتراك في حالة متوقّفة مؤقتًا

تمثيل JSON
{
  "autoResumeTime": string
}
الحقول
autoResumeTime

string (Timestamp format)

الوقت الذي سيتم فيه استئناف الاشتراك تلقائيًا

يستخدم المعيار RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه مُمثلاً بالتوقيت العالمي المنسَّق مع حرف Z في النهاية ويستخدم الأرقام الجزئية 0 أو 3 أو 6 أو 9. تُقبل أيضًا المعادلات الأخرى التي لا تستخدم حرف Z. أمثلة: "2014-10-02T15:01:23Z" أو "2014-10-02T15:01:23.045123456Z" أو "2014-10-02T15:01:23+05:30"

CanceledStateContext

معلومات خاصة باشتراك في الحالة SUBSCRIPTION_STATE_CANCELED أو SUBSCRIPTION_STATE_EXPIRED

تمثيل JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "userInitiatedCancellation": {
    object (UserInitiatedCancellation)
  },
  "systemInitiatedCancellation": {
    object (SystemInitiatedCancellation)
  },
  "developerInitiatedCancellation": {
    object (DeveloperInitiatedCancellation)
  },
  "replacementCancellation": {
    object (ReplacementCancellation)
  }
  // End of mutually exclusive fields.
}
الحقول
سبب إلغاء الاشتراك في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الردّ:
userInitiatedCancellation

object (UserInitiatedCancellation)

ألغى المستخدم الاشتراك.

systemInitiatedCancellation

object (SystemInitiatedCancellation)

تم إلغاء الاشتراك من قِبل النظام، على سبيل المثال بسبب مشكلة في الفوترة.

developerInitiatedCancellation

object (DeveloperInitiatedCancellation)

ألغى المطوّر الاشتراك.

replacementCancellation

object (ReplacementCancellation)

تم استبدال الاشتراك باشتراك جديد.

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

UserInitiatedCancellation

معلومات خاصة بعمليات الإلغاء التي بدأها المستخدمون

تمثيل JSON
{
  "cancelSurveyResult": {
    object (CancelSurveyResult)
  },
  "cancelTime": string
}
الحقول
cancelSurveyResult

object (CancelSurveyResult)

المعلومات التي يقدّمها المستخدم عند إكمال عملية إلغاء الاشتراك (استطلاع سبب الإلغاء).

cancelTime

string (Timestamp format)

الوقت الذي ألغى فيه المستخدم الاشتراك. قد يظل بإمكان المستخدم الوصول إلى الاشتراك بعد هذا الوقت. استخدِم lineItems.expiry_time لتحديد ما إذا كان المستخدم لا يزال بإمكانه الوصول إلى المحتوى.

يستخدم المعيار RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه مُمثلاً بالتوقيت العالمي المنسَّق مع حرف Z في النهاية ويستخدم الأرقام الجزئية 0 أو 3 أو 6 أو 9. تُقبل أيضًا المعادلات الأخرى التي لا تستخدم حرف Z. أمثلة: "2014-10-02T15:01:23Z" أو "2014-10-02T15:01:23.045123456Z" أو "2014-10-02T15:01:23+05:30"

CancelSurveyResult

نتيجة استطلاع الإلغاء عندما ألغى المستخدم الاشتراك.

تمثيل JSON
{
  "reason": enum (CancelSurveyReason),
  "reasonUserInput": string
}
الحقول
reason

enum (CancelSurveyReason)

السبب الذي اختاره المستخدم في استطلاع الإلغاء

reasonUserInput

string

يتم ضبطه فقط لـ CANCEL_SURVEY_REASON_OTHERS. هذه هي إجابة المستخدم على الاستطلاع بصيغة حرة.

CancelSurveyReason

السبب الذي اختاره المستخدم في استطلاع الإلغاء

عمليات التعداد
CANCEL_SURVEY_REASON_UNSPECIFIED سبب إلغاء الاستطلاع غير محدّد.
CANCEL_SURVEY_REASON_NOT_ENOUGH_USAGE عدم استخدام الاشتراك بشكل كافٍ
CANCEL_SURVEY_REASON_TECHNICAL_ISSUES مشاكل فنية أثناء استخدام التطبيق
CANCEL_SURVEY_REASON_FOUND_BETTER_APP عثر المستخدم على تطبيق أفضل.
CANCEL_SURVEY_REASON_OTHERS أسباب أخرى

SystemInitiatedCancellation

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

معلومات خاصة بعمليات الإلغاء التي بدأها نظام Google

DeveloperInitiatedCancellation

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

معلومات خاصة بعمليات الإلغاء التي بدأها المطوّرون

ReplacementCancellation

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

معلومات خاصة بعمليات الإلغاء الناتجة عن استبدال الاشتراك

TestPurchase

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

يشير هذا الحقل إلى ما إذا كانت عملية شراء الاشتراك هذه تجريبية.

AcknowledgementState

حالات الإقرار المحتملة للاشتراك

عمليات التعداد
ACKNOWLEDGEMENT_STATE_UNSPECIFIED حالة الإقرار غير محدّدة.
ACKNOWLEDGEMENT_STATE_PENDING لم يتم تأكيد الاشتراك بعد.
ACKNOWLEDGEMENT_STATE_ACKNOWLEDGED تمت الموافقة على الاشتراك.

ExternalAccountIdentifiers

معرّف حساب المستخدم في الخدمة التابعة لجهة خارجية

تمثيل JSON
{
  "externalAccountId": string,
  "obfuscatedExternalAccountId": string,
  "obfuscatedExternalProfileId": string
}
الحقول
externalAccountId

string

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

obfuscatedExternalAccountId

string

نسخة مخفية من رقم التعريف المرتبط بشكل فريد بحساب المستخدم في تطبيقك، وتظهر لعمليات الشراء التالية: * إذا تم ربط الحساب كجزء من مسار شراء الاشتراك. * تم تحديده باستخدام https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedaccountid عند إجراء عملية الشراء.

obfuscatedExternalProfileId

string

نسخة مخفية من رقم التعريف المرتبط بشكل فريد بالملف الشخصي للمستخدم في تطبيقك، ولا تظهر إلا إذا تم تحديدها باستخدام https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedprofileid عند إجراء عملية الشراء.

SubscribeWithGoogleInfo

المعلومات المرتبطة بعمليات الشراء التي تمّت من خلال ميزة "اشترِك مع Google"

تمثيل JSON
{
  "profileId": string,
  "profileName": string,
  "emailAddress": string,
  "givenName": string,
  "familyName": string
}
الحقول
profileId

string

رقم تعريف الملف الشخصي في حساب Google للمستخدم عند شراء الاشتراك

profileName

string

اسم الملف الشخصي للمستخدم عند شراء الاشتراك

emailAddress

string

عنوان البريد الإلكتروني للمستخدم عند شراء الاشتراك

givenName

string

الاسم الأول للمستخدم عند شراء الاشتراك

familyName

string

اسم عائلة المستخدم عند شراء الاشتراك

SubscriptionPurchaseLineItem

معلومات على مستوى السلعة لعملية شراء اشتراك

تمثيل JSON
{
  "productId": string,
  "expiryTime": string,
  "developerTargetedOffers": [
    {
      object (DeveloperTargetedOffer)
    }
  ],
  "latestSuccessfulOrderId": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "autoRenewingPlan": {
    object (AutoRenewingPlan)
  },
  "prepaidPlan": {
    object (PrepaidPlan)
  }
  // End of mutually exclusive fields.
  "offerDetails": {
    object (OfferDetails)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "deferredItemReplacement": {
    object (DeferredItemReplacement)
  },
  "deferredItemRemoval": {
    object (DeferredItemRemoval)
  }
  // End of mutually exclusive fields.
  "signupPromotion": {
    object (SignupPromotion)
  },
  "itemReplacement": {
    object (ItemReplacement)
  },
  "offerPhase": {
    object (OfferPhase)
  }
}
الحقول
productId

string

معرّف المنتج الذي تم شراؤه (على سبيل المثال، "monthly001").

expiryTime

string (Timestamp format)

الوقت الذي انتهت فيه صلاحية الاشتراك أو ستنتهي صلاحيته ما لم يتم تمديد فترة الوصول (على سبيل المثال، يتم تجديده).

يستخدم المعيار RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه مُمثلاً بالتوقيت العالمي المنسَّق مع حرف Z في النهاية ويستخدم الأرقام الجزئية 0 أو 3 أو 6 أو 9. تُقبل أيضًا المعادلات الأخرى التي لا تستخدم حرف Z. أمثلة: "2014-10-02T15:01:23Z" أو "2014-10-02T15:01:23.045123456Z" أو "2014-10-02T15:01:23+05:30"

developerTargetedOffers[]

object (DeveloperTargetedOffer)

اختيارية: تفاصيل العروض التي تستهدف المطوّرين والمسجَّلة لهذا البند الإعلاني.

latestSuccessfulOrderId

string

معرّف الطلب لآخر طلب ناجح مرتبط بهذا المنتج لا تظهر هذه السمة إذا لم يكن المستخدم يملك العنصر بعد (على سبيل المثال، العنصر الذي تم تأجيل استبداله).

نوع خطة الاشتراك في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الردّ:
autoRenewingPlan

object (AutoRenewingPlan)

يتم تجديد الاشتراك تلقائيًا.

prepaidPlan

object (PrepaidPlan)

السلعة مدفوعة مسبقًا.

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

object (OfferDetails)

تفاصيل العرض لهذا المنتج

يظهر هذا الحقل عندما يكون هناك تغيير مؤجَّل في السلعة. ويمكن إزالتها أو استبدالها. في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الردّ:
deferredItemReplacement

object (DeferredItemReplacement)

معلومات عن استبدال السلع المؤجَّلة

deferredItemRemoval

object (DeferredItemRemoval)

معلومات حول إزالة السلع المؤجّلة

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

object (SignupPromotion)

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

itemReplacement

object (ItemReplacement)

تفاصيل السلعة التي يتم استبدالها لا تتم تعبئة هذا الحقل إلا إذا حلّ هذا المنتج محل منتج آخر في اشتراك سابق، ولا يتوفّر إلا لمدة 60 يومًا بعد وقت الشراء.

offerPhase

object (OfferPhase)

تفاصيل مرحلة العرض الترويجي الحالية لهذا المنتج

AutoRenewingPlan

معلومات متعلقة بخطة تتجدّد تلقائيًا

تمثيل JSON
{
  "autoRenewEnabled": boolean,
  "recurringPrice": {
    object (Money)
  },
  "priceChangeDetails": {
    object (SubscriptionItemPriceChangeDetails)
  },
  "installmentDetails": {
    object (InstallmentPlan)
  },
  "planTransitionDetails": {
    object (PlanTransitionDetails)
  },
  "priceStepUpConsentDetails": {
    object (PriceStepUpConsentDetails)
  }
}
الحقول
autoRenewEnabled

boolean

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

recurringPrice

object (Money)

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

priceChangeDetails

object (SubscriptionItemPriceChangeDetails)

معلومات عن آخر تغيير في سعر المنتج منذ الاشتراك

installmentDetails

object (InstallmentPlan)

التزام خطة التقسيط والمعلومات ذات الصلة بالحالة لخطة التجديد التلقائي

planTransitionDetails

object (PlanTransitionDetails)

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

SubscriptionItemPriceChangeDetails

المعلومات المتعلّقة بتغيير سعر منتج ضمن الاشتراك

تمثيل JSON
{
  "newPrice": {
    object (Money)
  },
  "priceChangeMode": enum (PriceChangeMode),
  "priceChangeState": enum (PriceChangeState),
  "expectedNewPriceChargeTime": string
}
الحقول
newPrice

object (Money)

السعر المتكرّر الجديد لمنتج الاشتراك

priceChangeMode

enum (PriceChangeMode)

يحدّد وضع تغيير السعر كيفية تغيير سعر منتج الاشتراك.

priceChangeState

enum (PriceChangeState)

تمثّل هذه السمة الولاية التي ينطبق فيها تغيير السعر حاليًا.

expectedNewPriceChargeTime

string (Timestamp format)

وقت التجديد الذي سيصبح فيه تغيير السعر ساريًا للمستخدم ويخضع هذا الوقت للتغيير (إلى وقت مستقبلي) بسبب الحالات التي يتغيّر فيها وقت التجديد، مثل الإيقاف المؤقت. لا تتم تعبئة هذا الحقل إلا إذا لم يدخل تغيير السعر حيز التنفيذ.

يستخدم المعيار RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه مُمثلاً بالتوقيت العالمي المنسَّق مع حرف Z في النهاية ويستخدم الأرقام الجزئية 0 أو 3 أو 6 أو 9. تُقبل أيضًا المعادلات الأخرى التي لا تستخدم حرف Z. أمثلة: "2014-10-02T15:01:23Z" أو "2014-10-02T15:01:23.045123456Z" أو "2014-10-02T15:01:23+05:30"

PriceChangeMode

وضع تغيير السعر

عمليات التعداد
PRICE_CHANGE_MODE_UNSPECIFIED لم يتم تحديد وضع تغيير السعر. يجب عدم ضبط هذه القيمة مطلقًا.
PRICE_DECREASE إذا كان سعر الاشتراك سينخفض
PRICE_INCREASE إذا كان سعر الاشتراك في ازدياد وكان على المستخدم قبوله.
OPT_OUT_PRICE_INCREASE إذا كان سعر الاشتراك سيرتفع مع تفعيل وضع عدم الموافقة

PriceChangeState

حالة تغيير السعر

عمليات التعداد
PRICE_CHANGE_STATE_UNSPECIFIED لم يتم تحديد حالة تغيير السعر. يجب عدم استخدام هذه القيمة.
OUTSTANDING في انتظار موافقة المستخدم على تغيير السعر
CONFIRMED تم تأكيد تغيير السعر للمستخدم.
APPLIED تم تطبيق تغيير السعر، أي بدأ تحصيل السعر الجديد من المستخدم.
CANCELED تم إلغاء تغيير السعر.

InstallmentPlan

معلومات عن خطة التقسيط

تمثيل JSON
{
  "initialCommittedPaymentsCount": integer,
  "subsequentCommittedPaymentsCount": integer,
  "remainingCommittedPaymentsCount": integer,
  "pendingCancellation": {
    object (PendingCancellation)
  }
}
الحقول
initialCommittedPaymentsCount

integer

إجمالي عدد الدفعات التي يلتزم بها المستخدم في البداية

subsequentCommittedPaymentsCount

integer

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

remainingCommittedPaymentsCount

integer

إجمالي عدد الدفعات المتبقية التي يجب تسديدها في دورة التجديد هذه

pendingCancellation

object (PendingCancellation)

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

PendingCancellation

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

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

PlanTransitionDetails

معلومات متعلقة بعملية الانتقال إلى خطة أخرى

تمثيل JSON
{
  "productId": string,
  "basePlanId": string,
  "offerId": string,
  "transitionInfo": {
    object (TransitionInfo)
  }
}
الحقول
productId

string

[مطلوب] معرّف المنتج الذي سيتم نقل هذه الخطة إليه (على سبيل المثال، "monthly001").

basePlanId

string

[مطلوب] معرّف الخطة الأساسية التي سيتم الانتقال إليها.

offerId

string

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

transitionInfo

object (TransitionInfo)

معلومات إضافية حول عملية الانتقال المجدوَلة إلى الخطة لن تظهر إلا إذا تم تحديد موعد لنقل الخطة.

TransitionInfo

معلومات متعلقة بعملية انتقال مجدوَلة إلى خطة أخرى

تمثيل JSON
{
  "transitionState": enum (TransitionState),
  "price": {
    object (Money)
  },
  "expectedTransitionTime": string
}
الحقول
transitionState

enum (TransitionState)

النتائج فقط. [مطلوب] الحالة الحالية لعملية النقل

price

object (Money)

سعر الخطة الأساسية التلقائي الذي سيتم الانتقال إليه.

expectedTransitionTime

string (Timestamp format)

الوقت الحالي المتوقّع لنقل الخطة ويخضع هذا الوقت للتغيير (إلى وقت مستقبلي) بسبب الحالات التي يتغيّر فيها وقت التجديد، مثل الإيقاف المؤقت وتعليق الاشتراك.

يستخدم المعيار RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه مُمثلاً بالتوقيت العالمي المنسَّق مع حرف Z في النهاية ويستخدم الأرقام الجزئية 0 أو 3 أو 6 أو 9. تُقبل أيضًا المعادلات الأخرى التي لا تستخدم حرف Z. أمثلة: "2014-10-02T15:01:23Z" أو "2014-10-02T15:01:23.045123456Z" أو "2014-10-02T15:01:23+05:30"

TransitionState

الحالات المحتملة التي يمكن أن تكون فيها عملية الانتقال.

عمليات التعداد
TRANSITION_STATE_UNSPECIFIED حالة الانتقال غير محدّدة.
SCHEDULED تم تحديد موعد بدء عملية النقل في المستقبل.
IN_PROGRESS تم بدء عملية النقل وإرسال إشعار النقل الأولي إلى المستخدم.
COMPLETED اكتملت عملية النقل.
CANCELED تم إلغاء عملية النقل.

PriceStepUpConsentDetails

معلومات تتعلّق بزيادة السعر التي تتطلّب موافقة المستخدم

تمثيل JSON
{
  "state": enum (ConsentState),
  "consentDeadlineTime": string,
  "newPrice": {
    object (Money)
  }
}
الحقول
state

enum (ConsentState)

النتائج فقط. حالة الموافقة على زيادة السعر

consentDeadlineTime

string (Timestamp format)

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

يستخدم المعيار RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه مُمثلاً بالتوقيت العالمي المنسَّق مع حرف Z في النهاية ويستخدم الأرقام الجزئية 0 أو 3 أو 6 أو 9. تُقبل أيضًا المعادلات الأخرى التي لا تستخدم حرف Z. أمثلة: "2014-10-02T15:01:23Z" أو "2014-10-02T15:01:23.045123456Z" أو "2014-10-02T15:01:23+05:30"

newPrice

object (Money)

السعر الجديد الذي يتطلّب موافقة المستخدم

ConsentState

حالة الموافقة على زيادة السعر

عمليات التعداد
CONSENT_STATE_UNSPECIFIED حالة الموافقة غير محدّدة.
PENDING لم يقدّم المستخدم موافقته بعد.
CONFIRMED وافق المستخدم، والسعر الجديد في انتظار التطبيق.
COMPLETED وافق المستخدم على السعر الجديد وتم تطبيقه.

PrepaidPlan

تمثّل هذه السمة المعلومات المرتبطة بخطة دفع مُسبَق.

تمثيل JSON
{
  "allowExtendAfterTime": string
}
الحقول
allowExtendAfterTime

string (Timestamp format)

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

يستخدم المعيار RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه مُمثلاً بالتوقيت العالمي المنسَّق مع حرف Z في النهاية ويستخدم الأرقام الجزئية 0 أو 3 أو 6 أو 9. تُقبل أيضًا المعادلات الأخرى التي لا تستخدم حرف Z. أمثلة: "2014-10-02T15:01:23Z" أو "2014-10-02T15:01:23.045123456Z" أو "2014-10-02T15:01:23+05:30"

OfferDetails

تمثّل هذه السمة معلومات تفاصيل العرض الترويجي ذات الصلة ببند إعلاني للشراء.

تمثيل JSON
{
  "offerTags": [
    string
  ],
  "basePlanId": string,
  "offerId": string
}
الحقول
offerTags[]

string

أحدث علامات العرض المرتبطة بالعرض وتتضمّن العلامات المكتسَبة من الخطة الأساسية.

basePlanId

string

معرّف الخطة الأساسية تتوفّر لجميع الخطط الأساسية والعروض.

offerId

string

معرّف العرض الترويجي لا يظهر هذا الحقل إلا للعروض الترويجية المخفَّضة السعر.

DeferredItemReplacement

معلومات تتعلّق باستبدال السلع المؤجَّلة

تمثيل JSON
{
  "productId": string
}
الحقول
productId

string

‫productId الذي سيحلّ محلّ productId الحالي

DeferredItemRemoval

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

معلومات تتعلّق باستبدال السلع المؤجَّلة

SignupPromotion

العرض الترويجي الذي تم تطبيقه على هذه السلعة عند شرائها

تمثيل JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "oneTimeCode": {
    object (OneTimeCode)
  },
  "vanityCode": {
    object (VanityCode)
  }
  // End of mutually exclusive fields.
}
الحقول
نوع العرض الترويجي المطبَّق على السلعة في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الردّ:
oneTimeCode

object (OneTimeCode)

تم تطبيق رمز يُستخدَم لمرة واحدة.

vanityCode

object (VanityCode)

تم تطبيق رمز مخصّص.

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

OneTimeCode

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

رمز ترويجي للاستخدام الواحد

VanityCode

رمز ترويجي محدّد مسبقًا ومتعدّد الاستخدامات

تمثيل JSON
{
  "promotionCode": string
}
الحقول
promotionCode

string

الرمز الترويجي

ItemReplacement

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

تمثيل JSON
{
  "productId": string,
  "replacementMode": enum (ReplacementMode),
  "basePlanId": string,
  "offerId": string
}
الحقول
productId

string

معرّف المنتج الخاص بالبند الإعلاني للاشتراك الذي يتم استبداله.

replacementMode

enum (ReplacementMode)

وضع الاستبدال الذي تم تطبيقه أثناء عملية الشراء

basePlanId

string

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

offerId

string

معرّف العرض الترويجي لمنتج الاشتراك الذي يتم استبداله، إن توفّر.

ReplacementMode

وضع الاستبدال للاشتراك

عمليات التعداد
REPLACEMENT_MODE_UNSPECIFIED وضع الاستبدال غير محدّد.
WITH_TIME_PRORATION سيتم احتساب تكلفة الخطة الجديدة على أساس تناسبي وإضافة رصيد من الخطة القديمة.
CHARGE_PRORATED_PRICE سيتم تحصيل سعر نسبي من المستخدم مقابل الخطة الجديدة.
WITHOUT_PRORATION ستحلّ الخطة الجديدة محلّ الخطة القديمة بدون احتساب الوقت بشكل نسبي.
CHARGE_FULL_PRICE سيتم تحصيل السعر الكامل للخطة الجديدة من المستخدم.
DEFERRED سيتم إلغاء الخطة القديمة وستصبح الخطة الجديدة سارية بعد انتهاء صلاحية الخطة القديمة.
KEEP_EXISTING ستبقى الخطة بدون تغيير مع هذا الاستبدال.

OfferPhase

تفاصيل مرحلة العرض الترويجي

تمثيل JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "prorationPeriod": {
    object (ProrationPeriodOfferPhase)
  },
  "freeTrial": {
    object (FreeTrialOfferPhase)
  },
  "introductoryPrice": {
    object (IntroductoryPriceOfferPhase)
  },
  "basePrice": {
    object (BasePriceOfferPhase)
  }
  // End of mutually exclusive fields.
}
الحقول
تفاصيل مرحلة العرض الترويجي في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الردّ:
prorationPeriod

object (ProrationPeriodOfferPhase)

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

freeTrial

object (FreeTrialOfferPhase)

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

introductoryPrice

object (IntroductoryPriceOfferPhase)

يتم ضبطه عندما تكون مرحلة العرض الترويجي هي مرحلة عرض السعر التمهيدي.

basePrice

object (BasePriceOfferPhase)

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

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

ProrationPeriodOfferPhase

تفاصيل حول مرحلة العرض الترويجي لفترة التناسب

تمثيل JSON
{
  "originalOfferPhaseType": enum (OriginalOfferPhaseType)
}
الحقول
originalOfferPhaseType

enum (OriginalOfferPhaseType)

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

OriginalOfferPhaseType

مرحلة العرض الأصلي لدفعات العرض، إذا كانت دفعة العرض هي دفعة تناسبية

عمليات التعداد
ORIGINAL_OFFER_PHASE_TYPE_UNSPECIFIED نوع مرحلة العرض الترويجي الأصلي غير محدّد.
BASE يكون الاشتراك في مرحلة السعر الأساسي (مثل السعر الكامل).
INTRODUCTORY الاشتراك في مرحلة السعر التمهيدي.
FREE_TRIAL الاشتراك في فترة تجريبية مجانية.

FreeTrialOfferPhase

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

تفاصيل حول مرحلة العرض الذي يشمل فترة تجريبية مجانية

IntroductoryPriceOfferPhase

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

تفاصيل حول مرحلة السعر التمهيدي

BasePriceOfferPhase

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

تفاصيل حول مرحلة عرض السعر الأساسي

DeveloperTargetedOffer

معلومات حول عرض ترويجي يستهدف المطوّرين لبند اشتراك

تمثيل JSON
{
  "offerId": string,
  "activateTime": string
}
الحقول
offerId

string

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

activateTime

string (Timestamp format)

اختيارية: الوقت الذي تم فيه تفعيل استهداف العرض

يستخدم المعيار RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه مُمثلاً بالتوقيت العالمي المنسَّق مع حرف Z في النهاية ويستخدم الأرقام الجزئية 0 أو 3 أو 6 أو 9. تُقبل أيضًا المعادلات الأخرى التي لا تستخدم حرف Z. أمثلة: "2014-10-02T15:01:23Z" أو "2014-10-02T15:01:23.045123456Z" أو "2014-10-02T15:01:23+05:30"

OutOfAppPurchaseContext

معلومات خاصة بعملية شراء خارج التطبيق

تمثيل JSON
{
  "expiredExternalAccountIdentifiers": {
    object (ExternalAccountIdentifiers)
  },
  "expiredPurchaseToken": string
}
الحقول
expiredExternalAccountIdentifiers

object (ExternalAccountIdentifiers)

معرّف حساب المستخدم من آخر اشتراك منتهي الصلاحية لرمز التخزين التعريفي هذا.

expiredPurchaseToken

string

الرمز المميّز للشراء لآخر اشتراك انتهت صلاحيته يجب استخدام رمز الشراء هذا فقط للمساعدة في تحديد هوية المستخدم إذا كان الرابط بين رمز الشراء والمستخدم مخزَّنًا في قاعدة بياناتك. ولا يمكن استخدام هذا الرمز لطلب Google Developer API إذا مرّ أكثر من 60 يومًا على انتهاء صلاحيته.

OnHoldStateContext

سياق إضافي حول الاشتراكات في حالة ON_HOLD

تمثيل JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "renewalDeclined": {
    object (RenewalDeclinedContext)
  }
  // End of mutually exclusive fields.
}
الحقول
سبب تعليق الاشتراك في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الردّ:
renewalDeclined

object (RenewalDeclinedContext)

اختيارية: تم رفض الدفعة مقابل التجديد.

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

RenewalDeclinedContext

سياق يتعلّق بسيناريو رفض التجديد

تمثيل JSON
{
  "pendingOrderId": string
}
الحقول
pendingOrderId

string

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

InGracePeriodStateContext

سياق إضافي حول الاشتراكات في حالة فترة السماح.

تمثيل JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "renewalDeclined": {
    object (RenewalDeclinedContext)
  }
  // End of mutually exclusive fields.
}
الحقول
سبب كون الاشتراك في حالة IN_GRACE_PERIOD في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الردّ:
renewalDeclined

object (RenewalDeclinedContext)

اختيارية: تم رفض الدفعة مقابل التجديد.

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

الطُرق

activateoffertargeting

لتفعيل الاستهداف لعرض معيّن

cancel

إلغاء عملية شراء اشتراك للمستخدم

cancelplantransition

إلغاء عملية انتقال اشتراك إلى خطة أخرى

deactivateoffertargeting

لإيقاف استهداف عرض ترويجي معيّن

defer

تؤجّل هذه الطريقة تجديد الاشتراك.

get

الحصول على بيانات وصفية حول اشتراك

revoke

إبطال عملية شراء اشتراك للمستخدم

scheduleplantransition

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

رموز الخطأ

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

رمز الخطأ السبب الوصف الدقة
400 / 410 subscriptionExpired انتهت صلاحية الاشتراك ولا يمكن تنفيذ العملية المطلوبة. تحقَّق من وقت انتهاء صلاحية الاشتراك. لا يُسمح بإجراء هذه العملية على الاشتراكات منتهية الصلاحية.
400 subscriptionInvalidArgument تم تقديم وسيطة غير صالحة في طلب الاشتراك. راجِع مستندات واجهة برمجة التطبيقات وتأكَّد من توفير جميع الحقول المطلوبة وتنسيقها بشكل صحيح.
400 invalidPurchaseState عملية الشراء ليست في حالة صالحة لتنفيذ العملية المطلوبة. على سبيل المثال، قد تكون تحاول تأكيد عملية شراء تم استهلاكها بالفعل أو إلغاء اشتراك غير نشط. يُرجى التحقّق من الحالة الحالية للمرجع باستخدام واجهة برمجة التطبيقات Get API المقابلة قبل محاولة تنفيذ العملية. تأكَّد من أنّ المورد في حالة مناسبة للإجراء.
400 invalidValue تم إدخال قيمة غير صالحة في الطلب. يتم عرض هذه الحالة غالبًا في حال استخدام رمز مميّز للشراء غير صالح أو غير صحيح. يُرجى تصحيح قيمة الحقل غير الصالحة في نص الطلب أو المَعلمات استنادًا إلى مرجع واجهة برمجة التطبيقات.
400 prepaidSubscriptionNotSupported العملية المطلوبة غير متاحة للاشتراكات المدفوعة مسبقًا. تأكَّد من أنّ العملية تنطبق على نوع الاشتراك. هذا الخطأ خاص بطُرق مثل Cancel.
400 productNotOwnedByUser رمز الشراء المقدَّم صالح، ولكن المنتج ليس مملوكًا للمستخدم حاليًا. يمكن أن يحدث ذلك في حال ردّ الأموال المدفوعة مقابل عملية الشراء أو إلغائها أو انتهاء صلاحيتها قبل تأكيدها. يُرجى التحقّق من الحالة الحالية للمرجع باستخدام واجهة برمجة التطبيقات Get API المقابلة قبل محاولة تنفيذ العملية. تأكَّد من أنّ المورد في حالة مناسبة للإجراء.
400 purchaseTokenMismatch لا يتطابق رمز الشراء المميّز المقدَّم مع عملية الشراء أو اسم الحزمة أو معرّف الاشتراك أو معرّف المنتج. تأكَّد من أنّ جميع التفاصيل في الطلب صحيحة ومتطابقة.
400 required هناك حقل أو معلَمة مطلوبة غير مضمّنة في الطلب. يُرجى الرجوع إلى مستندات واجهة برمجة التطبيقات للتأكّد من تضمين جميع الحقول والمَعلمات الإلزامية.
400 unsupportedIabType هذه العملية غير متاحة لنوع الفوترة داخل التطبيق المحدّد. تأكَّد من أنّ طريقة واجهة برمجة التطبيقات متوافقة مع نوع العنصر الذي تتم إدارته.
403 userInsufficientPermission لا يملك المستخدم الإذن الكافي لتنفيذ العملية المطلوبة. تأكَّد من أنّ المستخدم الذي تمت مصادقته لديه الأذونات اللازمة في Google Play Console. يُرجى الاطّلاع على استخدام حساب خدمة لمزيد من التفاصيل.
404 notFound تعذَّر العثور على المورد المطلوب. تحقَّق من صحة المعرّفات (مثل رمز الشراء واسم الحزمة ومعرّف المنتج ومعرّف الاشتراك).
409 concurrentUpdate حدثت محاولة لتعديل عنصر يتم تعديله في الوقت نفسه. أعِد محاولة إرسال الطلب باستخدام خوارزمية الرقود الأسي الثنائي. تجنَّب إجراء تعديلات متزامنة على المورد نفسه.
410 purchaseTokenNoLongerValid رمز الشراء المميّز غير صالح بشكل دائم لأنّ حساب المستخدم المرتبط به قد تم حذفه أو لأنّ سجلّ الشراء لم يعُد متوفّرًا. يجب إيقاف استخدام رمز الشراء المميّز هذا.
410 subscriptionNoLongerAvailable لم يعُد من الممكن الاستعلام عن عملية شراء الاشتراك لأنّ صلاحيته انتهت منذ فترة طويلة جدًا. يشير هذا الخطأ إلى انتهاء صلاحية الاشتراك لأكثر من 60 يومًا. يجب عدم طلب هذه الاشتراكات بعد الآن.
5xx Generic error خطأ عام في خادم Google Play أعِد محاولة إرسال طلبك.

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