Coleção partnerSubscriptions

Recurso PartnerSubscription

Uma visualização de uma assinatura com as informações necessárias para preenchê-la. Uma assinatura é um contrato entre o cliente e o Google para que o cliente compre um determinado recurso do Google por um período específico.

Uma assinatura representa uma única compra. Se o usuário cancelar e reiniciar a compra ou alterar o recurso inscrito, incluindo o upgrade ou downgrade do nível de serviço, isso será representado com uma nova assinatura. A nova assinatura terá um novo name, mas terá o mesmo externalAccountId da assinatura antiga.

Representação JSON 

{
  "name": string,
  "externalAccountId": string,
  "version": string,
  "status": enum(Status),
  "subscribedResources": [
    {
      object(SubscribedResource)
    }
  ],
  "requiredApprovals": [
    {
      object(RequiredApproval)
    }
  ],
  "startDate": {
    object(Date)
  },
  "endDate": {
    object(Date)
  },
  "createTime": string,
  "updateTime": string,
}
Nome do campo Tipo Descrição
name string O nome desta assinatura. Isso será gerado automaticamente quando a assinatura for criada. Ele estará no formato subscriptions/*, em que o * é uma string opaca.
externalAccountId string O identificador da conta proprietária dessa assinatura. Esse identificador é exclusivo para uma determinada conta e provedor de assinatura.
version string Um número de versão opaco para este registro. Isso pode ser usado para verificar facilmente se há atualizações para uma assinatura.
status enum(Status) O status atual desta assinatura.
subscribedResources[] object(SubscribedResource) Os recursos incluídos nesta assinatura. Todos esses recursos precisam pertencer ao mesmo provedor de assinatura.
requiredApprovals[] object(RequiredApproval) Representa um conjunto de aprovações que precisam ser concedidas para que a assinatura se torne ACTIVE. Se uma assinatura não tiver nenhuma aprovação necessária, ela não precisará de aprovação para se tornar ACTIVE.
startDate object(Date) A data em que a assinatura começou.
endDate object(Date) A data em que a assinatura terminou, se o status for COMPLETE. Caso contrário, ela estará vazia.
createTime string

O carimbo de data/hora em que a assinatura foi criada. Se fornecido como uma entrada, o servidor a ignorará. @OutputOnly

Um carimbo de data/hora no formato UTC “Zulu” RFC3339, medido com precisão de nanossegundos. Exemplo: "2014-10-02T15:01:23.045123456Z".
updateTime string

O carimbo de data/hora em que a assinatura foi modificada pela última vez. Se fornecido como uma entrada, o servidor a ignorará. @OutputOnly

Um carimbo de data/hora no formato UTC “Zulu” RFC3339, medido com precisão de nanossegundos. Exemplo: "2014-10-02T15:01:23.045123456Z".

Status

O status atual da assinatura.

Valor Enum Descrição
UNKNOWN_STATUS Valor padrão. Esse valor nunca pode ser retornado.
ACTIVE A assinatura foi processada e está em andamento.
COMPLETE A assinatura estava ativa, mas foi encerrada. Depois que uma assinatura é marcada como concluída, ela nunca se torna ACTIVE novamente.
PENDING A assinatura foi criada, mas ainda não começou. A data de início pode ser no futuro e/ou precisa de um ou mais RequiredApprovals.
CANCELED Não foi possível concluir a assinatura. Ela foi cancelada antes de se tornar ACTIVE.

SubscribedResource

Identifica um único recurso comprado por uma assinatura, incluindo o provedor de assinatura, o recurso e os outros metadados que identificam o recurso comprado.

Representação JSON 

{
  "subscriptionProvider": string,
  "resource": string,
  "labels": {
    string: string,
    ...
  },
}
Nome do campo Tipo Descrição
subscriptionProvider string O nome do provedor do recurso que está sendo inscrito. Se a assinatura estiver associada a uma API atual, ele deverá ser o URL dessa API (por exemplo, example.googleapis.com). Se o recurso não estiver associado a uma API atual, o nome do provedor será anexado ao URL dessa API (por exemplo, example-cloudbilling.googleapis.com).
resource string O nome do tipo de recurso que precisa ser inscrito. Esse será um nome de caso de letras concatenadas que descreve o que está sendo comprado, definido ao configurar um novo tipo de recurso.
labels map (key: string, value: string)

A coleção de rótulos para este recurso. Eles podem ser usados para fornecer configuração personalizada para esse recurso ou para armazenar metadados adicionais.

Um uso comum para rótulos é especificar o nível de serviço para tipos de assinatura com vários níveis. Por exemplo, uma assinatura de suporte com os níveis Silver e Gold disponíveis poderia usar um rótulo com a chave "SupportLevel" com possíveis valores de "Gold" e "Silver".

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

RequiredApproval

Representa uma aprovação que precisa ser fornecida antes que a assinatura possa começar. Isso pode representar uma aprovação automática ou uma aprovação manual. As aprovações são criadas automaticamente no momento da criação da assinatura. Uma aprovação pode ser aprovada ou rejeitada. Após a aprovação ou rejeição, o status de uma aprovação não pode ser alterado.

Representação JSON 

{
  "name": string,
  "status": enum(Status),
  "approvalTime": string,
  "approvalNote": string,
}
Nome do campo Tipo Descrição
name string O nome dessa aprovação. Ele precisa ter o valor "default-approval".
status enum(Status) O status dessa aprovação. Quando uma assinatura com aprovação é criada, ela precisa ser PENDING. Ao atualizar uma aprovação, ela deve ser definida como APPROVED ou DENIED.
approvalTime string

A hora em que essa aprovação foi concedida ou negada. Isso é definido automaticamente. @OutputOnly

Um carimbo de data/hora no formato UTC “Zulu” RFC3339, medido com precisão de nanossegundos. Exemplo: "2014-10-02T15:01:23.045123456Z".
approvalNote string Uma explicação para a alteração de status. Isso é opcional quando o status é APPROVED e obrigatório quando o status é DENIED.

Status

Indica o estado atual da aprovação necessária.

Valor Enum Descrição
STATUS_UNSPECIFIED Valor padrão. Esse valor nunca pode ser retornado.
PENDING A aprovação não foi concedida nem negada.
APPROVED A aprovação foi concedida.
DENIED A aprovação foi negada.

Data

Representa uma data inteira do calendário (por exemplo, data de nascimento). A hora do dia e o fuso horário são especificados em outro lugar ou não são significativos. A data é referente ao calendário gregoriano proléptico. O dia pode ser 0 para representar um ano e mês em que o dia não é significativo (por exemplo, data de validade do cartão de crédito). O ano pode ser 0 para representar um mês e dia independentemente do ano (por exemplo, data de aniversário). Os tipos relacionados são [google.type.TimeOfDay][] e google.protobuf.Timestamp.

Representação JSON 

{
  "year": number,
  "month": number,
  "day": number,
}
Nome do campo Tipo Descrição
year number Ano da data. Precisa ser de 1 a 9999, ou 0 se especificar uma data sem um ano.
month number Mês do ano. Precisa ser de 1 a 12.
day number Dia do mês. Precisa ser de 1 a 31 e válido para o ano e o mês, ou 0 se especificar um ano/mês em que o dia não é significativo.

Métodos

Método Descrição
approve Altera o status de uma aprovação de PENDING para APPROVED em uma assinatura de parceiro.
deny Altera o status de uma aprovação de PENDING para DENIED em uma assinatura de parceiro.
get Recupera o status atual de uma única assinatura.
list Lista todas as assinaturas de um determinado ID de conta externa.