REST Resource: externaltransactions

משאב: עסקה חיצונית

הפרטים של עסקה חיצונית.

ייצוג 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,
  "externalOfferInitialAcquisitionDetails": {
    object (ExternalOfferInitialAcquisitionDetails)
  },

  // Union field transaction_type can be only one of the following:
  "oneTimeTransaction": {
    object (OneTimeExternalTransaction)
  },
  "recurringTransaction": {
    object (RecurringExternalTransaction)
  }
  // End of list of possible types for union field transaction_type.
}
שדות
packageName

string

פלט בלבד. שם המשאב של הטרנזקציה החיצונית. שם החבילה של האפליקציה שבה נמכרו המוצרים מתוך האפליקציה (לדוגמה, 'com.some.app').

externalTransactionId

string

פלט בלבד. המזהה של העסקה הזו. כל מזהי העסקאות לאותו שם חבילה חייבים להיות ייחודיים. מגדירים את זה כשיוצרים את העסקה החיצונית.

originalPreTaxAmount

object (Price)

חובה. סכום העסקה המקורי לפני מיסים. הנתון הזה מייצג את הסכום המקורי לפני מס ש-Google קיבלה במקור לפני שהתקבלו החזרים כספיים.

originalTaxAmount

object (Price)

חובה. סכום המס המקורי. הנתון הזה מייצג את סכום המס שהודענו לו במקור ל-Google לפני שהתקבלו החזרים כספיים.

currentPreTaxAmount

object (Price)

פלט בלבד. סכום העסקה הנוכחי לפני מס. הנתון הזה מייצג את הסכום הנוכחי לפני מס, כולל כל ההחזרים הכספיים שבוצעו על העסקה הזו.

currentTaxAmount

object (Price)

פלט בלבד. סכום המס הנוכחי. הנתון הזה מייצג את סכום המס הנוכחי, כולל החזרים כספיים שבוצעו על העסקה הזו.

testPurchase

object (ExternalTransactionTestPurchase)

פלט בלבד. אם הוגדרה, העסקה הזו הייתה רכישה לניסיון. Google לא תחייב אתכם על עסקת בדיקה.

transactionTime

string (Timestamp format)

חובה. השעה שבה העסקה הושלמה.

חותמת זמן ב-RFC3339 UTC 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".

createTime

string (Timestamp format)

פלט בלבד. השעה שבה העסקה הזו נוצרה. המועד הזה שבו Google קיבלה הודעה על העסקה.

חותמת זמן ב-RFC3339 UTC 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".

transactionState

enum (TransactionState)

פלט בלבד. המצב הנוכחי של העסקה.

userTaxAddress

object (ExternalTransactionAddress)

חובה. כתובת המשתמש לצורך חישוב המס.

transactionProgramCode

integer

זה שינוי אופציונלי. קוד תוכנית העסקאות, המשמש לקביעת עמלת השירות עבור אפליקציות שעומדות בדרישות ומשתתפות בתוכניות שותפים. מפתחים שמשתתפים בתוכנית חוויית המדיה של Play (https://play.google.com/console/about/programs/mediaprogram/) חייבים לספק את קוד התוכנית כשהם מדווחים על עסקאות במערכת חיוב חלופית. אם אתם מפתחים שעומדים בדרישות, תוכלו לפנות ל-BDM כדי לקבל מידע נוסף על הגדרת השדה הזה. הערה: לא ניתן להשתמש בשדה הזה לעסקאות חיצוניות של מבצעים.

externalOfferInitialAcquisitionDetails

object (ExternalOfferInitialAcquisitionDetails)

זה שינוי אופציונלי. פרטים על הפעם הראשונה שבה משתמש/מכשיר השלים עסקה באמצעות מבצעים חיצוניים. לא נדרש בעסקאות שמבוצעות באמצעות מערכת חיוב לבחירת המשתמש או מערכת חיוב חלופית בלבד.

שדה איחוד transaction_type. סוג העסקה שבוצעה. transaction_type יכול להיות רק אחת מהאפשרויות הבאות:
oneTimeTransaction

object (OneTimeExternalTransaction)

זוהי עסקה חד-פעמית ולא חלק ממינוי.

recurringTransaction

object (RecurringExternalTransaction)

העסקה הזו היא חלק מסדרה חוזרת של עסקאות.

ExternalTransactionTestPurchase

אין שדות בסוג הזה.

מייצג עסקה שבוצעה באמצעות חשבון בדיקה. Google לא תחייב את העסקאות האלו.

OneTimeExternalTransaction

מייצג עסקה חד-פעמית.

ייצוג JSON
{
  "externalTransactionToken": string
}
שדות
externalTransactionToken

string

קלט בלבד. סופק במהלך השיחה ליצירה. מאוחזר מהלקוח כשתהליך החיוב החלופי מופעל.

RecurringExternalTransaction

מייצג עסקה שהיא חלק מסדרה של תשלומים קבועים. המוצר יכול להיות מינוי או מוצר חד-פעמי עם כמה תשלומים (כמו הזמנה מראש).

ייצוג JSON
{

  // Union field source can be only one of the following:
  "initialExternalTransactionId": string,
  "externalTransactionToken": string,
  "migratedTransactionProgram": enum (ExternalTransactionProgram)
  // End of list of possible types for union field source.

  // Union field product_details can be only one of the following:
  "externalSubscription": {
    object (ExternalSubscription)
  },
  "otherRecurringProduct": {
    object (OtherRecurringProduct)
  }
  // End of list of possible types for union field product_details.
}
שדות

שדה איחוד source.

source יכול להיות רק אחת מהאפשרויות הבאות:

initialExternalTransactionId

string

מזהה העסקה החיצוני של העסקה הראשונה בסדרה החוזרת של העסקאות. למשל, עבור מינוי, זה יהיה מזהה העסקה של התשלום הראשון. חובה כשיוצרים עסקאות חיצוניות חוזרות.

externalTransactionToken

string

קלט בלבד. סופק במהלך השיחה ליצירה. מאוחזר מהלקוח כשתהליך החיוב החלופי מופעל. נדרש רק עבור הרכישה הראשונית.

migratedTransactionProgram

enum (ExternalTransactionProgram)

קלט בלבד. סופק במהלך השיחה ליצירה. יש להשתמש באפשרות הזו רק כשמעבירים מינוי מדיווח חודשי ידני לדיווח אוטומטי.

שדה איחוד product_details. חובה. פרטי המוצר בעסקה החיצונית החוזרת. product_details יכול להיות רק אחת מהאפשרויות הבאות:
externalSubscription

object (ExternalSubscription)

פרטים על מינוי חיצוני.

otherRecurringProduct

object (OtherRecurringProduct)

פרטים על מוצר בעסקה חיצונית קבועה שלא שייך לאף קטגוריה ספציפית אחרת.

ExternalTransactionProgram

מייצג את תוכנית העסקאות החיצונית שהמשתמש חווה כדי להשלים את העסקה.

טיפוסים בני מנייה (enum)
EXTERNAL_TRANSACTION_PROGRAM_UNSPECIFIED תוכנית העסקאות לא מוגדרת. לא בשימוש.
USER_CHOICE_BILLING חיוב לבחירת המשתמש, שבו המשתמשים יכולים לבחור בין חיוב בניהול מפתחים לחיוב ב-Google Play.
ALTERNATIVE_BILLING_ONLY מערכת חיוב חלופית בלבד, שבה המשתמשים יכולים להשתמש רק בחיוב דרך חשבון ניהול של מפתח.

ExternalSubscription

פרטים על מינוי חיצוני.

ייצוג JSON
{
  "subscriptionType": enum (SubscriptionType)
}
שדות
subscriptionType

enum (SubscriptionType)

חובה. סוג המינוי החיצוני.

SubscriptionType

סוגי המינויים החיצוניים.

טיפוסים בני מנייה (enum)
SUBSCRIPTION_TYPE_UNSPECIFIED לא צוין, לא להשתמש.
RECURRING זהו מינוי קבוע שבו המשתמש מחויב בכל מחזור חיובים.
PREPAID זהו מינוי בתשלום מראש, שבו המשתמש משלם מראש.

OtherRecurringProduct

אין שדות בסוג הזה.

פרטים על מוצר בעסקה חיצונית קבועה שלא שייך לאף קטגוריה אחרת ספציפית יותר.

TransactionState

המצב של העסקה שמתבצעת.

טיפוסים בני מנייה (enum)
TRANSACTION_STATE_UNSPECIFIED מצב העסקה לא צוין. לא בשימוש.
TRANSACTION_REPORTED העסקה דווחה ל-Google בהצלחה.
TRANSACTION_CANCELED בוצע החזר כספי מלא על העסקה.

ExternalTransactionAddress

כתובת המשתמש עבור העסקה החיצונית.

ייצוג JSON
{
  "regionCode": string,
  "administrativeArea": string
}
שדות
regionCode

string

חובה. קוד אזור בן שתי אותיות על סמך קודי אזור של ISO-3166-1 Alpha-2 (קודי אזור של UN).

administrativeArea

string

זה שינוי אופציונלי. חלוקת משנה מנהלית ברמה העליונה של המדינה/האזור. נדרש רק לעסקאות בהודו.

ExternalOfferInitialAcquisitionDetails

פרטים על הפעם הראשונה שבה משתמש/מכשיר השלים עסקה באמצעות מבצעים חיצוניים.

ייצוג JSON
{
  "externalTransactionId": string
}
שדות
externalTransactionId

string

חובה. מזהה העסקה החיצוני של הרכישה הראשונה שהמשתמש ביצע.

שיטות

createexternaltransaction

יצירת עסקה חיצונית חדשה.

getexternaltransaction

מקבל עסקה חיצונית קיימת.

refundexternaltransaction

מבצעים החזר כספי או מבצעים החזר כספי חלקי על עסקה חיצונית קיימת.