REST Resource: monetization.onetimeproducts

资源：OneTimeProduct

应用的单个一次性商品。

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)

必需。相应一次性商品的购买选项集。
restrictedPaymentCountries

object (RestrictedPaymentCountries)

可选。在相应国家/地区，必须使用在本国家/地区注册的支付方式来购买相应一次性商品。如果为空，则表示未施加任何支付地点限制。
offerTags[]

object (OfferTag)

可选。为相应一次性商品指定、通过结算库返回到应用的自定义标记的列表（最多 20 个自定义标记）。相应商品的购买选项和优惠也将通过结算库收到这些标记。
regionsVersion

object (RegionsVersion)

仅限输出。用于生成一次性商品的地区配置的版本。

OneTimeProductListing

一次性商品的地区性商品详情。

JSON 表示法 
{
  "languageCode": string,
  "title": string,
  "description": string
}
字段
languageCode

string

必需。相应商品详情的语言（按照 BCP-47 的定义），例如“en-US”。
title

string

必需。相应商品的商品名（采用相应商品详情所用的语言）。长度上限为 55 个字符。
description

string

必需。相应商品的说明（采用相应商品详情所用的语言）。长度上限为 200 个字符。

OneTimeProductTaxAndComplianceSettings

一次性商品在税费、Google Play 政策和法规遵从方面的详细信息。

JSON 表示法 
{
  "regionalTaxConfigs": [
    {
      object (RegionalTaxConfig)
    }
  ],
  "isTokenizedDigitalAsset": boolean
}
字段
regionalTaxConfigs[]

object (RegionalTaxConfig)

地区性税费配置。
isTokenizedDigitalAsset

boolean

相应一次性商品是否已声明为表示代币化数字资产的商品。

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

一次性商品的单个购买选项。

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

必需。不可变。相应购买选项的唯一标识符。在一次性商品中必须具有唯一性。必须以数字或小写字母开头，并且只能包含小写字母 (a-z)、数字 (0-9) 和连字符 (-)。长度上限为 63 个字符。
state

enum (State)

仅限输出。购买选项的状态，即是否有效。无法通过更新资源来更改此字段。请改为使用专用端点。
regionalPricingAndAvailabilityConfigs[]

object (RegionalPricingAndAvailabilityConfig)

相应购买选项的地区性定价和提供情况信息。
newRegionsConfig

object (OneTimeProductPurchaseOptionNewRegionsConfig)

Play 未来可能新增的任何地区所对应的定价信息。如果省略，则不会在 Play 未来可能新增的任何地区自动提供购买选项。
offerTags[]

object (OfferTag)

可选。为相应购买选项指定、通过结算库返回到应用的自定义标记的列表（最多 20 个自定义标记）。相应购买选项的优惠也将通过结算库收到这些标记。
taxAndComplianceSettings

object (PurchaseOptionTaxAndComplianceSettings)

可选。有关税费和法规遵从方面的详细信息。
联合字段 purchase_option_type。相应购买选项的类型。只能设置一个值。purchase_option_type 只能是下列其中一项：
buyOption

object (OneTimeProductBuyPurchaseOption)

可以购买的购买选项。
rentOption

object (OneTimeProductRentPurchaseOption)

可以租借的购买选项。

州

购买选项的当前状态。

枚举
STATE_UNSPECIFIED 默认值，切勿使用。
DRAFT 相应购买选项目前未向用户提供，以前也从未向用户提供过。
ACTIVE 相应购买选项目前已面向用户提供。
INACTIVE 相应购买选项不再面向用户提供。
INACTIVE_PUBLISHED 相应购买选项已不再可供购买，但为了实现向后兼容性，我们会继续通过 Play 结算库公开其优惠。只有自动完成迁移的购买选项才能处于此状态。

OneTimeProductBuyPurchaseOption

可以购买的购买选项。

JSON 表示法 
{
  "legacyCompatible": boolean,
  "multiQuantityEnabled": boolean
}
字段
legacyCompatible

boolean

可选。用于表示在不支持一次性商品的旧版 Play 结算库流程中，是否提供相应购买选项。

最多只能将一个“购买”购买选项标记为“向后兼容”。
multiQuantityEnabled

boolean

可选。相应购买选项是否允许多数量。多件购买功能可让买家在单次结账中购买多件商品。

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 相应购买选项最初未提供，但通过已发布的预订优惠提供。

OneTimeProductPurchaseOptionNewRegionsConfig

Play 未来可能新增的任何地区所对应的定价信息。

JSON 表示法 
{
  "usdPrice": {
    object (Money)
  },
  "eurPrice": {
    object (Money)
  },
  "availability": enum (Availability)
}
字段
usdPrice

object (Money)

必需。要在 Play 可能新增的任何地区使用的价格（以美元为单位）。
eurPrice

object (Money)

必需。要在 Play 可能新增的任何地区使用的价格（以欧元为单位）。
availability

enum (Availability)

必需。新地区配置的地区提供情况。当设置为 AVAILABLE 时，定价信息将用于 Play 未来可能新增的任何地区。

可用性

新地区提供情况的配置。

枚举
AVAILABILITY_UNSPECIFIED 未指定提供情况。不得使用。
AVAILABLE 相应配置将用于 Play 未来可能新增的任何地区。
NO_LONGER_AVAILABLE 相应配置不再可用，且不会用于 Play 未来可能新增的任何地区。只有在之前曾将提供情况设置为 AVAILABLE 的情况下才能使用此值。

PurchaseOptionTaxAndComplianceSettings

一次性商品购买选项在税费、Google Play 政策和法规遵从方面的详细信息。

JSON 表示法 
{
  "withdrawalRightType": enum (WithdrawalRightType)
}
字段
withdrawalRightType

enum (WithdrawalRightType)

可选。面向符合条件地区的用户分发的商品的数字内容或服务类别。

如果未设置，则默认为 WITHDRAWAL_RIGHT_DIGITAL_CONTENT。

如需了解详情，请参阅帮助中心文章。

方法

batchDelete

 删除一个或多个一次性商品。

batchGet

 读取一个或多个一次性商品。

batchUpdate

 创建或更新一个或多个一次性商品。

delete

 删除一次性商品。

get

 读取单个一次性商品。

list

 列出指定应用下的全部一次性商品。

patch

 创建或更新一次性商品。