Method: subscriptions.list

Listes des abonnements gérés par le revendeur. Cette liste peut contenir tous les abonnements, 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 l'article 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 l'abonnement d'un autre client revendeur à votre gestion. Il s'agit d'un jeton d'authentification hexadécimal nécessaire pour finaliser 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 que vous filtrez des clients spécifiques, vous pouvez saisir le préfixe du nom du client. À l'aide d'un exemple de groupe de clients incluant exam.com, example20.com et example.com:

  • exa : renvoie tous les noms de clients commençant par "exa" qui peut inclure exam.com, example20.com et example.com. Un préfixe de nom est semblable à l'astérisque d'une expression régulière, exa*.
  • example : renvoie example20.com et example.com.
maxResults

integer (uint32 format)

Lors de l'extraction d'une longue liste, maxResults correspond au nombre maximal de résultats par page. La valeur nextPageToken vous permet d'accéder à 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

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

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

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

string

Identifie la ressource en tant que collection d'abonnements. Valeur: reseller#subscriptions
subscriptions[]

object (Subscription)

Abonnements présentés sur cette page de résultats.
nextPageToken

string

Jeton de continuité servant à 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 le Guide relatif aux autorisations.