Method: subscriptions.list

Listas de suscripciones administradas por el distribuidor. La lista puede incluir todas las suscripciones, todas las suscripciones de un cliente o todas las suscripciones transferibles de un cliente.

De manera opcional, este método puede filtrar la respuesta por un customerNamePrefix. Para obtener más información, consulta cómo administrar 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

La cadena de consulta customerAuthToken es obligatoria cuando se crea una cuenta de reventa que transfiere la suscripción directa de un cliente o transfiere la suscripción de otro cliente del distribuidor a la administración de su distribuidor. Este es un token de autenticación hexadecimal que se necesita para completar la transferencia de la suscripción. Para obtener más información, consulte 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 utilizar para acceder al cliente, pero el identificador único del cliente (como lo muestra la API) siempre se puede utilizar. Recomendamos almacenar el identificador único en sus sistemas cuando corresponda.
customerNamePrefix

string

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

  • exa: muestra todos los nombres de clientes que comienzan con 'exa' que pueden incluir exam.com, example20.com y example.com. Un prefijo de nombre es similar al uso de un asterisco de expresión regular, exa*.
  • example: muestra example20.com y example.com.
maxResults

integer (uint32 format)

Cuando recuperas una lista grande, 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 y
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

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

Una suscripción administra la relación entre el plan de pago de un cliente de Google y el SKU del producto, las licencias de usuario, el estado de prueba gratuita de 30 días y las opciones de renovación. La función principal de un distribuidor es administrar las suscripciones del cliente de Google.

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

string

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

object (Subscription)

Las suscripciones de 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 la autorización

Se necesita uno de los siguientes alcances 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 Descripción general de OAuth 2.0.