REST Resource: purchases.subscriptionsv2

Risorsa: SubscriptionPurchaseV2

Indica lo stato dell'acquisto dell'abbonamento di un utente.

Rappresentazione JSON
{
  "kind": string,
  "regionCode": string,
  "lineItems": [
    {
      object (SubscriptionPurchaseLineItem)
    }
  ],
  "startTime": string,
  "subscriptionState": enum (SubscriptionState),
  "latestOrderId": string,
  "linkedPurchaseToken": string,
  "pausedStateContext": {
    object (PausedStateContext)
  },
  "canceledStateContext": {
    object (CanceledStateContext)
  },
  "testPurchase": {
    object (TestPurchase)
  },
  "acknowledgementState": enum (AcknowledgementState),
  "externalAccountIdentifiers": {
    object (ExternalAccountIdentifiers)
  },
  "subscribeWithGoogleInfo": {
    object (SubscribeWithGoogleInfo)
  }
}
Campi
kind

string

Questo tipo rappresenta un oggetto SubscriptionPurchaseV2 nel servizio androidpublisher.

regionCode

string

Codice paese/regione di fatturazione ISO 3166-1 alpha-2 dell'utente al momento della concessione dell'abbonamento.

lineItems[]

object (SubscriptionPurchaseLineItem)

Informazioni a livello di articolo per un acquisto di abbonamento. Gli articoli nello stesso acquisto devono essere tutti con AutoRenewingPlan o tutti con PrepaidPlan.

startTime

string (Timestamp format)

Ora in cui è stato concesso l'abbonamento. Non impostato per gli abbonamenti in attesa (l'abbonamento è stato creato, ma è in attesa di pagamento durante la registrazione).

Un timestamp in formato "Zulu" UTC RFC3339, con risoluzione a livello di nanosecondo e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

subscriptionState

enum (SubscriptionState)

Lo stato attuale dell'abbonamento.

latestOrderId

string

L'ID dell'ultimo ordine associato all'acquisto dell'abbonamento. Per l'abbonamento con rinnovo automatico, si tratta dell'ID ordine dell'ordine di registrazione se non è ancora stato rinnovato o dell'ultimo ID ordine ricorrente (ordine riuscito, in attesa o rifiutato). Per l'abbonamento prepagato, si tratta dell'ID ordine associato al token di acquisto sottoposto a query.

linkedPurchaseToken

string

Il token di acquisto dell'abbonamento precedente se si tratta di uno dei seguenti: * Registrazione di un abbonamento annullato, ma non scaduto * Upgrade/downgrade da un abbonamento precedente. * Passare da un abbonamento prepagato a un abbonamento con rinnovo automatico. * Passare da un abbonamento con rinnovo automatico a un abbonamento prepagato. * Ricaricare un abbonamento prepagato.

pausedStateContext

object (PausedStateContext)

Contesto aggiuntivo sugli abbonamenti in pausa. Presente solo se l'abbonamento ha attualmente subscriptionState SUBSCRIPTION_STATE_PAUSED.

canceledStateContext

object (CanceledStateContext)

Contesto aggiuntivo sugli abbonamenti annullati. Presente solo se l'abbonamento ha attualmente lo stato subscriptionState SUBSCRIPTION_STATE_CANCELED o SUBSCRIPTION_STATE_EXPIRED.

testPurchase

object (TestPurchase)

Presente solo se l'acquisto dell'abbonamento è un acquisto di prova.

acknowledgementState

enum (AcknowledgementState)

Lo stato di conferma dell'abbonamento.

externalAccountIdentifiers

object (ExternalAccountIdentifiers)

Identificatore dell'account utente nel servizio di terze parti.

subscribeWithGoogleInfo

object (SubscribeWithGoogleInfo)

Profilo utente associato agli acquisti effettuati con "Abbonati con Google".

SubscriptionState

I potenziali stati di un abbonamento, ad esempio se è attivo o annullato. Gli articoli inclusi in un acquisto di abbonamento possono essere tutti piani con rinnovo automatico o tutti piani prepagati.

Enum
SUBSCRIPTION_STATE_UNSPECIFIED Stato dell'abbonamento non specificato.
SUBSCRIPTION_STATE_PENDING L'abbonamento è stato creato, ma è in attesa di pagamento durante la registrazione. In questo stato, tutti gli articoli sono in attesa di pagamento.
SUBSCRIPTION_STATE_ACTIVE L'abbonamento è attivo. - (1) Se l'abbonamento è un piano con rinnovo automatico, almeno un elemento è autoRenewEnabled e non è scaduto. - (2) Se l'abbonamento è un piano prepagato, almeno un articolo non è scaduto.
SUBSCRIPTION_STATE_PAUSED L'abbonamento è in pausa. Lo stato è disponibile solo se l'abbonamento è un piano con rinnovo automatico. In questo stato, tutti gli elementi sono in stato di pausa.
SUBSCRIPTION_STATE_IN_GRACE_PERIOD L'abbonamento è in un periodo di tolleranza. Lo stato è disponibile solo se l'abbonamento è un piano con rinnovo automatico. In questo stato, tutti gli articoli sono in periodo di tolleranza.
SUBSCRIPTION_STATE_ON_HOLD L'abbonamento è in attesa (sospeso). Lo stato è disponibile solo se l'abbonamento è un piano con rinnovo automatico. In questo stato, tutti gli elementi sono in attesa.
SUBSCRIPTION_STATE_CANCELED L'abbonamento è stato annullato, ma non è ancora scaduto. Lo stato è disponibile solo se l'abbonamento è un piano con rinnovo automatico. Per tutti gli elementi, l'attributo autoRenewEnabled è impostato su false.
SUBSCRIPTION_STATE_EXPIRED L'abbonamento è scaduto. Tutti gli elementi hanno un valore expiryTime passato.
SUBSCRIPTION_STATE_PENDING_PURCHASE_CANCELED La transazione in attesa per l'abbonamento è stata annullata. Se l'acquisto in attesa riguarda un abbonamento esistente, utilizza linkedPurchaseToken per ottenere lo stato corrente dell'abbonamento.

PausedStateContext

Informazioni specifiche su un abbonamento in stato In pausa.

Rappresentazione JSON
{
  "autoResumeTime": string
}
Campi
autoResumeTime

string (Timestamp format)

Data e ora in cui l'abbonamento verrà ripreso automaticamente.

Un timestamp in formato "Zulu" UTC RFC3339, con risoluzione a livello di nanosecondo e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

CanceledStateContext

Informazioni specifiche su un abbonamento nello stato SUBSCRIPTION_STATE_CANCELED o SUBSCRIPTION_STATE_EXPIRED.

Rappresentazione JSON
{

  // Union field cancellation_reason can be only one of the following:
  "userInitiatedCancellation": {
    object (UserInitiatedCancellation)
  },
  "systemInitiatedCancellation": {
    object (SystemInitiatedCancellation)
  },
  "developerInitiatedCancellation": {
    object (DeveloperInitiatedCancellation)
  },
  "replacementCancellation": {
    object (ReplacementCancellation)
  }
  // End of list of possible types for union field cancellation_reason.
}
Campi
Campo unione cancellation_reason. Il motivo per cui un abbonamento è stato annullato. cancellation_reason può essere solo uno dei seguenti:
userInitiatedCancellation

object (UserInitiatedCancellation)

L'abbonamento è stato annullato dall'utente.

systemInitiatedCancellation

object (SystemInitiatedCancellation)

L'abbonamento è stato annullato dal sistema, ad esempio a causa di un problema di fatturazione.

developerInitiatedCancellation

object (DeveloperInitiatedCancellation)

L'abbonamento è stato annullato dallo sviluppatore.

replacementCancellation

object (ReplacementCancellation)

L'abbonamento è stato sostituito da un nuovo abbonamento.

UserInitiatedCancellation

Informazioni specifiche sugli annullamenti avviati dagli utenti.

Rappresentazione JSON
{
  "cancelSurveyResult": {
    object (CancelSurveyResult)
  },
  "cancelTime": string
}
Campi
cancelSurveyResult

object (CancelSurveyResult)

Informazioni fornite dall'utente quando completa il flusso di annullamento dell'abbonamento (sondaggio sul motivo dell'annullamento).

cancelTime

string (Timestamp format)

La data e l'ora in cui l'abbonamento è stato annullato dall'utente. L'utente potrebbe comunque avere accesso all'abbonamento dopo questa data. Utilizza lineItems.expiry_time per determinare se un utente ha ancora accesso.

Un timestamp in formato "Zulu" UTC RFC3339, con risoluzione a livello di nanosecondo e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

CancelSurveyResult

Risultato del sondaggio sull'annullamento quando l'abbonamento è stato annullato dall'utente.

Rappresentazione JSON
{
  "reason": enum (CancelSurveyReason),
  "reasonUserInput": string
}
Campi
reason

enum (CancelSurveyReason)

Il motivo selezionato dall'utente nel sondaggio sull'annullamento.

reasonUserInput

string

Impostato solo per CANCEL_SURVEY_REASON_OTHERS. Si tratta della risposta libera dell'utente al sondaggio.

CancelSurveyReason

Il motivo selezionato dall'utente nel sondaggio sull'annullamento.

Enum
CANCEL_SURVEY_REASON_UNSPECIFIED Motivo dell'annullamento del sondaggio non specificato.
CANCEL_SURVEY_REASON_NOT_ENOUGH_USAGE Utilizzo insufficiente dell'abbonamento.
CANCEL_SURVEY_REASON_TECHNICAL_ISSUES Problemi tecnici durante l'utilizzo dell'app.
CANCEL_SURVEY_REASON_FOUND_BETTER_APP L'utente ha trovato un'app migliore.
CANCEL_SURVEY_REASON_OTHERS Altri motivi.

SystemInitiatedCancellation

Questo tipo non contiene campi.

Informazioni specifiche sugli annullamenti avviati dal sistema di Google.

DeveloperInitiatedCancellation

Questo tipo non contiene campi.

Informazioni specifiche sugli annullamenti avviati dagli sviluppatori.

ReplacementCancellation

Questo tipo non contiene campi.

Informazioni specifiche sugli annullamenti causati dalla sostituzione dell'abbonamento.

TestPurchase

Questo tipo non contiene campi.

Indica se l'acquisto dell'abbonamento è un acquisto di prova.

AcknowledgementState

I possibili stati di conferma per un abbonamento.

Enum
ACKNOWLEDGEMENT_STATE_UNSPECIFIED Stato di conferma non specificato.
ACKNOWLEDGEMENT_STATE_PENDING L'abbonamento non è stato ancora confermato.
ACKNOWLEDGEMENT_STATE_ACKNOWLEDGED L'abbonamento è stato confermato.

ExternalAccountIdentifiers

Identificatore dell'account utente nel servizio di terze parti.

Rappresentazione JSON
{
  "externalAccountId": string,
  "obfuscatedExternalAccountId": string,
  "obfuscatedExternalProfileId": string
}
Campi
externalAccountId

string

Identificatore dell'account utente nel servizio di terze parti. Presente solo se il collegamento dell'account è avvenuto nell'ambito del flusso di acquisto dell'abbonamento.

obfuscatedExternalAccountId

string

Una versione offuscata dell'ID associata in modo univoco all'account dell'utente nella tua app. Presente per i seguenti acquisti: * Se il collegamento dell'account è avvenuto nell'ambito del flusso di acquisto dell'abbonamento. * È stato specificato utilizzando https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedaccountid al momento dell'acquisto.

obfuscatedExternalProfileId

string

Una versione offuscata dell'ID associata in modo univoco al profilo dell'utente nella tua app. È presente solo se specificato utilizzando https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedprofileid al momento dell'acquisto.

SubscribeWithGoogleInfo

Informazioni associate agli acquisti effettuati con "Abbonati con Google".

Rappresentazione JSON
{
  "profileId": string,
  "profileName": string,
  "emailAddress": string,
  "givenName": string,
  "familyName": string
}
Campi
profileId

string

L'ID profilo Google dell'utente al momento dell'acquisto dell'abbonamento.

profileName

string

Il nome del profilo dell'utente al momento dell'acquisto dell'abbonamento.

emailAddress

string

L'indirizzo email dell'utente al momento dell'acquisto dell'abbonamento.

givenName

string

Il nome dell'utente al momento dell'acquisto dell'abbonamento.

familyName

string

Il cognome dell'utente al momento dell'acquisto dell'abbonamento.

SubscriptionPurchaseLineItem

Informazioni a livello di articolo per un acquisto di abbonamento.

Rappresentazione JSON
{
  "productId": string,
  "expiryTime": string,

  // Union field plan_type can be only one of the following:
  "autoRenewingPlan": {
    object (AutoRenewingPlan)
  },
  "prepaidPlan": {
    object (PrepaidPlan)
  }
  // End of list of possible types for union field plan_type.
  "offerDetails": {
    object (OfferDetails)
  },

  // Union field deferred_item_change can be only one of the following:
  "deferredItemReplacement": {
    object (DeferredItemReplacement)
  }
  // End of list of possible types for union field deferred_item_change.
  "signupPromotion": {
    object (SignupPromotion)
  }
}
Campi
productId

string

L'ID prodotto acquistato (ad es. "monthly001").

expiryTime

string (Timestamp format)

Data e ora in cui l'abbonamento è scaduto o scadrà, a meno che l'accesso non venga esteso (ad es. rinnovato).

Un timestamp in formato "Zulu" UTC RFC3339, con risoluzione a livello di nanosecondo e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

Campo unione plan_type. Il tipo di piano di abbonamento. plan_type può essere solo uno dei seguenti:
autoRenewingPlan

object (AutoRenewingPlan)

L'articolo si rinnova automaticamente.

prepaidPlan

object (PrepaidPlan)

L'articolo è prepagato.

offerDetails

object (OfferDetails)

I dettagli dell'offerta per questo articolo.

Campo unione deferred_item_change. Il campo è presente quando un elemento ha una modifica differita. Può essere rimosso o sostituito. deferred_item_change può essere solo uno dei seguenti:
deferredItemReplacement

object (DeferredItemReplacement)

Informazioni per la sostituzione di articoli differita.

signupPromotion

object (SignupPromotion)

Dettagli della promozione relativi a questo articolo. Impostato solo se è stata applicata una promozione durante la registrazione.

AutoRenewingPlan

Informazioni relative a un piano con rinnovo automatico.

Rappresentazione JSON
{
  "autoRenewEnabled": boolean,
  "recurringPrice": {
    object (Money)
  },
  "priceChangeDetails": {
    object (SubscriptionItemPriceChangeDetails)
  },
  "installmentDetails": {
    object (InstallmentPlan)
  }
}
Campi
autoRenewEnabled

boolean

Se l'abbonamento è attualmente impostato sul rinnovo automatico, ad esempio se l'utente non lo ha annullato

recurringPrice

object (Money)

Il prezzo ricorrente corrente del piano con rinnovo automatico.

priceChangeDetails

object (SubscriptionItemPriceChangeDetails)

Le informazioni sull'ultima variazione di prezzo dell'articolo dall'iscrizione all'abbonamento.

installmentDetails

object (InstallmentPlan)

L'impegno relativo al piano di rateizzazione e le informazioni relative allo stato del piano con rinnovo automatico.

SubscriptionItemPriceChangeDetails

Informazioni relative alla variazione di prezzo di un articolo dell'abbonamento.

Rappresentazione JSON
{
  "newPrice": {
    object (Money)
  },
  "priceChangeMode": enum (PriceChangeMode),
  "priceChangeState": enum (PriceChangeState),
  "expectedNewPriceChargeTime": string
}
Campi
newPrice

object (Money)

Nuovo prezzo ricorrente per l'articolo dell'abbonamento.

priceChangeMode

enum (PriceChangeMode)

La modalità di variazione del prezzo specifica in che modo cambia il prezzo dell'articolo dell'abbonamento.

priceChangeState

enum (PriceChangeState)

Indica lo stato attuale della variazione di prezzo.

expectedNewPriceChargeTime

string (Timestamp format)

La data di rinnovo in cui la variazione di prezzo entrerà in vigore per l'utente. Questo può cambiare(in un momento futuro) a causa di casi in cui la data di rinnovo cambia, ad esempio in caso di pausa. Questo campo viene compilato solo se la modifica del prezzo non è stata applicata.

Un timestamp in formato "Zulu" UTC RFC3339, con risoluzione a livello di nanosecondo e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

PriceChangeMode

La modalità di variazione del prezzo.

Enum
PRICE_CHANGE_MODE_UNSPECIFIED Modalità di variazione del prezzo non specificata. Questo valore non deve mai essere impostato.
PRICE_DECREASE Se il prezzo dell'abbonamento sta diminuendo.
PRICE_INCREASE Se il prezzo dell'abbonamento aumenta e l'utente deve accettarlo.
OPT_OUT_PRICE_INCREASE Se il prezzo dell'abbonamento aumenta con la modalità di disattivazione.

PriceChangeState

Lo stato della variazione di prezzo.

Enum
PRICE_CHANGE_STATE_UNSPECIFIED Stato della variazione di prezzo non specificato. Questo valore non deve essere utilizzato.
OUTSTANDING In attesa che l'utente accetti la variazione di prezzo.
CONFIRMED La variazione di prezzo è confermata per l'utente.
APPLIED La variazione di prezzo è stata applicata, ovvero all'utente è stato iniziato ad addebitare il nuovo prezzo.

InstallmentPlan

Informazioni su un piano di rateizzazione.

Rappresentazione JSON
{
  "initialCommittedPaymentsCount": integer,
  "subsequentCommittedPaymentsCount": integer,
  "remainingCommittedPaymentsCount": integer,
  "pendingCancellation": {
    object (PendingCancellation)
  }
}
Campi
initialCommittedPaymentsCount

integer

Numero totale di pagamenti per i quali l'utente si è inizialmente impegnato.

subsequentCommittedPaymentsCount

integer

Numero totale di pagamenti per i quali l'utente si impegna dopo ogni periodo di impegno. Se il campo è vuoto, al termine del periodo di impegno iniziale il piano di rateizzazione tornerà a un normale abbonamento con rinnovo automatico.

remainingCommittedPaymentsCount

integer

Numero totale di pagamenti impegnati rimanenti da pagare in questo ciclo di rinnovo.

pendingCancellation

object (PendingCancellation)

Se presente, questo piano di rateizzazione è in attesa di annullamento. L'annullamento verrà eseguito solo dopo che l'utente avrà completato tutti i pagamenti previsti.

PendingCancellation

Questo tipo non contiene campi.

Questo è un indicatore che indica se è presente un annullamento in attesa per il piano di rate virtuali. L'annullamento verrà eseguito solo dopo che l'utente avrà completato tutti i pagamenti previsti.

PrepaidPlan

Informazioni relative a un piano prepagato.

Rappresentazione JSON
{
  "allowExtendAfterTime": string
}
Campi
allowExtendAfterTime

string (Timestamp format)

Se presente, si tratta del momento dopo il quale sono consentiti gli acquisti di ricariche per il piano prepagato. Non sarà presente per i piani prepagati scaduti.

Un timestamp in formato "Zulu" UTC RFC3339, con risoluzione a livello di nanosecondo e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

OfferDetails

Informazioni dettagliate sull'offerta relative a un elemento pubblicitario di acquisto.

Rappresentazione JSON
{
  "offerTags": [
    string
  ],
  "basePlanId": string,
  "offerId": string
}
Campi
offerTags[]

string

I tag di offerta più recenti associati all'offerta. Sono inclusi i tag ereditati dal piano base.

basePlanId

string

L'ID piano base. Presente per tutti i piani base e le offerte.

offerId

string

L'ID offerta. Presente solo per le offerte scontate.

DeferredItemReplacement

Informazioni relative alla sostituzione di articoli differita.

Rappresentazione JSON
{
  "productId": string
}
Campi
productId

string

Il nuovo productId sostituirà quello esistente.

SignupPromotion

La promozione applicata a questo articolo al momento dell'acquisto.

Rappresentazione JSON
{

  // Union field promotion_type can be only one of the following:
  "oneTimeCode": {
    object (OneTimeCode)
  },
  "vanityCode": {
    object (VanityCode)
  }
  // End of list of possible types for union field promotion_type.
}
Campi
Campo unione promotion_type. Il tipo di promozione applicata all'articolo. promotion_type può essere solo uno dei seguenti:
oneTimeCode

object (OneTimeCode)

È stato applicato un codice una tantum.

vanityCode

object (VanityCode)

È stato applicato un codice vanity.

OneTimeCode

Questo tipo non contiene campi.

Un codice promozionale monouso.

VanityCode

Un codice promozionale predefinito utilizzabile più volte.

Rappresentazione JSON
{
  "promotionCode": string
}
Campi
promotionCode

string

Il codice promozionale.

Metodi

get

Recuperare i metadati di una sottoscrizione

revoke

Revoca l'acquisto di un abbonamento per l'utente.