REST Resource: customers

Recurso: Customer

Quando a conta de um cliente do Google é registrada com um revendedor, as assinaturas dos Serviços do Google do cliente são gerenciadas por ele. Um cliente é descrito por um nome de domínio principal e um endereço físico.

Representação JSON 
{
  "customerId": string,
  "customerDomain": string,
  "postalAddress": {
    object (Address)
  },
  "phoneNumber": string,
  "alternateEmail": string,
  "resourceUiUrl": string,
  "customerDomainVerified": boolean,
  "kind": string,
  "customerType": enum (CustomerType),
  "primaryAdmin": {
    object (PrimaryAdmin)
  }
}
Campos
customerId

string

Essa propriedade sempre vai ser retornada em uma resposta como o identificador exclusivo gerado pelo Google. Em uma solicitação, essa propriedade pode ser o domínio principal ou o identificador exclusivo gerado pelo Google.
customerDomain

string

A string do nome de domínio principal do cliente. customerDomain é obrigatório ao criar um novo cliente. Não inclua o prefixo www no domínio ao adicionar um cliente.
postalAddress

object (Address)

Informações de endereço do cliente Cada campo tem um limite de 255 caracteres.
phoneNumber

string

Número de telefone para contato do cliente. Precisa começar com "+" seguido pelo código do país. O restante do número pode ser contíguo ou respeitar as convenções de formato local de telefone, mas deve ser um número de telefone real, e não, por exemplo, "123". Este campo é ignorado silenciosamente se for inválido.
alternateEmail

string

Como o "E-mail do cliente" nas ferramentas do revendedor, esse e-mail é o contato secundário usado se algo acontecer com o serviço do cliente, como interrupção do serviço ou um problema de segurança. Esta propriedade é obrigatória ao criar um novo "domínio" e não deve usar o mesmo domínio que customerDomain. O campo alternateEmail não é necessário para criar uma "equipe" para o cliente.
resourceUiUrl

string

URL para o painel do Admin Console do cliente. O URL somente leitura é gerado pelo serviço de API. Usado se o aplicativo cliente exigir que o cliente conclua uma tarefa no Admin Console.
customerDomainVerified

boolean

Se o domínio principal do cliente foi verificado.
kind

string

Identifica o recurso como um cliente. Valor: reseller#customer
customerType

enum (CustomerType)

Identifica o tipo do cliente. Os valores aceitáveis são os seguintes:

  • domain: implica um cliente com domínio verificado (padrão).
  • team: implica um cliente com e-mail verificado.

Para mais informações, consulte equipes gerenciadas.
primaryAdmin

object (PrimaryAdmin)

Os primeiros detalhes de administrador do cliente, presentes no caso do cliente da EQUIPE.

Endereço

Modelo JSON para o endereço de um cliente.

Representação JSON 
{
  "countryCode": string,
  "kind": string,
  "region": string,
  "addressLine2": string,
  "locality": string,
  "addressLine3": string,
  "postalCode": string,
  "addressLine1": string,
  "organizationName": string,
  "contactName": string
}
Campos
countryCode

string

Para informações sobre countryCode, consulte os elementos do código de país do ISO 3166. Verifique se o país está aprovado para a revenda de produtos do Google. Esta propriedade é obrigatória ao criar um novo cliente.
kind

string

Identifica o recurso como um endereço do cliente. Valor: customers#address
region

string

Um exemplo de um valor region é CA para o estado da Califórnia.
addressLine2

string

Linha 2 do endereço.
locality

string

Um exemplo de um valor locality é a cidade San Francisco.
addressLine3

string

Linha 3 do endereço.
postalCode

string

Um exemplo de postalCode é um CEP, como 94043. Esta propriedade é obrigatória ao criar um novo cliente.
addressLine1

string

Endereço físico de um cliente. Um endereço pode ser composto de uma a três linhas. O addressline2 e o addressLine3 são opcionais.
organizationName

string

O nome da empresa ou divisão da empresa. Obrigatório.
contactName

string

O nome do contato do cliente. Obrigatório.

CustomerType

Tipo de cliente

Enums
customerTypeUnspecified Tipo de cliente desconhecido
domain Clientes com domínios ou proprietários de domínios
team Clientes sem domínio ou com e-mail verificado

PrimaryAdmin

Modelo JSON para o administrador principal no caso de clientes da EQUIPE

Representação JSON 
{
  "primaryEmail": string
}
Campos
primaryEmail

string

O e-mail comercial do administrador principal do cliente.

O link de verificação de e-mail é enviado para esse endereço de e-mail no momento da criação do cliente. Os administradores principais têm acesso ao Admin Console do cliente, incluindo a capacidade de convidar e remover usuários e gerenciar as necessidades administrativas do cliente.

Métodos

get

 Recebe uma conta de cliente.

insert

 Encomenda a conta de um novo cliente.

patch

 Atualiza as configurações da conta de um cliente.

update

 Atualiza as configurações da conta de um cliente.