Method: subscriptions.list

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

Listes d'abonnements gérés par le revendeur. La liste peut contenir tous les abonnements d'un client ou tous les abonnements transférables d'un client.

Cette méthode peut éventuellement filtrer la réponse par customerNamePrefix. Pour en savoir plus, consultez Gérer les abonnements.

Requête HTTP

GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de requête

Paramètres
customerAuthToken

string

La chaîne de requête customerAuthToken est obligatoire lorsque vous créez un compte indirect qui transfère l'abonnement d'un client direct ou celui d'un autre client revendeur vers votre système de gestion revendeur. Il s'agit d'un jeton d'authentification hexadécimale nécessaire pour effectuer le transfert d'abonnement. Pour en savoir plus, consultez le Centre d'aide pour les administrateurs.

customerId

string

Il peut s'agir du nom de domaine principal du client ou de son identifiant unique. Si le nom de domaine d'un client change, l'ancien nom de domaine ne peut pas être utilisé pour accéder au client, mais l'identifiant unique du client (tel que renvoyé par l'API) peut toujours être utilisé. Nous vous recommandons de stocker l'identifiant unique dans vos systèmes, le cas échéant.

customerNamePrefix

string

Lorsque vous récupérez tous vos abonnements et filtrez des clients spécifiques, vous pouvez saisir un préfixe pour le nom d'un client. Exemple de groupe de clients incluant exam.com, example20.com et example.com:

  • exa : renvoie tous les noms de clients commençant par "&exa" (exa, pouvant inclure exam.com, example20.com et example.com). Le préfixe d'un nom est semblable à l'utilisation d'un astérisque, exa*.
  • example : renvoie example20.com et example.com.

maxResults

integer (uint32 format)

Lorsque vous récupérez une longue liste, maxResults correspond au nombre maximal de résultats par page. La valeur nextPageToken vous redirige vers la page suivante. La valeur par défaut est 20.

pageToken

string

Jeton permettant de spécifier la page suivante dans la liste.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Un abonnement permet de gérer la relation entre le forfait d'un client Google et le code SKU d'un produit, les licences utilisateur, l'état d'essai offert de 30 jours et les options de renouvellement. Le rôle principal d'un revendeur est de gérer les abonnements du client Google.

Représentation JSON
{
  "kind": string,
  "subscriptions": [
    {
      object (Subscription)
    }
  ],
  "nextPageToken": string
}
Champs
kind

string

Identifie la ressource comme un ensemble d'abonnements. Valeur: revendeur#subscriptions

subscriptions[]

object (Subscription)

Abonnements sur cette page de résultats.

nextPageToken

string

Jeton de continuité permettant de parcourir les ensembles de résultats volumineux. Indiquez cette valeur dans une requête ultérieure pour renvoyer la page de résultats suivante.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/apps.order
  • https://www.googleapis.com/auth/apps.order.readonly

Pour en savoir plus, consultez Présentation d'OAuth 2.0.