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)
  }
}
Champs
packageName

string

Immuable. Nom de package de l'application parente.

productId

string

Immuable. Identifiant 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 pour cet abonnement. Représente le 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 disponible.

taxAndComplianceSettings

object (SubscriptionTaxAndComplianceSettings)

Informations sur les taxes et la conformité légale

BasePlan

Forfait de base unique 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)
  }
  // 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 norme RFC-1034. Cet identifiant ne peut donc contenir que des lettres minuscules (a-z), des chiffres (0-9) et des traits d'union (-). Il 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. Vous pouvez activer ou supprimer les plans de base brouillons et inactifs. Les forfaits de base actifs peuvent devenir inactifs. Les forfaits de base inactifs peuvent être annulés. Impossible de modifier ce champ 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 contenant jusqu'à 20 tags personnalisés spécifiés pour ce forfait de base et renvoyés à l'application via la bibliothèque Billing. Les offres d'abonnement pour ce forfait de base recevront également ces tags d'offre dans la bibliothèque Billing.

otherRegionsConfig

object (OtherRegionsBasePlanConfig)

Informations tarifaires pour tout nouveau pays dans lequel Play pourrait être lancé à l'avenir. S'il est omis, le BasePlan ne sera pas disponible automatiquement dans les nouveaux pays où Play pourra lancer son application à l'avenir.

Champ d'union base_plan_type. Type de ce forfait de base. Vous ne devez en définir qu'un. base_plan_type ne peut être qu'un des éléments suivants :
autoRenewingBasePlanType

object (AutoRenewingBasePlanType)

Définissez le moment auquel le forfait de base se renouvelle automatiquement à intervalles réguliers.

prepaidBasePlanType

object (PrepaidBasePlanType)

Définissez les cas dans lesquels le forfait de base n'est pas renouvelé automatiquement à la fin de la période de facturation.

État

État actuel d'un forfait de base.

Enums
STATE_UNSPECIFIED État non spécifié.
DRAFT Le forfait de base est actuellement à l'état de brouillon et n'a pas été activé. À ce stade, vous pouvez le supprimer en toute sécurité.
ACTIVE Le forfait de base est actif et disponible pour les nouveaux abonnés.
INACTIVE Le forfait de base est inactif et réservé aux 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. Durée 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.

gracePeriodDuration

string

Délai de grâce de l'abonnement, spécifié au format ISO 8601. Les valeurs acceptables sont P0D (zéro jour), P3D (3 jours), P7D (7 jours), P14D (14 jours) et P30D (30 jours). Si aucune valeur n'est spécifiée, une valeur par défaut sera utilisée en fonction de la durée de la période récurrente.

accountHoldDuration

string

Facultatif. Période de blocage de compte de l'abonnement, spécifiée au format ISO 8601. Les valeurs acceptables doivent être exprimées en JOURS, et comprises entre P0D (zéro jour) et P30D (30 jours). Si aucune valeur n'est spécifiée, la valeur par défaut est P30D (30 jours).

resubscribeState

enum (ResubscribeState)

Indique si les utilisateurs peuvent se réabonner à ce forfait de base dans les surfaces Google Play. Si aucune valeur n'est spécifiée, la valeur par défaut est REAB_STATE_ACTIVE.

prorationMode

enum (SubscriptionProrationMode)

Le mode de calcul au prorata du forfait de base détermine ce qui se passe lorsqu'un utilisateur passe à ce forfait depuis 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 à renouveler 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 avec renouvellement peut être marqué comme compatible avec les anciennes versions par abonnement.

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.

Une seule offre d'abonnement peut être marquée comme compatible avec les anciennes versions par forfait de base renouvelé.

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

ResubscribeState

État du réabonnement du forfait de base.

Enums
RESUBSCRIBE_STATE_UNSPECIFIED État non spécifié.
RESUBSCRIBE_STATE_ACTIVE Le réabonnement est actif.
RESUBSCRIBE_STATE_INACTIVE Le réabonnement est inactif.

SubscriptionProrationMode

Mode de calcul au prorata utilisé pour renouveler les 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 en cours.
SUBSCRIPTION_PRORATION_MODE_CHARGE_FULL_PRICE_IMMEDIATELY Le nouveau forfait de base sera immédiatement facturé aux utilisateurs dans leur intégralité. Toute période restante de l'abonnement existant sera utilisée pour prolonger la durée du nouveau forfait.

PrepaidBasePlanType

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

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

string

Obligatoire. Durée 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.

timeExtension

enum (TimeExtension)

Indique si les utilisateurs peuvent prolonger ce forfait de base prépayé sur les surfaces Google Play. Si aucune valeur n'est spécifiée, la valeur par défaut est TIME_EXTENSION_ACTIVE.

TimeExtension

Prolongation du forfait de base.

Enums
TIME_EXTENSION_UNSPECIFIED État non spécifié.
TIME_EXTENSION_ACTIVE L'extension de temps est active. Les utilisateurs sont autorisés à recharger ou prolonger leur forfait prépayé.
TIME_EXTENSION_INACTIVE L'extension de temps est inactive. Les utilisateurs ne peuvent pas recharger ni prolonger leur forfait prépayé.

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 régional auquel 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 dans 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 aucune valeur n'est spécifiée, 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 dans lesquels 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 est disponible. Si aucune valeur n'est spécifiée, la valeur par défaut est "false".

SubscriptionListing

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

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 processus de restauration, dans la langue de cette fiche. Texte brut. Liste numérotée de quatre avantages maximum.

description

string

Description de cet abonnement dans la langue de cette fiche. Ne doit pas dépasser 80 caractères. Texte brut.

Méthodes

archive
(deprecated)

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

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

Liste tous les abonnements d'une application donnée.

patch

Met à jour un abonnement existant.