Method: subscriptions.list

Las listas de suscripciones administradas por el revendedor. La lista puede incluir todas las suscripciones, las de un cliente o todas las suscripciones transferibles de un cliente.

De manera opcional, este método puede filtrar la respuesta por un customerNamePrefix. Si quieres obtener más información, consulta Administra suscripciones.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de consulta

Parámetros
customerAuthToken

string

Se requiere la cadena de consulta customerAuthToken cuando se crea una cuenta de reventa que transfiera la suscripción de un cliente directo o la de otro cliente revendedor a la administración de tu revendedor. Este es un token de autenticación hexadecimal que se necesita para completar la transferencia de la suscripción. Si deseas obtener más información, consulta el Centro de ayuda para administradores.
customerId

string

Puede ser el nombre de dominio principal del cliente o el identificador único del cliente. Si el nombre de dominio de un cliente cambia, el nombre de dominio anterior no se puede usar para acceder al cliente, pero se puede usar siempre el identificador único del cliente (como lo muestra la API). Te recomendamos que almacenes el identificador único en tus sistemas cuando corresponda.
customerNamePrefix

string

Cuando recuperes todas tus suscripciones y filtres por clientes específicos, puedes ingresar un prefijo para el nombre de un cliente. Con un ejemplo de grupo de clientes que incluya exam.com, example20.com y example.com:

  • exa: Muestra todos los nombres de cliente que comienzan con "exa". que podría incluir exam.com, example20.com y example.com. Un prefijo de nombre es similar al uso del asterisco de una expresión regular, exa*.
  • example: muestra example20.com y example.com.
maxResults

integer (uint32 format)

Cuando se recupera una lista de gran tamaño, maxResults es la cantidad máxima de resultados por página. El valor nextPageToken te lleva a la página siguiente. El valor predeterminado es 20.
pageToken

string

Token para especificar la página siguiente en la lista

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Una suscripción administra la relación del plan de pagos de un cliente de Google con el SKU de un producto, las licencias de usuario, el estado de la prueba gratuita de 30 días y las opciones de renovación. Una de las funciones principales de los distribuidores es administrar las suscripciones de los clientes de Google.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON 
{
  "kind": string,
  "subscriptions": [
    {
      object (Subscription)
    }
  ],
  "nextPageToken": string
}
Campos
kind

string

Identifica el recurso como una colección de suscripciones. Valor: revendedor#subscriptions
subscriptions[]

object (Subscription)

Las suscripciones en esta página de resultados.
nextPageToken

string

Es el token de continuación, que se usa para desplazarse por grandes conjuntos de resultados. Proporciona este valor en una solicitud posterior para mostrar la página siguiente de resultados.

Alcances de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta la Guía de autorización.