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)

חובה. סכום העסקה המקורי לפני מיסים. זהו הסכום לפני מס שדווח ל-Google במקור לפני החלת החזרים כספיים.
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)

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

הפלט שנוצר תמיד יהיה בפורמט 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

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

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

OneTimeExternalTransaction

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

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

string

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

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

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

enum (ExternalTransactionProgram)

קלט בלבד. הפרטים האלה מסופקים במהלך השיחה עם Create. יש להשתמש בו רק בעת העברת מנוי מדיווח חודשי ידני לדיווח אוטומטי.
סוף השדות הבלעדיים.
חובה. פרטי המוצר בעסקה החיצונית החוזרת. בהמשך מפורטת רשימה של שדות שאי אפשר להשתמש בהם בו-זמנית. רק אחד מהשדות הבאים יוגדר בתשובה:
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 העסקה דווחה בהצלחה לגוגל.
TRANSACTION_CANCELED התקבל החזר כספי מלא על העסקה.

ExternalTransactionAddress

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

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

string

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

string

אופציונלי. יחידת משנה מנהלית עליונה של המדינה/אזור. נדרש רק לעסקאות בהודו. ערכים חוקיים הם "איי אנדמן וניקובאר", "אנדהרא פראדש", "ארונצ'אל פראדש", "אסאם", "ביהאר", "צ'נדיגרה", "צ'הטיסגר", "דדרה ונגאר האוולי", "דדרה ונגאר האוולי ודמאן אנד אדיאו", "דמאן אנד דיו", "GUJARAT", "HARYANA", "HIMACHAL PRADESH", "JAMMU AND KASHMIR", "JHARKHAND", "KARNATAKA", "KERALA", "LADAKH", "LAKSHADWEEP", "MADHYA PRADESH", "MAHARASHTRA", "MANIPUR", "MEGHALAYA", "HAMIZORAM", "MEGHALAYA", "HAZORAMY", "PUNJAB", "RAJASTHAN", "SIKKIM", "TAMIL NADU", "TELANGANA", "TRIPURA", "UTTAR" פראדש", "אוטארקהאנד" ו"בנגל המערבית".

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

סוג הקישור החיצוני.

טיפוסים בני מנייה (enum)
LINK_TO_DIGITAL_CONTENT_OFFER הצעה לרכישת תוכן דיגיטלי.

ExternalOfferAppCategory

קטגוריה של האפליקציה שהורדה. מידע נוסף על קטגוריות של אפליקציות זמין בכתובת https://support.google.com/googleplay/android-developer/answer/9859673.

טיפוסים בני מנייה (enum)
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

סוג הקישור החיצוני.

טיפוסים בני מנייה (enum)
EXTERNAL_CONTENT_LINK_TYPE_UNSPECIFIED לא צוין, אין להשתמש.
LINK_TO_DIGITAL_CONTENT_OFFER הצעה לרכישת תוכן דיגיטלי.

ExternalContentAppCategory

קטגוריה של האפליקציה שהורדה. מידע נוסף על קטגוריות של אפליקציות זמין בכתובת https://support.google.com/googleplay/android-developer/answer/9859673.

טיפוסים בני מנייה (enum)
EXTERNAL_CONTENT_APP_CATEGORY_UNSPECIFIED לא צוין, אין להשתמש.
APP האפליקציה מסווגת לפי קטגוריית האפליקציה.
GAME האפליקציה מסווגת תחת קטגוריית משחקים.

Methods

createexternaltransaction

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

getexternaltransaction

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

refundexternaltransaction

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

קודי שגיאה

הפעולות של משאב זה מחזירות את קודי השגיאה הבאים של HTTP:

קוד שגיאה סיבה תיאור פתרון