REST Resource: externaltransactions

المورد: ExternalTransaction

تفاصيل معاملة خارجية

تمثيل JSON 
{
  "packageName": string,
  "externalTransactionId": string,
  "originalPreTaxAmount": {
    object (Price)
  },
  "originalTaxAmount": {
    object (Price)
  },
  "currentPreTaxAmount": {
    object (Price)
  },
  "currentTaxAmount": {
    object (Price)
  },
  "testPurchase": {
    object (ExternalTransactionTestPurchase)
  },
  "transactionTime": string,
  "createTime": string,
  "transactionState": enum (TransactionState),
  "userTaxAddress": {
    object (ExternalTransactionAddress)
  },
  "transactionProgramCode": integer,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "oneTimeTransaction": {
    object (OneTimeExternalTransaction)
  },
  "recurringTransaction": {
    object (RecurringExternalTransaction)
  }
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "externalOfferDetails": {
    object (ExternalOfferDetails)
  },
  "externalContentLinkDetails": {
    object (ExternalContentLinkDetails)
  }
  // End of mutually exclusive fields.
}
الحقول
packageName

string

النتائج فقط. اسم مورد المعاملة الخارجية. اسم حزمة التطبيق الذي تم بيع المنتجات داخله (على سبيل المثال، "com.some.app").
externalTransactionId

string

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

object (Price)

الحقل مطلوب. مبلغ المعاملة الأصلي قبل احتساب الضرائب يمثل هذا المبلغ قبل الضريبة الذي تم إخطار جوجل به في الأصل قبل تطبيق أي عمليات استرداد.
originalTaxAmount

object (Price)

الحقل مطلوب. مبلغ الضريبة الأصلي. يمثّل هذا المبلغ الضريبي الذي تم إبلاغ Google به في الأصل قبل تطبيق أي عمليات ردّ للأموال.
currentPreTaxAmount

object (Price)

النتائج فقط. مبلغ المعاملة الحالي قبل الضريبة يمثّل هذا المبلغ الحالي قبل الضريبة، بما في ذلك أي مبالغ تم ردّها في هذه المعاملة.
currentTaxAmount

object (Price)

النتائج فقط. مبلغ الضريبة الحالي يمثّل هذا الحقل مبلغ الضريبة الحالي، بما في ذلك أي مبالغ تم ردّها في هذه المعاملة.
testPurchase

object (ExternalTransactionTestPurchase)

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

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".
createTime

string (Timestamp format)

النتائج فقط. تمثّل هذه السمة وقت إنشاء هذه المعاملة. هذا هو الوقت الذي تم فيه إبلاغ Google بالمعاملة.

يستخدم المعيار 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".
transactionState

enum (TransactionState)

النتائج فقط. تمثّل هذه السمة الحالة الحالية للمعاملة.
userTaxAddress

object (ExternalTransactionAddress)

الحقل مطلوب. عنوان المستخدم لاحتساب الضريبة
transactionProgramCode

integer

اختياريّ. رمز برنامج المعاملات، المستخدم للمساعدة في تحديد رسوم الخدمة للتطبيقات المؤهلة المشاركة في برامج الشركاء. يجب على المطورين المشاركين في برنامج تجربة الوسائط Play (https://play.google.com/console/about/programs/mediaprogram/) تقديم رمز البرنامج عند الإبلاغ عن معاملات الفوترة البديلة. إذا كنت مطورًا مؤهلًا، فيرجى الاتصال بمدير تطوير الأعمال الخاص بك للحصول على مزيد من المعلومات حول كيفية ضبط هذا الحقل. ملاحظة: لا يمكن استخدام هذا الحقل لمعاملات العروض الخارجية.
نوع المعاملة التي تم إجراؤها. في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الردّ:
oneTimeTransaction

object (OneTimeExternalTransaction)

هذه معاملة لمرة واحدة وليست جزءًا من اشتراك.
recurringTransaction

object (RecurringExternalTransaction)

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

object (ExternalOfferDetails)

اختياريّ. التفاصيل اللازمة للإبلاغ بدقة عن معاملات العروض الخارجية.
externalContentLinkDetails

object (ExternalContentLinkDetails)

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

ExternalTransactionTestPurchase

لا يتضمّن هذا النوع أي حقول.

يمثل هذا معاملة تمت باستخدام حساب تجريبي. لن يتم تحصيل رسوم من هذه المعاملات من قبل جوجل.

OneTimeExternalTransaction

يمثّل معاملة تم إجراؤها مرة واحدة فقط.

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

string

الإدخال فقط يتم توفيرها أثناء استدعاء وظيفة الإنشاء. يتم استردادها من العميل عند بدء مسار الفوترة البديل.

RecurringExternalTransaction

تمثّل هذه السمة معاملة تشكّل جزءًا من سلسلة متكرّرة من الدفعات. يمكن أن يكون ذلك اشتراكًا أو منتجًا مدفوعًا لمرة واحدة مع دفعات متعددة (مثل الطلب المُسبَق).

تمثيل JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "initialExternalTransactionId": string,
  "externalTransactionToken": string,
  "migratedTransactionProgram": enum (ExternalTransactionProgram)
  // End of mutually exclusive fields.

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

string

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

string

الإدخال فقط يتم توفيرها أثناء استدعاء وظيفة الإنشاء. يتم استردادها من العميل عند بدء مسار الفوترة البديل. مطلوب فقط لعملية الشراء الأولية.
migratedTransactionProgram

enum (ExternalTransactionProgram)

الإدخال فقط يتم توفيرها أثناء الاتصال بـ Create. يجب استخدامها فقط عند نقل اشتراك من نظام إعداد التقارير الشهرية اليدوي إلى نظام إعداد التقارير الآلي.
نهاية الحقول التي يستبعد كلّ منها الآخر
الحقل مطلوب. تفاصيل المنتج في المعاملة الخارجية المتكرّرة في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الردّ:
externalSubscription

object (ExternalSubscription)

تعرض هذه السمة تفاصيل الاشتراك الخارجي.
otherRecurringProduct

object (OtherRecurringProduct)

تفاصيل منتج يتضمّن معاملة خارجية متكرّرة لا ينتمي إلى أي فئة أخرى محدّدة
نهاية الحقول التي يستبعد كلّ منها الآخر

ExternalTransactionProgram

تمثّل هذه السمة برنامج المعاملات الخارجية الذي يستخدمه المستخدم لإكمال المعاملة.

عمليات التعداد
EXTERNAL_TRANSACTION_PROGRAM_UNSPECIFIED برنامج المعاملات غير المحدّدة لم يتم استخدامه.
USER_CHOICE_BILLING ميزة "الفوترة حسب اختيار المستخدم"، حيث يمكن للمستخدم الاختيار بين نظام الفوترة في Google Play الذي يديره المطوّر.
ALTERNATIVE_BILLING_ONLY نظام فوترة بديل فقط، حيث يمكن للمستخدمين استخدام نظام فوترة المطوّرين فقط

ExternalSubscription

تعرض هذه السمة تفاصيل الاشتراك الخارجي.

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

enum (SubscriptionType)

الحقل مطلوب. نوع الاشتراك الخارجي

SubscriptionType

أنواع الاشتراكات الخارجية.

عمليات التعداد
SUBSCRIPTION_TYPE_UNSPECIFIED غير محدّد، لا تستخدِم هذه القيمة.
RECURRING هذا اشتراك متكرّر يتم فيه تحصيل الرسوم من المستخدم في كل دورة فوترة.
PREPAID هذا اشتراك مدفوع مسبقًا حيث يدفع المستخدم مقدمًا.

OtherRecurringProduct

لا يتضمّن هذا النوع أي حقول.

تفاصيل منتج معاملة خارجية متكرّرة لا ينتمي إلى أي فئة أخرى أكثر تحديدًا

TransactionState

حالة إجراء معاملة

عمليات التعداد
TRANSACTION_STATE_UNSPECIFIED حالة المعاملة غير محدَّدة. لم يتم استخدامه.
TRANSACTION_REPORTED تم إبلاغ Google عن المعاملة بنجاح.
TRANSACTION_CANCELED تم ردّ الأموال المدفوعة في المعاملة بالكامل.

ExternalTransactionAddress

عنوان المستخدِم لإجراء المعاملة الخارجية.

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

string

الحقل مطلوب. رمز المنطقة المكوّن من حرفَين استنادًا إلى معيار ISO-3166-1 Alpha-2 (رموز مناطق الأمم المتحدة)
administrativeArea

string

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

ExternalOfferDetails

تفاصيل التقارير الخاصة بـ "برنامج العروض الترويجية الخارجية"

تمثيل JSON 
{
  "linkType": enum (ExternalOfferLinkType),
  "installedAppPackage": string,
  "installedAppCategory": enum (ExternalOfferAppCategory),
  "appDownloadEventExternalTransactionId": string
}
الحقول
installedAppPackage

string

اختياريّ. اسم حزمة التطبيق الذي تم تنزيله من خلال هذه المعاملة. مطلوبة عندما تكون قيمة linkType هي LINK_TO_APP_DOWNLOAD.
installedAppCategory

enum (ExternalOfferAppCategory)

اختياريّ. فئة التطبيق الذي تم تنزيله من خلال هذه المعاملة. يجب أن تتطابق هذه الفئة مع الفئة المقدَّمة في Play Console أثناء عملية التحقّق من التطبيق الخارجي. مطلوب فقط لتنزيل التطبيق.
appDownloadEventExternalTransactionId

string

اختياريّ. معرف المعاملة الخارجية المرتبط بحدث تنزيل التطبيق عبر رابط خارجي. مطلوبة عند الإبلاغ عن المعاملات التي تتم في التطبيقات المثبَّتة خارجيًا.

ExternalOfferLinkType

تمثّل هذه السمة نوع الرابط الخارجي.

عمليات التعداد
LINK_TO_DIGITAL_CONTENT_OFFER تمثّل هذه السمة عرضًا لشراء محتوى رقمي.

ExternalOfferAppCategory

فئة التطبيق الذي تم تنزيله. يمكنك الانتقال إلى https://support.google.com/googleplay/android-developer/answer/9859673 للحصول على مزيد من المعلومات حول فئات التطبيقات.

عمليات التعداد
EXTERNAL_OFFER_APP_CATEGORY_UNSPECIFIED غير محدّد، لا تستخدِم هذه القيمة.
APP يتم تصنيف التطبيق ضمن فئة التطبيق.
GAME يتم تصنيف التطبيق ضمن فئة الألعاب.

ExternalContentLinkDetails

تفاصيل التقارير الخاصة ببرنامج الربط بمحتوى خارجي

تمثيل JSON 
{
  "linkType": enum (ExternalContentLinkType),
  "installedAppPackage": string,
  "externalAppCategory": enum (ExternalContentAppCategory)
}
الحقول
installedAppPackage

string

اختياريّ. اسم حزمة التطبيق الذي تم تنزيله من خلال هذه المعاملة. مطلوب فقط لإعلانات الحث على تثبيت التطبيق.
externalAppCategory

enum (ExternalContentAppCategory)

اختياريّ. فئة التطبيق الذي تم تنزيله. يجب أن تتطابق هذه الفئة مع الفئة المُقدمة في Play Console أثناء عملية التحقق من التطبيق الخارجي. مطلوب فقط لإعلانات الحث على تثبيت التطبيق.

ExternalContentLinkType

تمثّل هذه السمة نوع الرابط الخارجي.

عمليات التعداد
EXTERNAL_CONTENT_LINK_TYPE_UNSPECIFIED غير محدّد، لا تستخدِم هذه القيمة.
LINK_TO_DIGITAL_CONTENT_OFFER تمثّل هذه السمة عرضًا لشراء محتوى رقمي.

ExternalContentAppCategory

فئة التطبيق الذي تم تنزيله. يمكنك الانتقال إلى https://support.google.com/googleplay/android-developer/answer/9859673 للحصول على مزيد من المعلومات حول فئات التطبيقات.

عمليات التعداد
EXTERNAL_CONTENT_APP_CATEGORY_UNSPECIFIED غير محدّد، لا تستخدِم هذه القيمة.
APP يتم تصنيف التطبيق ضمن فئة التطبيق.
GAME يتم تصنيف التطبيق ضمن فئة الألعاب.

الطُرق

createexternaltransaction

 يُنشئ معاملة خارجية جديدة.

getexternaltransaction

 تعرض هذه الطريقة معاملة خارجية حالية.

refundexternaltransaction

 ردّ الأموال أو جزء منها في معاملة خارجية حالية

رموز الخطأ

تعرض عمليات هذا المرجع رموز خطأ HTTP التالية:

رمز الخطأ السبب الوصف الدقة