REST Resource: externaltransactions

• リソース: ExternalTransaction
  • JSON 表現
• ExternalTransactionTestPurchase
• OneTimeExternalTransaction
  • JSON 表現
• RecurringExternalTransaction
  • JSON 表現
• ExternalTransactionProgram
• ExternalSubscription
  • JSON 表現
• SubscriptionType
• OtherRecurringProduct
• TransactionState
• ExternalTransactionAddress
  • JSON 表現
• ExternalOfferDetails
  • JSON 表現
• ExternalOfferLinkType
• ExternalOfferAppCategory
• ExternalContentLinkDetails
  • JSON 表現
• ExternalContentLinkType
• ExternalContentAppCategory
• メソッド

リソース: 外部トランザクション

外部取引の詳細。

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 出力専用。この取引の ID。同じパッケージ名のすべての取引 ID は一意である必要があります。外部取引を作成するときに設定します。
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) 出力専用。この取引が作成された日時。これは、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 省略可。取引プログラムコードは、パートナープログラムに参加する対象アプリのサービス手数料を決定する際に使用されます。Google Play メディア エクスペリエンス プログラム（https://play.google.com/console/about/programs/mediaprogram/）に参加しているデベロッパーは、代替の課金システムでの取引を報告する際にプログラム コードを提供する必要があります。対象となる開発者の方は、このフィールドの設定方法について、担当のビジネス開発マネージャー（BDM）にお問い合わせください。注：このフィールドは外部オファーの取引には使用できません。
実行された取引の種類。以下は、相互に排他的なフィールドのリストです。レスポンスで設定されるフィールドは最大で 1 つです。
oneTimeTransaction	object (OneTimeExternalTransaction) これは 1 回限りの取引であり、定期購読の一部ではありません。
recurringTransaction	object (RecurringExternalTransaction) この取引は、定期的に繰り返される取引の一環です。
相互に排他的なフィールドの終了。
取引レポートに必要なプログラム固有の詳細。詳細は、トランザクションが関連付けられているプログラムに対してのみ設定する必要があります。以下は、相互に排他的なフィールドのリストです。レスポンスで設定されるフィールドは最大で 1 つです。
externalOfferDetails	object (ExternalOfferDetails) 省略可。外部提案の取引を正確に報告するために必要な詳細。
externalContentLinkDetails	object (ExternalContentLinkDetails) 省略可。外部コンテンツ リンクの取引を正確に報告するために必要な詳細。
相互に排他的なフィールドの終了。

ExternalTransactionTestPurchase

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

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

OneTimeExternalTransaction

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

JSON 表現
{ "externalTransactionToken": string }

フィールド
externalTransactionToken	string 入力専用。Create の呼び出し中に提供されます。代替請求フローが開始された際に、クライアントから取得されます。

RecurringExternalTransaction

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

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. }

フィールド
以下は、相互に排他的なフィールドのリストです。レスポンスで設定されるフィールドは最大で 1 つです。
initialExternalTransactionId	string 定期的に繰り返される取引のうちで最初に行った取引の外部取引 ID。たとえば、定期購入の場合は、最初の支払いの取引 ID がこれに当てはまります。定期的な外部取引を作成する際に必須です。
externalTransactionToken	string 入力専用。Create 呼び出し時に提供されます。代替の課金システムのフローを開始するときにクライアントから取得します。最初の購入の場合のみ必須です。
migratedTransactionProgram	enum (ExternalTransactionProgram) 入力専用。Create の呼び出し中に提供されます。定期購入の月次レポートを手動から自動に移行する場合にのみ使用する必要があります。
相互に排他的なフィールドの終了。
必須。定期的な外部取引におけるアイテムの詳細。以下は、相互に排他的なフィールドのリストです。レスポンスで設定されるフィールドは最大で 1 つです。
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」です。

ExternalOfferDetails

外部提案プログラムに固有のレポートの詳細。

JSON 表現
{ "linkType": enum (ExternalOfferLinkType), "installedAppPackage": string, "installedAppCategory": enum (ExternalOfferAppCategory), "appDownloadEventExternalTransactionId": string }

フィールド
linkType	enum (ExternalOfferLinkType) 省略可。この取引によって報告されているコンテンツの種類。Google Play でインストールされたアプリ内で行われたアプリのダウンロード数や購入されたデジタル コンテンツのオファーをレポートする際に必要です。
installedAppPackage	string 省略可。この取引を通じてダウンロードされたアプリのパッケージ名。linkType が LINK_TO_APP_DOWNLOAD の場合は必須です。
installedAppCategory	enum (ExternalOfferAppCategory) 省略可。この取引を通じてダウンロードされたアプリのカテゴリ。これは、外部アプリの確認プロセス中に Google Play Console で指定されたカテゴリと一致している必要があります。アプリのダウンロード時のみ必要です。
appDownloadEventExternalTransactionId	string 省略可。外部リンクを介したアプリのダウンロード イベントに関連付けられた外部トランザクション ID。外部インストールされたアプリで行われた取引を報告する場合は必須です。

ExternalOfferLinkType

外部リンクのタイプ。

列挙型
EXTERNAL_OFFER_LINK_TYPE_UNSPECIFIED	指定がない場合は使用しないでください。
LINK_TO_DIGITAL_CONTENT_OFFER	デジタル コンテンツの購入を提案します。
LINK_TO_APP_DOWNLOAD	アプリのインストール。

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) }

フィールド
linkType	enum (ExternalContentLinkType) 必須。このトランザクションによって報告されるタイプコンテンツ。
installedAppPackage	string 省略可。この取引を通じてダウンロードされたアプリのパッケージ名。アプリのインストールの場合のみ必須です。
externalAppCategory	enum (ExternalContentAppCategory) 省略可。ダウンロードされたアプリのカテゴリ。これは、外部アプリの確認プロセス中に Google Play Console で指定されたカテゴリと一致する必要があります。アプリのインストールの場合のみ必須です。

ExternalContentLinkType

外部リンクのタイプ。

列挙型
EXTERNAL_CONTENT_LINK_TYPE_UNSPECIFIED	指定がない場合は使用しないでください。
LINK_TO_DIGITAL_CONTENT_OFFER	デジタル コンテンツの購入を提案します。
LINK_TO_APP_DOWNLOAD	アプリのインストール。

ExternalContentAppCategory

ダウンロードしたアプリのカテゴリ。アプリのカテゴリの詳細については、https://support.google.com/googleplay/android-developer/answer/9859673 を参照してください。

列挙型
EXTERNAL_CONTENT_APP_CATEGORY_UNSPECIFIED	未指定。使用しないでください。
APP	アプリはアプリのカテゴリに分類されます。
GAME	アプリがゲームカテゴリに分類されている。

メソッド
createexternaltransaction	新しい外部トランザクションを作成します。
getexternaltransaction	既存の外部取引を取得します。
refundexternaltransaction	既存の外部取引の払い戻し、または一部払い戻しを行います。

エラーコード

このリソースのオペレーションは、次の HTTP エラーコードを返します。

エラーコード	理由	説明	解決策