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,

  // 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

出力専用。この取引の ID。同じパッケージ名のすべての取引 ID は一意である必要があります。外部取引を作成するときに設定します。
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」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
createTime

string (Timestamp format)

出力専用。この取引が作成された日時。これは、Google に取引が通知された日時です。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
transactionState

enum (TransactionState)

出力専用。取引の現在のステータス。
userTaxAddress

object (ExternalTransactionAddress)

必須。税金の計算に使用するユーザーの住所。
transactionProgramCode

integer

省略可。取引プログラム コード。パートナー プログラムに参加している対象アプリのサービス手数料の決定に使用されます。Google Play メディア エクスペリエンス プログラム（https://play.google.com/console/about/programs/mediaprogram/）に参加しているデベロッパーは、代替の課金システムでの取引を報告する際にプログラム コードを提供する必要があります。対象となるデベロッパー様は、このフィールドの設定方法について BDM にお問い合わせください。注: このフィールドは、外部オファー取引では使用できません。
共用体フィールド transaction_type。履行された取引の種類。transaction_type は次のいずれかになります。
oneTimeTransaction

object (OneTimeExternalTransaction)

これは 1 回限りの取引であり、定期購入の一環ではありません。
recurringTransaction

object (RecurringExternalTransaction)

この取引は、定期的に繰り返される取引の一環です。

ExternalTransactionTestPurchase

この型にはフィールドがありません。

テスト アカウントを使用して履行された取引を表します。こうした取引に対して Google が料金を請求することはありません。

OneTimeExternalTransaction

1 回限りの取引を表します。

JSON 表現 
{
  "externalTransactionToken": string
}
フィールド
externalTransactionToken

string

入力のみのCreate の呼び出し中に提供されます。代替の課金システムのフローを開始するときにクライアントから取得します。

RecurringExternalTransaction

定期的な支払いの一環である取引を表します。定期購入や、複数回の支払いを伴う 1 回限りのアイテム（予約購入など）が考えられます。

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

定期的に繰り返される取引のうちで最初に行った取引の外部取引 ID。たとえば、定期購入の場合は、最初の支払いの取引 ID がこれに当てはまります。定期的な外部取引を作成する場合は必須です。
externalTransactionToken

string

入力のみのCreate の呼び出し中に提供されます。代替の課金システムのフローを開始するときにクライアントから取得します。最初の購入の場合のみ必須です。
migratedTransactionProgram

enum (ExternalTransactionProgram)

入力のみのCreate の呼び出し中に提供されます。定期購入の月次レポートを手動から自動に移行する場合にのみ使用する必要があります。
共用体フィールド product_details。必須。定期的な外部取引におけるアイテムの詳細。product_details は次のいずれかになります。
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（国連の地域コード）に基づく 2 文字の地域コード。
administrativeArea

string

省略可。国または地域の最上位の行政区分。インドでの取引の場合のみ必須です。有効な値は、「ANDAMAN AND NICOBAR ISLANDS」、「ANDHRA PRADESH」、「ARUNACHAL PRADESH」、「ASSAM」、「BIHAR」、「CHANDIGARH」、「CHHATTISGARH」、「DADRA AND NAGAR HAVELI」、「DADRA AND NAGAR HAVELI AND DAMAN AND DIU」、「DAMAN AND DIU」、「DELHI」、「GOA」、「GUJARAT」、「HARYANA」、「HIMACHAL PRADESH」、「JAMMU AND KASHMIR」、「JHARKHAND」、「KARNATAKA」、「KERALA」、「LADAKH」、「LAKSHADWEEP」、「MADHYA PRADESH」、「MAHARASHTRA」、「MANIPUR」、「MEGHALAYA」、「MIZORAM」、「NAGALAND」、「ODISHA」、「PUDUCHERRY」、「PUNJAB」、「RAJASTHAN」、「SIKKIM」、「TAMIL NADU」、「TELANGANA」、「TRIPURA」、「UTTAR PRADESH」、「UTTARAKHAND」、「WEST BENGAL」です。

メソッド

createexternaltransaction

 新しい外部取引を作成します。

getexternaltransaction

 既存の外部トランザクションを取得します。

refundexternaltransaction

 既存の外部取引の払い戻し、または一部払い戻しを行います。