REST Resource: monetization.subscriptions

Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

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 du package de l'application parente.

productId

string

Immuable. Identifiant unique du produit. Unique dans l'application parente. Les ID 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 ou un chiffre minuscule et comporter entre 1 et 40 caractères (inclus).

basePlans[]

object (BasePlan)

Ensemble de forfaits de base pour cet abonnement. Prix et durée de l'abonnement si aucune autre offre ne s'applique.

listings[]

object (SubscriptionListing)

Obligatoire. apks.list 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

boolean

Uniquement en sortie. Indique si cet abonnement est archivé. Les abonnements archivés ne sont plus disponibles pour les abonnés, ne peuvent plus être mis à jour et ne sont pas renvoyés dans les requêtes sous forme de liste, sauf si l'indicateur d'affichage des archives est transmis.

taxAndComplianceSettings

object (SubscriptionTaxAndComplianceSettings)

Informations sur les taxes et la conformité juridique.

Forfait de base

Un 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. Autrement dit, cet ID ne peut contenir que des lettres minuscules (a-z), des chiffres (0-9) et des traits d'union (-), et ne doit pas dépasser 63 caractères.

state

enum (State)

Uniquement en sortie. État du forfait de base, à savoir s'il est actif. Vous pouvez activer ou supprimer les forfaits de base brouillons et inactifs. Les forfaits de base actifs peuvent être désactivés. Les forfaits de base inactifs peuvent être annulés. Vous ne pouvez pas 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)

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

otherRegionsConfig

object (OtherRegionsBasePlanConfig)

Les informations sur les prix des nouveaux pays où Play pourra être déployé à l'avenir. En cas d'omission, le forfait BasePlan ne sera pas disponible automatiquement pour les nouveaux emplacements que Play pourrait lancer à l'avenir.

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

object (AutoRenewingBasePlanType)

Définissez la date de renouvellement automatique du forfait de base à intervalles réguliers.

prepaidBasePlanType

object (PrepaidBasePlanType)

Définissez ce paramètre lorsque le forfait de base n'est pas renouvelé automatiquement à la fin de la période de facturation.

State

État actuel d'un forfait de base.

Enums
STATE_UNSPECIFIED État non spécifié.
DRAFT Le forfait de base est à 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 n'est disponible que pour les abonnés existants.

AutoRenewingBasePlanType

Représente un forfait de base qui est renouvelé automatiquement à la fin de sa période d'abonnement.

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

string

Obligatoire. 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.

gracePeriodDuration

string

Délai de grâce de l'abonnement, spécifié au format ISO 8601. Valeurs acceptées : 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 est utilisée en fonction de la durée de la période récurrente.

resubscribeState

enum (ResubscribeState)

Indique si les utilisateurs doivent pouvoir se réabonner à ce forfait de base dans les surfaces Google Play. S'il n'est pas spécifié, la valeur par défaut est RESUBSCRIBE_STATUS_ACTIVE.

prorationMode

enum (SubscriptionProrationMode)

Le mode de calcul au prorata pour le forfait de base détermine ce qui se passe lorsqu'un utilisateur passe d'un forfait à un autre. 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 à renouvellement est rétrocompatible.

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

Un seul forfait de base à renouveler peut être marqué comme compatible avec un ancien 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 pour un forfait de base à renouvellement donné.

Pour qu'aucune offre d'abonnement ne soit compatible avec l'ancienne version, définissez ce champ en tant que chaîne vide.

Se réabonner

État de 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.

Mode d'abonnement

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

Type de forfait de base prépayé

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

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

string

Obligatoire. 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.

timeExtension

enum (TimeExtension)

Indique si les utilisateurs doivent être en mesure de 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.

Extension de temps

Extension de durée 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 à créditer ou prolonger leur forfait prépayé.
TIME_EXTENSION_INACTIVE L'extension de temps est inactive. Les utilisateurs ne peuvent pas créditer ni prolonger leur forfait prépayé.

Configuration de base du forfait régional

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. Les abonnements existants ne seront pas annulés si cette valeur est définie sur "false". 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.

AutreRégionBaseBaseConfig

Informations sur les prix pour les nouveaux pays dans lesquels Play est disponible.

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 est disponible.

eurPrice

object (Money)

Obligatoire. Prix en EUR pour les nouveaux pays où Play est susceptible d'être lancé.

newSubscriberAvailability

boolean

Indique si le forfait de base est disponible pour les nouveaux abonnés dans tous les nouveaux pays où Play est disponible. Si aucune valeur n'est spécifiée, la valeur par défaut est "false".

Abonnement à la fiche

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 "fr-FR".

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 comme le Play Store et les procédures de restauration dans le langage de la fiche. Texte brut. Liste numérotée comportant quatre avantages au maximum.

description

string

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

Méthodes

archive

Archive un abonnement.

create

Creates a new subscription.

delete

Supprime un abonnement.

get

Lit un seul abonnement.

list

Répertorie tous les abonnements associés à une application donnée.

patch

Met à jour un abonnement existant.