REST Resource: monetization.subscriptions

Ressource : Subscription

Un seul abonnement pour une application.

Représentation JSON 
{
  "packageName": string,
  "productId": string,
  "basePlans": [
    {
      object (BasePlan)
    }
  ],
  "listings": [
    {
      object (SubscriptionListing)
    }
  ],
  "archived": boolean,
  "taxAndComplianceSettings": {
    object (SubscriptionTaxAndComplianceSettings)
  },
  "restrictedPaymentCountries": {
    object (RestrictedPaymentCountries)
  }
}
Champs
packageName

string

Immuable. Nom du package de l'application parente.
productId

string

Immuable. ID produit unique du produit. Unique dans l'application parente. Les identifiants produit doivent être composés de lettres minuscules (a-z), de chiffres (0-9), de traits de soulignement (_) et de points (.). Ils doivent commencer par une lettre minuscule ou un chiffre, et comporter entre 1 et 40 caractères (inclus).
basePlans[]

object (BasePlan)

Ensemble des forfaits de base de cet abonnement. Indique les prix et la durée de l'abonnement si aucune autre offre ne s'applique.
listings[]

object (SubscriptionListing)

Obligatoire. Liste des fiches localisées pour cet abonnement. Doit contenir au moins une entrée pour la langue par défaut de l'application parente.
archived
(deprecated)

boolean

Uniquement en sortie. Obsolète: l'archivage des abonnements n'est pas possible.
taxAndComplianceSettings

object (SubscriptionTaxAndComplianceSettings)

Informations sur les taxes et la conformité aux lois.
restrictedPaymentCountries

object (RestrictedPaymentCountries)

Facultatif. Pays où l'achat de cet abonnement est limité aux modes de paiement enregistrés dans le pays concerné. Si ce champ est vide, aucune restriction liée aux lieux de paiement n'est imposée.

BasePlan

Un seul forfait de base pour un abonnement.

Représentation JSON 
{
  "basePlanId": string,
  "state": enum (State),
  "regionalConfigs": [
    {
      object (RegionalBasePlanConfig)
    }
  ],
  "offerTags": [
    {
      object (OfferTag)
    }
  ],
  "otherRegionsConfig": {
    object (OtherRegionsBasePlanConfig)
  },

  // Union field base_plan_type can be only one of the following:
  "autoRenewingBasePlanType": {
    object (AutoRenewingBasePlanType)
  },
  "prepaidBasePlanType": {
    object (PrepaidBasePlanType)
  },
  "installmentsBasePlanType": {
    object (InstallmentsBasePlanType)
  }
  // End of list of possible types for union field base_plan_type.
}
Champs
basePlanId

string

Obligatoire. Immuable. Identifiant unique de ce forfait de base. Doit être unique dans l'abonnement et conforme à la RFC 1034. Autrement dit, cet identifiant ne peut contenir que des lettres minuscules (a-z), des chiffres (0-9) et des tirets (-), et ne doit pas dépasser 63 caractères.
state

enum (State)

Uniquement en sortie. État du forfait de base, c'est-à-dire s'il est actif. Les forfaits de base en brouillon et inactifs peuvent être activés ou supprimés. Vous pouvez désactiver des forfaits de base actifs. Vous pouvez annuler les forfaits de base inactifs. Ce champ ne peut pas être modifié en mettant à jour la ressource. Utilisez plutôt les points de terminaison dédiés.
regionalConfigs[]

object (RegionalBasePlanConfig)

Informations spécifiques à la région pour ce forfait de base.
offerTags[]

object (OfferTag)

Liste de 20 balises personnalisées maximum spécifiées pour ce forfait de base et renvoyées à l'application via la bibliothèque de facturation. Les offres d'abonnement pour ce forfait de base recevront également ces tags d'offre dans la bibliothèque de facturation.
otherRegionsConfig

object (OtherRegionsBasePlanConfig)

Informations sur les tarifs de tous les nouveaux pays et régions dans lesquels Play sera lancé à l'avenir. Si cet attribut est omis, le forfait de base ne sera pas automatiquement disponible pour les nouveaux emplacements que Play lancera à l'avenir.
Champ d'union base_plan_type. Type de forfait de base. Vous devez définir un seul de ces champs. Une fois le plan de base créé, son type est immuable. base_plan_type ne peut être qu'un des éléments suivants :
autoRenewingBasePlanType

object (AutoRenewingBasePlanType)

Définit la date à laquelle le forfait de base se renouvelle automatiquement à intervalles réguliers.
prepaidBasePlanType

object (PrepaidBasePlanType)

Défini lorsque le forfait de base n'est pas renouvelé automatiquement à la fin de la période de facturation.
installmentsBasePlanType

object (InstallmentsBasePlanType)

Définissez cette valeur pour les forfaits de base avec paiements échelonnés pour lesquels un utilisateur s'engage à effectuer un nombre de paiements spécifié.

État

État actuel d'un forfait de base.

Enums
STATE_UNSPECIFIED État non spécifié.
DRAFT Le forfait de base est actuellement en brouillon et n'a pas été activé. Vous pouvez le supprimer en toute sécurité à ce stade.
ACTIVE Le forfait de base est actif et disponible pour les nouveaux abonnés.
INACTIVE Le forfait de base est inactif et n'est disponible que pour les abonnés existants.

AutoRenewingBasePlanType

Représente un forfait de base qui se renouvelle automatiquement à la fin de la période d'abonnement.

Représentation JSON 
{
  "billingPeriodDuration": string,
  "gracePeriodDuration": string,
  "accountHoldDuration": string,
  "resubscribeState": enum (ResubscribeState),
  "prorationMode": enum (SubscriptionProrationMode),
  "legacyCompatible": boolean,
  "legacyCompatibleSubscriptionOfferId": string
}
Champs
billingPeriodDuration

string

Obligatoire. Immuable. Période d'abonnement, spécifiée au format ISO 8601. Pour obtenir la liste des périodes de facturation acceptées, consultez le centre d'aide. La durée est immuable une fois le plan de base créé.
gracePeriodDuration

string

Délai de grâce de l'abonnement, spécifié au format ISO 8601. Les valeurs acceptables doivent être exprimées en jours et être comprises entre P0D et la valeur la plus faible entre 30 jours et la période de facturation du forfait de base.

Si aucune valeur n'est spécifiée, une valeur par défaut est utilisée en fonction de la période de facturation.

La somme de gracePeriodDuration et de accountHoldDuration doit être comprise entre P30D et P60D (jours inclus).
accountHoldDuration

string

Facultatif. Période de blocage du compte de l'abonnement, spécifiée au format ISO 8601. Les valeurs acceptables doivent être exprimées en jours et comprises entre P0D et P60D.

Si aucune valeur n'est spécifiée, la valeur par défaut est P30D.

La somme de gracePeriodDuration et de accountHoldDuration doit être comprise entre P30D et P60D (jours inclus).
resubscribeState

enum (ResubscribeState)

Indique si les utilisateurs doivent pouvoir se réabonner à ce forfait de base dans les surfaces Google Play. La valeur par défaut est RESUBSCRIBE_STATE_ACTIVE si elle n'est pas spécifiée.
prorationMode

enum (SubscriptionProrationMode)

Le mode de prorata du forfait de base détermine ce qui se passe lorsqu'un utilisateur passe à ce forfait à partir d'un autre forfait de base. Si aucune valeur n'est spécifiée, la valeur par défaut est CHARGE_ON_NEXT_BILLING_DATE.
legacyCompatible

boolean

Indique si le forfait de base renouvelé est rétrocompatible.

Le forfait de base rétrocompatible est renvoyé par la méthode abandonnée querySkuDetailsAsync() de la Bibliothèque Google Play Billing.

Un seul forfait de base renouvelable peut être marqué comme compatible avec les anciennes versions pour un abonnement donné.
legacyCompatibleSubscriptionOfferId

string

ID de l'offre d'abonnement compatible avec les anciennes versions.

L'offre d'abonnement rétrocompatible est renvoyée par la méthode abandonnée querySkuDetailsAsync() de la Bibliothèque Google Play Billing.

Vous ne pouvez marquer qu'une seule offre d'abonnement comme compatible avec les anciennes versions pour un forfait de base donné.

Pour qu'aucune offre d'abonnement ne soit compatible avec les anciennes versions, définissez ce champ sur une chaîne vide.

ResubscribeState

État de réabonnement au forfait de base.

Enums
RESUBSCRIBE_STATE_UNSPECIFIED État non spécifié.
RESUBSCRIBE_STATE_ACTIVE La réinscription est active.
RESUBSCRIBE_STATE_INACTIVE La fonctionnalité de réabonnement est inactive.

SubscriptionProrationMode

Mode de prorata utilisé pour le renouvellement des forfaits de base.

Enums
SUBSCRIPTION_PRORATION_MODE_UNSPECIFIED Mode non spécifié.
SUBSCRIPTION_PRORATION_MODE_CHARGE_ON_NEXT_BILLING_DATE Le nouveau forfait de base sera facturé aux utilisateurs à la fin de leur période de facturation actuelle.
SUBSCRIPTION_PRORATION_MODE_CHARGE_FULL_PRICE_IMMEDIATELY Le nouveau forfait de base sera facturé immédiatement et intégralement aux utilisateurs. La période restante de leur abonnement existant sera utilisée pour prolonger la durée du nouveau forfait de facturation.

PrepaidBasePlanType

Représente un forfait de base qui ne se renouvelle pas automatiquement à la fin de son cycle et qui doit être renouvelé manuellement par l'utilisateur.

Représentation JSON 
{
  "billingPeriodDuration": string,
  "timeExtension": enum (TimeExtension)
}
Champs
billingPeriodDuration

string

Obligatoire. Immuable. Période d'abonnement, spécifiée au format ISO 8601. Pour obtenir la liste des périodes de facturation acceptées, consultez le centre d'aide. La durée est immuable une fois le plan de base créé.
timeExtension

enum (TimeExtension)

Indique si les utilisateurs doivent pouvoir prolonger ce forfait de base prépayé sur les surfaces Google Play. En l'absence de spécification, la valeur par défaut est TIME_EXTENSION_ACTIVE.

TimeExtension

Prolongation de la durée du forfait de base.

Enums
TIME_EXTENSION_UNSPECIFIED État non spécifié.
TIME_EXTENSION_ACTIVE L'extension de durée est active. Les utilisateurs peuvent recharger ou prolonger leur forfait prépayé.
TIME_EXTENSION_INACTIVE La prolongation de la période d'inactivité est inactive. Les utilisateurs ne peuvent pas recharger ni prolonger leur forfait prépayé.

InstallmentsBasePlanType

Représente un forfait de base avec paiements échelonnés dans lequel un utilisateur s'engage à effectuer un nombre spécifié de paiements.

Représentation JSON 
{
  "billingPeriodDuration": string,
  "committedPaymentsCount": integer,
  "renewalType": enum (RenewalType),
  "gracePeriodDuration": string,
  "accountHoldDuration": string,
  "resubscribeState": enum (ResubscribeState),
  "prorationMode": enum (SubscriptionProrationMode)
}
Champs
billingPeriodDuration

string

Obligatoire. Immuable. Période d'abonnement, spécifiée au format ISO 8601. Pour obtenir la liste des périodes de facturation acceptées, consultez le centre d'aide. La durée est immuable une fois le plan de base créé.
committedPaymentsCount

integer

Obligatoire. Immuable. Nombre de paiements pour lesquels l'utilisateur s'est engagé. Il est immuable une fois le plan de base créé.
renewalType

enum (RenewalType)

Obligatoire. Immuable. Type de renouvellement du forfait de base en plusieurs versements. Détermine le comportement à la fin de l'engagement initial. Le type de renouvellement est immuable une fois le forfait de base créé.
gracePeriodDuration

string

Délai de grâce de l'abonnement, spécifié au format ISO 8601. Les valeurs acceptables doivent être exprimées en jours et être comprises entre P0D et la valeur la plus faible entre 30 jours et la période de facturation du forfait de base.

Si aucune valeur n'est spécifiée, une valeur par défaut est utilisée en fonction de la période de facturation.

La somme de gracePeriodDuration et de accountHoldDuration doit être comprise entre P30D et P60D (jours inclus).
accountHoldDuration

string

Facultatif. Période de blocage du compte de l'abonnement, spécifiée au format ISO 8601. Les valeurs acceptables doivent être exprimées en jours et comprises entre P0D et P60D.

Si aucune valeur n'est spécifiée, la valeur par défaut est P30D.

La somme de gracePeriodDuration et de accountHoldDuration doit être comprise entre P30D et P60D (jours inclus).
resubscribeState

enum (ResubscribeState)

Indique si les utilisateurs doivent pouvoir se réabonner à ce forfait de base dans les surfaces Google Play. La valeur par défaut est RESUBSCRIBE_STATE_ACTIVE si elle n'est pas spécifiée.
prorationMode

enum (SubscriptionProrationMode)

Le mode de prorata du forfait de base détermine ce qui se passe lorsqu'un utilisateur passe à ce forfait à partir d'un autre forfait de base. Si aucune valeur n'est spécifiée, la valeur par défaut est CHARGE_ON_NEXT_BILLING_DATE.

RenewalType

Type de renouvellement du forfait de base en plusieurs versements. Détermine le comportement à la fin de l'engagement initial. Le type de renouvellement est immuable une fois le forfait de base créé.

Enums
RENEWAL_TYPE_UNSPECIFIED État non spécifié.
RENEWAL_TYPE_RENEWS_WITHOUT_COMMITMENT Se renouvelle périodiquement pendant la durée de la période de facturation, sans engagement.
RENEWAL_TYPE_RENEWS_WITH_COMMITMENT L'engagement est renouvelé pour une durée identique à celle de l'engagement initial.

RegionalBasePlanConfig

Configuration d'un forfait de base spécifique à une région.

Représentation JSON 
{
  "regionCode": string,
  "newSubscriberAvailability": boolean,
  "price": {
    object (Money)
  }
}
Champs
regionCode

string

Obligatoire. Code de la région à laquelle cette configuration s'applique, tel que défini par la norme ISO 3166-2 (par exemple, "US").
newSubscriberAvailability

boolean

Indique si le forfait de base de la région spécifiée est disponible pour les nouveaux abonnés. Si cette valeur est définie sur "false", les abonnements existants ne seront pas résiliés. Si ce paramètre n'est pas spécifié, la valeur par défaut est "false".
price

object (Money)

Prix du forfait de base dans la région spécifiée. Doit être défini si le forfait de base est disponible pour les nouveaux abonnés. Doit être défini dans la devise associée à la région spécifiée.

OtherRegionsBasePlanConfig

Informations tarifaires pour tous les nouveaux pays et régions où Play peut être lancé.

Représentation JSON 
{
  "usdPrice": {
    object (Money)
  },
  "eurPrice": {
    object (Money)
  },
  "newSubscriberAvailability": boolean
}
Champs
usdPrice

object (Money)

Obligatoire. Prix en USD à utiliser pour tous les nouveaux pays dans lesquels Play peut être lancé.
eurPrice

object (Money)

Obligatoire. Prix en euros à utiliser pour tous les nouveaux pays dans lesquels Play peut être lancé.
newSubscriberAvailability

boolean

Indique si le forfait de base est disponible pour les nouveaux abonnés dans les nouveaux pays où Play peut être lancé. Si ce paramètre n'est pas spécifié, la valeur par défaut est "false".

SubscriptionListing

Métadonnées visibles par le consommateur d'un abonnement.

Représentation JSON 
{
  "languageCode": string,
  "title": string,
  "benefits": [
    string
  ],
  "description": string
}
Champs
languageCode

string

Obligatoire. Langue de cette fiche, telle que définie par la norme BCP-47 (par exemple, "en-US").
title

string

Obligatoire. Titre de cet abonnement dans la langue de cette fiche. Texte brut.
benefits[]

string

Liste des avantages présentés à l'utilisateur sur des plates-formes telles que le Play Store et dans les parcours de restauration dans la langue de cette fiche. Texte brut. Liste ordonnée de quatre avantages maximum.
description

string

Description de cet abonnement dans la langue de cette fiche. Longueur maximale : 80 caractères. Texte brut.

RestrictedPaymentCountries

Pays où l'achat de ce produit est limité aux modes de paiement enregistrés dans le pays concerné. Si ce champ est vide, aucune restriction liée aux lieux de paiement n'est imposée.

Représentation JSON 
{
  "regionCodes": [
    string
  ]
}
Champs
regionCodes[]

string

Obligatoire. Codes de région auxquels appliquer des restrictions de paiement, comme défini par la norme ISO 3166-2 (par exemple, "US").

Méthodes

archive
(deprecated)

 Obsolète: l'archivage des abonnements n'est pas possible.

batchGet

 Lit un ou plusieurs abonnements.

batchUpdate

 Met à jour un lot d'abonnements.

create

 Crée un abonnement.

delete

 Supprime un abonnement.

get

 Lit un seul abonnement.

list

 Répertorie tous les abonnements d'une application donnée.

patch

 Met à jour un abonnement existant.