REST Resource: customers

Recurso: Customer

Quando a conta de um cliente do Google é registrada com um revendedor, as assinaturas do Cliente para os 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 do nome do 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)

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

string

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

string

Como o "e-mail do cliente" nas ferramentas de 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. Essa propriedade é obrigatória ao criar um novo cliente de"domínio"e não deve usar o mesmo domínio que customerDomain. O campo alternateEmail não é necessário para criar um cliente "team"
resourceUiUrl

string

URL para o painel do Admin Console do cliente. O URL somente leitura é gerado pelo serviço da API. Isso é usado quando o aplicativo cliente exige a conclusão de 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 de cliente. Os valores aceitáveis incluem:

  • 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 do administrador do cliente, presentes no caso do cliente TEAM.

Endereço

Modelo JSON do 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 mais informações sobre countryCode, consulte os elementos do código de país ISO 3166. Verifique se o país está aprovado para a revenda de 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 region é CA para o estado da Califórnia.
addressLine2

string

Linha 2 do endereço.
locality

string

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

string

Linha 3 do endereço.
postalCode

string

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

string

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

string

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

string

O nome do contato do cliente. Obrigatório.

Tipo de cliente

Tipo de cliente

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

Administrador principal

Modelo JSON para administrador principal no caso de clientes do TEAM

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 no momento da criação do cliente. Os administradores principais têm acesso ao Admin Console do cliente, incluindo a possibilidade de convidar e remover usuários e gerenciar as necessidades administrativas do cliente.

Métodos

get

 Recebe uma conta de cliente.

insert

 Pedidos de uma nova conta de cliente.

patch

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

update

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