Method: subscriptions.list

Listas de assinaturas gerenciadas pelo revendedor. A lista pode incluir todas as assinaturas, todas as assinaturas de um cliente ou todas as assinaturas transferíveis de um cliente.

Opcionalmente, esse método pode filtrar a resposta por um customerNamePrefix. Para mais informações, consulte Gerenciar assinaturas.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de consulta

Parâmetros
customerAuthToken

string

A string de consulta customerAuthToken é necessária ao criar uma conta de revenda que transfere a assinatura de um cliente direto ou de outro cliente de revendedor para o gerenciamento de revendedor. É um token de autenticação hexadecimal necessário para concluir a transferência da assinatura. Para mais informações, consulte a Central de Ajuda para administradores.
customerId

string

Pode ser o nome de domínio principal ou o identificador exclusivo do cliente. Se o nome de domínio de um cliente mudar, o nome antigo não poderá ser usado para acessar o cliente, mas o identificador exclusivo do cliente (retornado pela API) sempre poderá. Recomendamos armazenar o identificador exclusivo nos seus sistemas, quando aplicável.
customerNamePrefix

string

Ao recuperar todas as assinaturas e filtrar clientes específicos, você pode inserir um prefixo para um nome de cliente. Usando um exemplo de grupo de clientes que inclui exam.com, example20.com e example.com:

  • exa: retorna todos os nomes de clientes que começam com "exa", que podem incluir exam.com, example20.com e example.com. Um prefixo de nome é semelhante ao uso de um asterisco de expressão regular, exa*.
  • example: retorna example20.com e example.com.
maxResults

integer (uint32 format)

Ao extrair uma lista grande, o maxResults é o número máximo de resultados por página. O valor nextPageToken leva você para a próxima página. O padrão é 20.
pageToken

string

Token para especificar a próxima página da lista

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Uma assinatura gerencia a relação do plano de pagamento de um cliente do Google com o SKU de um produto, as licenças de usuário, o status de teste sem custo financeiro de 30 dias e as opções de renovação. Uma das principais funções de um revendedor é gerenciar as assinaturas do cliente do Google.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "kind": string,
  "subscriptions": [
    {
      object (Subscription)
    }
  ],
  "nextPageToken": string
}
Campos
kind

string

Identifica o recurso como uma coleção de assinaturas. Valor: reseller#subscriptions
subscriptions[]

object (Subscription)

As assinaturas nesta página de resultados.
nextPageToken

string

O token de continuação, usado para percorrer conjuntos grandes de resultados. Forneça esse valor em uma solicitação subsequente para retornar a próxima página de resultados.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte o guia de autorização.