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,
  "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

出力専用。この取引の 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 にお問い合わせください。注: このフィールドは外部提案の取引には使用できません。

externalOfferInitialAcquisitionDetails

object (ExternalOfferInitialAcquisitionDetails)

省略可。ユーザーまたはデバイスが外部提案を使用して初めて取引を完了した時点の詳細。ユーザー選択型決済または代替の課金システムのみを使用して行われる取引では不要です。

共用体フィールド 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(UN 地域コード)に基づく 2 文字の地域コード。

administrativeArea

string

省略可。国または地域の最上位の行政区域。インドでの取引にのみ必要です。

ExternalOfferInitialAcquisitionDetails

ユーザーまたはデバイスが外部提案を使用して初めて取引を完了した時点の詳細。

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

string

必須。ユーザーが最初に完了した購入の外部取引 ID。

メソッド

createexternaltransaction

新しい外部トランザクションを作成します。

getexternaltransaction

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

refundexternaltransaction

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