REST Resource: customers

Recurso: Customer

Quando a conta de um cliente do Google é registrada com um revendedor, as assinaturas dos serviços do Google são gerenciadas por esse revendedor. 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 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 de nome de domínio principal do cliente. O customerDomain é obrigatório ao criar um cliente. Não inclua o prefixo www no domínio ao adicionar um cliente.
postalAddress

object (Address)

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

string

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

string

Assim 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 uma interrupção ou um problema de segurança. Essa propriedade é obrigatória ao criar um novo cliente "domínio" e não pode usar o mesmo domínio que customerDomain. O campo alternateEmail não é necessário para criar um cliente "equipe".
resourceUiUrl

string

URL do painel do Admin Console do cliente. O URL somente leitura é gerado pelo serviço da API. Isso é usado quando o aplicativo cliente exige que o cliente conclua uma tarefa no Admin Console.
customerDomainVerified

boolean

Indica 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 de cliente. Os valores aceitáveis incluem:

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

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

object (PrimaryAdmin)

Os primeiros detalhes do administrador do cliente, presentes no caso de clientes TEAM.

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 saber mais sobre countryCode, consulte os elementos do código de país ISO 3166. Verifique se o país está autorizado para revender produtos do Google. Essa 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 valor de region é CA para o estado da Califórnia.
addressLine2

string

Linha 2 do endereço.
locality

string

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

string

Linha 3 do endereço.
postalCode

string

Um exemplo de postalCode é um código postal, como 94043. Essa 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 da 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 não conhecido
domain Clientes com domínio ou proprietários de domínio
team Clientes sem domínio ou com e-mail verificado

PrimaryAdmin

Modelo JSON para o administrador principal no caso de clientes TEAM

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

string

O e-mail comercial do administrador principal do cliente.

O link de verificação é 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

 Faz o pedido de uma conta de cliente nova.

patch

 Atualiza as configurações de uma conta de cliente.

update

 Atualiza as configurações de uma conta de cliente.