REST Resource: purchases.subscriptions

المرجع: Subscriptionpurchase

يشير مرجع Subscriptionpurchase إلى حالة عملية شراء الاشتراك التي أجراها المستخدم.

تمثيل JSON
{
  "kind": string,
  "startTimeMillis": string,
  "expiryTimeMillis": string,
  "autoResumeTimeMillis": string,
  "autoRenewing": boolean,
  "priceCurrencyCode": string,
  "priceAmountMicros": string,
  "introductoryPriceInfo": {
    object (IntroductoryPriceInfo)
  },
  "countryCode": string,
  "developerPayload": string,
  "paymentState": integer,
  "cancelReason": integer,
  "userCancellationTimeMillis": string,
  "cancelSurveyResult": {
    object (SubscriptionCancelSurveyResult)
  },
  "orderId": string,
  "linkedPurchaseToken": string,
  "purchaseType": integer,
  "priceChange": {
    object (SubscriptionPriceChange)
  },
  "profileName": string,
  "emailAddress": string,
  "givenName": string,
  "familyName": string,
  "profileId": string,
  "acknowledgementState": integer,
  "externalAccountId": string,
  "promotionType": integer,
  "promotionCode": string,
  "obfuscatedExternalAccountId": string,
  "obfuscatedExternalProfileId": string
}
الحقول
kind

string

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

startTimeMillis

string (int64 format)

الوقت الذي تم فيه منح الاشتراك، بالمللي ثانية منذ تاريخ حقبة

expiryTimeMillis

string (int64 format)

الوقت الذي سينتهي فيه الاشتراك بالمللي ثانية منذ تاريخ الحقبة

autoResumeTimeMillis

string (int64 format)

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

autoRenewing

boolean

ما إذا كان سيتم تجديد الاشتراك تلقائيًا عند الوصول إلى وقت انتهاء صلاحيته الحالي.

priceCurrencyCode

string

رمز العملة وفقًا لمعيار ISO 4217 لسعر الاشتراك على سبيل المثال، إذا تم تحديد السعر بالجنيه الإسترليني، فإن priceCurrencyCode هو GBP.

priceAmountMicros

string (int64 format)

سعر الاشتراك في البلدان التي لا تشمل الضرائب، لا يشمل السعر الضريبة. بالنسبة إلى البلدان التي تشمل الأسعار، يشمل السعر الضريبة. يتم التعبير عن السعر بوحدات ميكرو، حيث تمثل 1,000,000 وحدة ميكرو وحدة واحدة من العملة. على سبيل المثال، إذا كان سعر الاشتراك هو 1.99 يورو، تكون قيمة priceAmountMicros هي 1990000.

introductoryPriceInfo

object (IntroductoryPriceInfo)

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

لا يشير هذا الحقل إلى أنّ الاشتراك في فترة السعر التمهيدي.

countryCode

string

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

developerPayload

string

سلسلة يحدِّدها المطوِّر وتحتوي على معلومات تكميلية حول طلب

paymentState

integer

حالة دفع الاشتراك القيم المحتملة هي: 0. الدفعة معلّقة 1. تم استلام الدفعة 2- الإصدار التجريبي المجاني 3. في انتظار الترقية/الرجوع إلى إصدار سابق

لا يتوفّر هذا الخيار للاشتراكات الملغاة ومنتهية الصلاحية.

cancelReason

integer

سبب إلغاء الاشتراك أو عدم تجديده تلقائيًا القيم المحتملة هي: 0. ألغى المستخدم الاشتراك 1. ألغَى النظام الاشتراك، مثلاً بسبب مشكلة في الفوترة 2. تم استبدال الاشتراك باشتراك جديد 3. تم إلغاء الاشتراك من قِبل المطوّر.

userCancellationTimeMillis

string (int64 format)

الوقت الذي ألغى فيه المستخدم الاشتراك بالمللي ثانية منذ تاريخ بدء حساب الفترة لا يتوفّر الحدث إلا إذا كان سبب الإلغاء هو 0.

cancelSurveyResult

object (SubscriptionCancelSurveyResult)

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

orderId

string

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

linkedPurchaseToken

string

رمز الشراء لعملية الشراء الأصلية إذا كان هذا الاشتراك أيًا مما يلي: 0 إعادة الاشتراك في اشتراك تم إلغاؤه ولكنه غير منتهي 1- الترقية أو الرجوع إلى إصدار سابق من اشتراك سابق

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

purchaseType

integer

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

priceChange

object (SubscriptionPriceChange)

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

بعد تجديد الاشتراك بالسعر الجديد أو إلغائه، لن تظهر أي معلومات عن تغيير السعر.

profileName

string

اسم الملف الشخصي للمستخدم عند شراء الاشتراك. لا يتوفّر العرض إلا لعمليات الشراء التي تتم باستخدام ميزة "اشترِك مع Google".

emailAddress

string

عنوان البريد الإلكتروني للمستخدم عند شراء الاشتراك. لا يتوفّر العرض إلا لعمليات الشراء التي تتم باستخدام ميزة "اشترِك مع Google".

givenName

string

الاسم المحدّد للمستخدم عند شراء الاشتراك لا يتوفّر العرض إلا لعمليات الشراء التي تتم باستخدام ميزة "اشترِك مع Google".

familyName

string

اسم عائلة المستخدم عند شراء الاشتراك. لا يتوفّر العرض إلا لعمليات الشراء التي تتم باستخدام ميزة "اشترِك مع Google".

profileId

string

معرّف الملف الشخصي في Google للمستخدم عند شراء الاشتراك. لا يتوفّر العرض إلا لعمليات الشراء التي تتم باستخدام ميزة "اشترِك مع Google".

acknowledgementState

integer

حالة الإقرار بالمنتج المتوفّر عند الاشتراك القيم المحتملة هي: 0. لا يتم قبول العرض بعد 1. تمت الموافقة

externalAccountId

string

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

promotionType

integer

نوع العرض الترويجي الساري على عملية الشراء هذه. يتم ضبط هذا الحقل فقط في حال تطبيق عرض ترويجي عند شراء الاشتراك. القيم المحتملة هي: 0. الرمز 1 لمرة واحدة الرموز المخصّصة

promotionCode

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 عند إجراء عملية الشراء.

IntroductoryPriceInfo

يحتوي على معلومات السعر التمهيدي لأحد الاشتراكات.

تمثيل JSON
{
  "introductoryPriceCurrencyCode": string,
  "introductoryPriceAmountMicros": string,
  "introductoryPricePeriod": string,
  "introductoryPriceCycles": integer
}
الحقول
introductoryPriceCurrencyCode

string

رمز العملة ISO 4217 لسعر الاشتراك التمهيدي على سبيل المثال، إذا تم تحديد السعر بالجنيه الإسترليني، فإن priceCurrencyCode هو GBP.

introductoryPriceAmountMicros

string (int64 format)

السعر التمهيدي للاشتراك، غير شامل الضريبة هذه العملة هي نفسها priceCurrencyCode. يتم التعبير عن السعر بوحدات ميكرو، حيث تمثل 1,000,000 وحدة ميكرو وحدة واحدة من العملة. على سبيل المثال، إذا كان سعر الاشتراك هو 1.99 يورو، تكون قيمة priceAmountMicros هي 1990000.

introductoryPricePeriod

string

فترة السعر التمهيدي، محددة بتنسيق ISO 8601 القيم الشائعة هي (على سبيل المثال لا الحصر) "P1W" (أسبوع واحد)، "P1M" (شهر واحد)، "P3M" (ثلاثة أشهر)، "P6M" (ستة أشهر) و"P1Y" (سنة واحدة).

introductoryPriceCycles

integer

عدد المدّة الزمنية للفوترة لتقديم أسعار تمهيدية

SubscriptionCancelSurveyResult

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

تمثيل JSON
{
  "cancelSurveyReason": integer,
  "userInputCancelReason": string
}
الحقول
cancelSurveyReason

integer

سبب الإلغاء الذي اختاره المستخدم في الاستطلاع. القيم المحتملة هي: 0. غير ذلك 1- لا أستفيد من هذه الخدمة بقدرٍ كافٍ 2. المشكلات الفنية 3. الأسباب المتعلقة بالتكلفة 4. اكتشفت تطبيقًا أفضل.

userInputCancelReason

string

سبب الإلغاء المخصّص المُدخَل الذي قدّمه المستخدم لا يتوفّر العرض إلا عندما يكون خيار "سبب الإلغاء" 0.

SubscriptionPriceChange

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

تمثيل JSON
{
  "newPrice": {
    object (Price)
  },
  "state": integer
}
الحقول
newPrice

object (Price)

السعر الجديد الذي سيتم تجديد الاشتراك به إذا وافق المستخدم على تغيير السعر.

state

integer

الحالة الحالية للتغيير في السعر. القيم المحتملة هي: 0. مميز: اذكر تغيير السعر المُعلَّق في انتظار موافقة المستخدم. في هذه الحالة، يمكنك اختياريًا طلب تأكيد من المستخدم باستخدام واجهة برمجة التطبيقات In-App API. 1. مقبول: اذكر التغيير المقبول للسعر الذي سيتم تجديد الاشتراك وفقًا له، ما لم يتم إلغاؤه. يسري هذا التغيير في السعر في تاريخ مستقبلي عند تجديد الاشتراك. يُرجى العِلم أنّ التغيير قد لا يحدث عند تجديد الاشتراك في المرة القادمة.

الطُرق

acknowledge

الإقرار بشراء اشتراك

cancel

يؤدي هذا الإجراء إلى إلغاء شراء اشتراك أحد المستخدمين.

defer

يمكن تأجيل شراء اشتراك المستخدِم حتى وقت انتهاء صلاحية محدَّد في المستقبل.

get

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

refund

يتم ردّ الأموال التي دفعها المستخدم مقابل شراء اشتراك، ولكن يظل الاشتراك صالحًا حتى وقت انتهاء صلاحيته ويستمر تكراره.

revoke

ردّ الأموال وإبطال شراء اشتراك المستخدم على الفور