REST Resource: monetization.onetimeproducts

Recurso: OneTimeProduct

Um único produto único para um app.

Representação JSON
{
  "packageName": string,
  "productId": string,
  "listings": [
    {
      object (OneTimeProductListing)
    }
  ],
  "taxAndComplianceSettings": {
    object (OneTimeProductTaxAndComplianceSettings)
  },
  "purchaseOptions": [
    {
      object (OneTimeProductPurchaseOption)
    }
  ],
  "restrictedPaymentCountries": {
    object (RestrictedPaymentCountries)
  },
  "offerTags": [
    {
      object (OfferTag)
    }
  ],
  "regionsVersion": {
    object (RegionsVersion)
  }
}
Campos
packageName

string

Obrigatório. Imutável. Nome do pacote do app principal.

productId

string

Obrigatório. Imutável. ID exclusivo do produto. Exclusivo dentro do app principal. Os IDs dos produtos precisam começar com um número ou letra minúscula e podem conter números (0-9), letras minúsculas (a-z), sublinhado (_) e pontos (.).

listings[]

object (OneTimeProductListing)

Obrigatório. Conjunto com o título localizado e dados de descrição. Entradas duplicadas com o mesmo "languageCode" são proibidas.

taxAndComplianceSettings

object (OneTimeProductTaxAndComplianceSettings)

Detalhes sobre tributos e conformidade jurídica.

purchaseOptions[]

object (OneTimeProductPurchaseOption)

Obrigatório. O conjunto de opções de compra para este produto único.

restrictedPaymentCountries

object (RestrictedPaymentCountries)

Opcional. Países onde a compra deste produto único está restrita a formas de pagamento registradas na mesma região. Se estiver vazio, nenhuma restrição de local de pagamento será imposta.

offerTags[]

object (OfferTag)

Opcional. Lista de até 20 tags personalizadas especificadas para este produto único, retornadas ao app pela Biblioteca Faturamento. As opções de compra e ofertas para esse produto também recebem essas tags na Biblioteca Faturamento.

regionsVersion

object (RegionsVersion)

Apenas saída. A versão da configuração de regiões usada para gerar o produto único.

OneTimeProductListing

Página Detalhes do app regional para um produto único.

Representação JSON
{
  "languageCode": string,
  "title": string,
  "description": string
}
Campos
languageCode

string

Obrigatório. O idioma da página, conforme definido pelo BCP-47. Por exemplo, "en-US".

title

string

Obrigatório. O título do produto no idioma da página de detalhes. O tamanho máximo é de 55 caracteres.

description

string

Obrigatório. A descrição do produto no idioma da página de detalhes. O tamanho máximo é de 200 caracteres.

OneTimeProductTaxAndComplianceSettings

Detalhes sobre tributos, políticas do Google Play e conformidade jurídica para produtos únicos.

Representação JSON
{
  "regionalTaxConfigs": [
    {
      object (RegionalTaxConfig)
    }
  ],
  "isTokenizedDigitalAsset": boolean
}
Campos
regionalTaxConfigs[]

object (RegionalTaxConfig)

Configuração de tributos regionais.

isTokenizedDigitalAsset

boolean

Se este produto único é declarado como um produto que representa um ativo digital tokenizado.

RegionalTaxConfig

Detalhes sobre tributos em determinada região geográfica.

Representação JSON
{
  "regionCode": string,
  "taxTier": enum (TaxTier),
  "eligibleForStreamingServiceTaxRate": boolean,
  "streamingTaxType": enum (StreamingTaxType)
}
Campos
regionCode

string

Obrigatório. Código regional a que essa configuração se aplica, conforme definido pelo ISO 3166-2. Por exemplo, "US".

taxTier

enum (TaxTier)

Alíquota tributária para especificar uma taxa de tributos reduzida. Desenvolvedores que vendem notícias, revistas, livros e jornais digitais ou audiolivros em várias regiões podem se qualificar para taxas reduzidas de tributos.

Saiba mais.

eligibleForStreamingServiceTaxRate

boolean

Você precisa nos informar se o app contém produtos de streaming para cobrar corretamente as tributações estaduais e locais sobre vendas nos EUA. Campo válido apenas nos Estados Unidos.

streamingTaxType

enum (StreamingTaxType)

Para coletar esses tributos nos EUA, escolha a categoria fiscal adequada.

Saiba mais.

OneTimeProductPurchaseOption

Uma única opção de compra para um produto único.

Representação 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.
}
Campos
purchaseOptionId

string

Obrigatório. Imutável. O identificador exclusivo desta opção de compra. Precisa ser exclusivo no produto único. Ele precisa começar com um número ou letra minúscula e só pode conter letras minúsculas (a-z), números (0-9) e hifens (-). O tamanho máximo é de 63 caracteres.

state

enum (State)

Apenas saída. O estado da opção de compra, ou seja, se ela está ativa. Este campo não pode ser mudado atualizando o recurso. Em vez disso, use os endpoints dedicados.

regionalPricingAndAvailabilityConfigs[]

object (RegionalPricingAndAvailabilityConfig)

Informações sobre preço regional e disponibilidade para esta opção de compra.

newRegionsConfig

object (OneTimeProductPurchaseOptionNewRegionsConfig)

Informações de preço para qualquer novo local onde o Google Play possa lançar a oferta no futuro. Se este campo for omitido, a opção de compra não vai estar disponível automaticamente nesses novos locais.

offerTags[]

object (OfferTag)

Opcional. Lista de até 20 tags personalizadas especificadas para esta opção de compra, retornadas ao app pela Biblioteca Faturamento. As ofertas para essa opção de compra também recebem essas tags na Biblioteca Faturamento.

taxAndComplianceSettings

object (PurchaseOptionTaxAndComplianceSettings)

Opcional. Detalhes sobre tributos e conformidade jurídica.

Campo de união purchase_option_type. O tipo desta opção de compra. É necessário definir exatamente um. purchase_option_type pode ser apenas de um dos tipos a seguir:
buyOption

object (OneTimeProductBuyPurchaseOption)

Uma opção de compra que pode ser comprada.

rentOption

object (OneTimeProductRentPurchaseOption)

Uma opção de compra que pode ser alugada.

Estado

O estado atual da opção de compra.

Enums
STATE_UNSPECIFIED Valor padrão. Nunca deve ser usado.
DRAFT A opção de compra não está e nunca esteve disponível aos usuários.
ACTIVE A opção de compra está disponível aos usuários.
INACTIVE A opção de compra não está mais disponível aos usuários.
INACTIVE_PUBLISHED A opção de compra não está mais disponível, mas continuaremos exibindo sua oferta pela Biblioteca Play Faturamento em razão da compatibilidade com versões anteriores. Apenas opções de compra com migração automática podem ter este estado.

OneTimeProductBuyPurchaseOption

Uma opção de compra que pode ser comprada.

Representação JSON
{
  "legacyCompatible": boolean,
  "multiQuantityEnabled": boolean
}
Campos
legacyCompatible

boolean

Opcional. Se esta opção de compra vai estar disponível em fluxos legados da Biblioteca Play Faturamento que não são compatíveis com o modelo de produtos únicos.

Apenas uma opção de compra "comprar" pode ser marcada como compatível com versões anteriores.

multiQuantityEnabled

boolean

Opcional. Se essa opção de compra permite várias quantidades. Com a compra de quantidade múltipla, o comprador pode adquirir mais de um item em um único pagamento.

OneTimeProductRentPurchaseOption

Uma opção de compra que pode ser alugada.

Representação JSON
{
  "rentalPeriod": string,
  "expirationPeriod": string
}
Campos
rentalPeriod

string

Obrigatório. O período em que um usuário tem direito a um benefício. Começa quando o fluxo de compra é concluído. Especificado no formato ISO 8601.

expirationPeriod

string

Opcional. É o tempo que o usuário tem depois de começar a consumir o direito antes que ele seja revogado. Especificado no formato ISO 8601.

RegionalPricingAndAvailabilityConfig

Configuração de preço regional e disponibilidade para uma opção de compra.

Representação JSON
{
  "regionCode": string,
  "price": {
    object (Money)
  },
  "availability": enum (Availability)
}
Campos
regionCode

string

Obrigatório. Código regional a que essa configuração se aplica, conforme definido pelo ISO 3166-2. Por exemplo, "US".

price

object (Money)

O preço da opção de compra na região especificada. Precisa estar definido na moeda vinculada a essa região.

availability

enum (Availability)

A disponibilidade da opção de compra.

Disponibilidade

A disponibilidade da opção de compra.

Enums
AVAILABILITY_UNSPECIFIED Disponibilidade não especificada. Não pode ser usado.
AVAILABLE A opção de compra está disponível aos usuários.
NO_LONGER_AVAILABLE A opção de compra não está mais disponível aos usuários. Esse valor só pode ser usado se a disponibilidade tiver sido definida como "AVAILABLE" anteriormente.
AVAILABLE_IF_RELEASED A opção de compra está inicialmente indisponível, mas é disponibilizada por uma oferta de compra na pré-venda lançada.

OneTimeProductPurchaseOptionNewRegionsConfig

Informações de preço para qualquer nova região onde o Google Play possa lançar a oferta no futuro.

Representação JSON
{
  "usdPrice": {
    object (Money)
  },
  "eurPrice": {
    object (Money)
  },
  "availability": enum (Availability)
}
Campos
usdPrice

object (Money)

Obrigatório. Preço em USD a ser usado em qualquer região onde o Google Play possa lançar a oferta.

eurPrice

object (Money)

Obrigatório. Preço em EUR a ser usado em qualquer região onde o Google Play possa lançar a oferta.

availability

enum (Availability)

Obrigatório. A disponibilidade regional para a configuração de novas regiões. Se definido como AVAILABLE, as informações de preço serão usadas para qualquer nova região onde o Google Play possa lançar a oferta no futuro.

Disponibilidade

A disponibilidade da configuração de novas regiões.

Enums
AVAILABILITY_UNSPECIFIED Disponibilidade não especificada. Não pode ser usado.
AVAILABLE A configuração será usada para qualquer nova região onde o Google Play possa lançar a oferta no futuro.
NO_LONGER_AVAILABLE A configuração não está mais disponível e não será usada para novas regiões onde o Google Play possa lançar a oferta no futuro. Esse valor só pode ser usado se a disponibilidade tiver sido definida como "AVAILABLE" anteriormente.

PurchaseOptionTaxAndComplianceSettings

Detalhes sobre tributos, políticas do Google Play e conformidade jurídica para opções de compra de produtos únicos.

Representação JSON
{
  "withdrawalRightType": enum (WithdrawalRightType)
}
Campos
withdrawalRightType

enum (WithdrawalRightType)

Opcional. Classificação de conteúdo ou serviço digital para produtos distribuídos a usuários em regiões qualificadas.

Se não for definido, o padrão será WITHDRAWAL_RIGHT_DIGITAL_CONTENT.

Consulte o artigo da Central de Ajuda para mais informações.

Métodos

batchDelete

Exclui um ou mais produtos únicos.

batchGet

Lê um ou mais produtos únicos.

batchUpdate

Cria ou atualiza um ou mais produtos únicos.

delete

Exclui um produto único.

get

Lê um único produto único.

list

Lista todos os produtos únicos em um determinado app.

patch

Cria ou atualiza um produto único.