REST Resource: monetization.onetimeproducts

リソース: OneTimeProduct

アプリの 1 つの 1 回限りのアイテム。

JSON 表現
{
  "packageName": string,
  "productId": string,
  "listings": [
    {
      object (OneTimeProductListing)
    }
  ],
  "taxAndComplianceSettings": {
    object (OneTimeProductTaxAndComplianceSettings)
  },
  "purchaseOptions": [
    {
      object (OneTimeProductPurchaseOption)
    }
  ],
  "restrictedPaymentCountries": {
    object (RestrictedPaymentCountries)
  },
  "offerTags": [
    {
      object (OfferTag)
    }
  ],
  "regionsVersion": {
    object (RegionsVersion)
  }
}
フィールド
packageName

string

必須。変更不可。親アプリのパッケージ名。

productId

string

必須。変更不可。アイテムの一意のアイテム ID。親アプリ内で一意。アイテム ID の先頭は必ず数字または英小文字とし、数字(0 ~ 9)、英小文字(a ~ z)、アンダースコア(_)、ピリオド(.)のみで構成します。

listings[]

object (OneTimeProductListing)

必須。ローカライズされたタイトルと説明のデータのセット。languageCode が同一の重複するエントリは認められません。

taxAndComplianceSettings

object (OneTimeProductTaxAndComplianceSettings)

税金および法令遵守に関する詳細。

purchaseOptions[]

object (OneTimeProductPurchaseOption)

必須。この 1 回限りのアイテムの購入オプションのセット。

restrictedPaymentCountries

object (RestrictedPaymentCountries)

省略可。この 1 回限りのアイテムの購入が、同じ国で登録された支払い方法に制限されている国。空の場合、支払い地域制限は課されません。

offerTags[]

object (OfferTag)

省略可。この 1 回限りのアイテムに対して指定され、Billing Library を通してアプリに返されるカスタムタグのリスト(最大 20 個)。このアイテムの購入オプションと特典も、Billing Library でこれらのタグを受け取ります。

regionsVersion

object (RegionsVersion)

出力専用。1 回限りのアイテムの生成に使用されたリージョン構成のバージョン。

OneTimeProductListing

1 回限りのアイテムに対する地域のストアの掲載情報。

JSON 表現
{
  "languageCode": string,
  "title": string,
  "description": string
}
フィールド
languageCode

string

必須。BCP-47 で定義されるこのリスティングの言語(例: 「en-US」)。

title

string

必須。この掲載情報の言語における、このアイテムのタイトル。最大文字数は 55 文字です。

description

string

必須。この掲載情報の言語における、このアイテムの説明。最大文字数は 200 文字です。

OneTimeProductTaxAndComplianceSettings

1 回限りのアイテムに関する税金、Google Play ポリシー、法令遵守に関する詳細情報。

JSON 表現
{
  "regionalTaxConfigs": [
    {
      object (RegionalTaxConfig)
    }
  ],
  "isTokenizedDigitalAsset": boolean,
  "regionalProductAgeRatingInfos": [
    {
      object (RegionalProductAgeRatingInfo)
    }
  ],
  "productTaxCategoryCode": string
}
フィールド
regionalTaxConfigs[]

object (RegionalTaxConfig)

地域別の税金に関する設定。

isTokenizedDigitalAsset

boolean

この 1 回限りのアイテムが、トークン化されたデジタル資産を表すアイテムとして宣言されているかどうか。

regionalProductAgeRatingInfos[]

object (RegionalProductAgeRatingInfo)

地域別の年齢制限情報。現在、このフィールドはリージョン コード US でのみサポートされています。

productTaxCategoryCode

string

1 回限りのアイテムに割り当てる商品税カテゴリ コード。商品の税金カテゴリは、商品に適用される取引税率を決定します。詳しくは、ヘルプセンターの記事をご覧ください。

RegionalTaxConfig

特定の地理的地域における税金に関する詳細情報。

JSON 表現
{
  "regionCode": string,
  "taxTier": enum (TaxTier),
  "eligibleForStreamingServiceTaxRate": boolean,
  "streamingTaxType": enum (StreamingTaxType)
}
フィールド
regionCode

string

必須。この設定が適用される地域コード(ISO 3166-2 形式で定義。例: 「US」)。

taxTier

enum (TaxTier)

軽減税率を指定する税ティア。複数の地域でデジタル版のニュース、雑誌、新聞、書籍、オーディオブックを販売するデベロッパーは、軽減税率の対象となることがあります。

詳細

eligibleForStreamingServiceTaxRate

boolean

米国の州および地域の売上に正しく課税するため、アプリにストリーミング サービスが含まれているかどうかを指定してください。このフィールドは米国のみでサポートされています。

streamingTaxType

enum (StreamingTaxType)

米国で通信税または遊興税を徴収する場合は、該当する税区分を選択してください。

詳細

OneTimeProductPurchaseOption

1 回限りのアイテムに対する 1 つの購入オプション。

JSON 表現
{
  "purchaseOptionId": string,
  "state": enum (State),
  "regionalPricingAndAvailabilityConfigs": [
    {
      object (RegionalPricingAndAvailabilityConfig)
    }
  ],
  "newRegionsConfig": {
    object (OneTimeProductPurchaseOptionNewRegionsConfig)
  },
  "offerTags": [
    {
      object (OfferTag)
    }
  ],
  "taxAndComplianceSettings": {
    object (PurchaseOptionTaxAndComplianceSettings)
  },

  // Union field purchase_option_type can be only one of the following:
  "buyOption": {
    object (OneTimeProductBuyPurchaseOption)
  },
  "rentOption": {
    object (OneTimeProductRentPurchaseOption)
  }
  // End of list of possible types for union field purchase_option_type.
}
フィールド
purchaseOptionId

string

必須。変更不可。この購入オプションの固有識別子。1 回限りのアイテム内で一意でなければなりません。先頭は必ず数字または英小文字にしてください。使用できるのは、英小文字(a ~ z)、数字(0 ~ 9)、ハイフン(-)のみです。63 文字以下で指定してください。

state

enum (State)

出力専用。購入オプションのステータス(有効かどうか)。リソースを更新してもこのフィールドは変更できません。代わりに専用のエンドポイントを使用してください。

regionalPricingAndAvailabilityConfigs[]

object (RegionalPricingAndAvailabilityConfig)

この購入オプションに対する地域別の価格と提供状況の情報。

newRegionsConfig

object (OneTimeProductPurchaseOptionNewRegionsConfig)

今後 Google Play がリリースする可能性のある新たな地域向けの価格情報。省略した場合、今後 Google Play がリリースする可能性のある新たな地域で購入オプションが自動的に提供されることはありません。

offerTags[]

object (OfferTag)

省略可。この購入オプションに対して指定され、Billing Library を通してアプリに返されるカスタムタグのリスト(最大 20 個)。この購入オプションの特典も、Billing Library でこれらのタグを受け取ります。

taxAndComplianceSettings

object (PurchaseOptionTaxAndComplianceSettings)

省略可。税金および法令遵守に関する詳細。

共用体フィールド purchase_option_type。この購入オプションのタイプ。必ず 1 つ設定する必要があります。purchase_option_type は次のいずれかになります。
buyOption

object (OneTimeProductBuyPurchaseOption)

購入できる購入オプション。

rentOption

object (OneTimeProductRentPurchaseOption)

レンタルできる購入オプション。

購入オプションの現在の状態。

列挙型
STATE_UNSPECIFIED デフォルト値。使用しないでください。
DRAFT ユーザーは、今までも現在も購入オプションを利用できません。
ACTIVE ユーザーは購入オプションを利用できます。
INACTIVE ユーザーは、購入オプションを利用できなくなりました。
INACTIVE_PUBLISHED 購入オプションを購入することはできなくなりましたが、下位互換性のために Play Billing Library を通じてその特典は引き続き公開されます。自動的に移行された購入オプションのみがこの状態になります。

OneTimeProductBuyPurchaseOption

購入できる購入オプション。

JSON 表現
{
  "legacyCompatible": boolean,
  "multiQuantityEnabled": boolean
}
フィールド
legacyCompatible

boolean

省略可。この購入オプションが、1 回限りのアイテムのモデルをサポートしていない以前の PBL フローで利用できるかどうか。

下位互換性ありとマークできる「購入」購入オプションは 1 つまでです。

multiQuantityEnabled

boolean

省略可。この購入オプションで複数個の購入が可能かどうか。複数数量の購入では、購入者が 1 回の購入手続きで複数のアイテムを購入できます。

OneTimeProductRentPurchaseOption

レンタルできる購入オプション。

JSON 表現
{
  "rentalPeriod": string,
  "expirationPeriod": string
}
フィールド
rentalPeriod

string

必須。ユーザーが利用資格を持っている期間。購入フローの完了時から有効。ISO 8601 形式で指定します。

expirationPeriod

string

省略可。ユーザーが利用資格の使用を開始してから、利用資格が取り消されるまでの時間。ISO 8601 形式で指定します。

RegionalPricingAndAvailabilityConfig

購入オプションに対する地域別の価格と提供状況の設定。

JSON 表現
{
  "regionCode": string,
  "price": {
    object (Money)
  },
  "availability": enum (Availability)
}
フィールド
regionCode

string

必須。この設定が適用される地域コード(ISO 3166-2 形式。例: 「US」)。

price

object (Money)

指定の地域での購入オプションの価格。指定の地域に関連付けられた通貨で設定しなければなりません。

availability

enum (Availability)

購入オプションの提供状況。

対象

購入オプションの提供状況。

列挙型
AVAILABILITY_UNSPECIFIED 提供状況未指定。使用しないでください。
AVAILABLE ユーザーは購入オプションを利用できます。
NO_LONGER_AVAILABLE 購入オプションは、ユーザーに提供されなくなりました。この値は、提供状況が以前「AVAILABLE」に設定されていた場合にのみ使用できます。
AVAILABLE_IF_RELEASED 購入オプションは最初は提供されませんが、リリースされた予約購入特典を通じて提供されます。
AVAILABLE_FOR_OFFERS_ONLY 購入オプションは提供されませんが、それにリンクされている特典(Play Points の特典など)は提供されます。

OneTimeProductPurchaseOptionNewRegionsConfig

今後 Google Play がリリースする可能性のある新たな地域向けの価格情報。

JSON 表現
{
  "usdPrice": {
    object (Money)
  },
  "eurPrice": {
    object (Money)
  },
  "availability": enum (Availability)
}
フィールド
usdPrice

object (Money)

必須。Google Play をリリースする可能性のある新たな地域向けの価格(USD)。

eurPrice

object (Money)

必須。Google Play をリリースする可能性のある新たな地域向けの価格(EUR)。

availability

enum (Availability)

必須。新たな地域の設定に利用できる地域。「AVAILABLE」に設定すると、今後 Google Play がリリースする可能性のある新たな地域に価格情報が使用されます。

対象

新しいリージョンの構成の可用性。

列挙型
AVAILABILITY_UNSPECIFIED 提供状況未指定。使用しないでください。
AVAILABLE 設定が、今後 Google Play がリリースする可能性のある新たな地域向けに使用されます。
NO_LONGER_AVAILABLE 設定は利用できなくなり、今後 Google Play がリリースする可能性のある新たな地域向けに使用されることはありません。この値は、提供状況が以前「AVAILABLE」に設定されていた場合にのみ使用できます。

PurchaseOptionTaxAndComplianceSettings

1 回限りのアイテムの購入オプションに関する税金、Google Play ポリシー、法令遵守に関する詳細情報。

JSON 表現
{
  "withdrawalRightType": enum (WithdrawalRightType)
}
フィールド
withdrawalRightType

enum (WithdrawalRightType)

省略可。対象地域内のユーザーに配信されるアイテムがデジタル コンテンツかサービスかの分類。

設定しない場合、デフォルトは WITHDRAWAL_RIGHT_DIGITAL_CONTENT です。

詳しくは、ヘルプセンターの記事をご覧ください。

メソッド

batchDelete

1 回限りのアイテムを 1 つ以上削除します。

batchGet

1 回限りのアイテムを 1 つ以上読み込みます。

batchUpdate

1 回限りのアイテムを 1 つ以上作成または更新します。

delete

1 回限りのアイテムを削除します。

get

1 回限りのアイテムを 1 つ読み込みます。

list

特定のアプリで、1 回限りのアイテムを一覧表示します。

patch

1 回限りのアイテムを作成または更新します。

エラーコード

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

エラーコード 理由 説明 解決策
400 invalidValue リクエストで無効な値が指定されました。多くの場合、これは形式が正しくないか無効な購入トークンに対して返されます。 API リファレンスに基づいて、リクエスト本文またはパラメータの無効なフィールド値を修正します。
400 required リクエストに必須のフィールドまたはパラメータがありません。 API のドキュメントを参照して、すべての必須フィールドとパラメータが含まれていることを確認します。
403 userInsufficientPermission リクエストされたオペレーションを実行する権限がユーザーにありません。 認証済みユーザーが Google Play Console で必要な権限を持っていることを確認します。詳細については、 サービス アカウントの使用をご覧ください。
404 notFound リクエストされたリソースが見つかりませんでした。 ID(購入トークン、パッケージ名、商品 ID、定期購入 ID など)が正しいことを確認します。
409 concurrentUpdate 同時に更新されているオブジェクトを更新しようとしました。 指数バックオフでリクエストを再試行します。同じリソースに対する同時変更を回避します。
5xx Generic error Google Play サーバーの一般的なエラー。 リクエストを再試行してください。

問題が解決しない場合は、Google Play アカウント マネージャーにお問い合わせいただくか、サポート リクエストを送信してください。Google Play ステータス ダッシュボードで既知のサービス停止がないか確認してください。