REST Resource: partners.customers

Recurso: Company

Um revendedor, fornecedor ou cliente nas APIs de revendedor e cliente sem toque.

Representação JSON 
{
  "name": string,
  "companyId": string,
  "companyName": string,
  "ownerEmails": [
    string
  ],
  "adminEmails": [
    string
  ],
  "termsStatus": enum (TermsStatus),
  "skipWelcomeEmail": boolean,
  "languageCode": string,
  "googleWorkspaceAccount": {
    object (GoogleWorkspaceAccount)
  }
}
Campos
name

string

Apenas saída. O nome do recurso de API da empresa. O nome do recurso tem um dos seguintes formatos:

  • partners/[PARTNER_ID]/customers/[CUSTOMER_ID]
  • partners/[PARTNER_ID]/vendors/[VENDOR_ID]
  • partners/[PARTNER_ID]/vendors/[VENDOR_ID]/customers/[CUSTOMER_ID]

Atribuído pelo servidor.
companyId

string (int64 format)

Apenas saída. O ID da empresa. Atribuído pelo servidor.
companyName

string

Obrigatório. O nome da empresa. Por exemplo, XYZ Corp. Exibida aos funcionários da empresa no portal de registro sem toque.
ownerEmails[]

string

Obrigatório. Apenas entrada. Endereço de e-mail dos usuários do cliente na função "Proprietário". É necessário incluir pelo menos uma owner_email. Os proprietários têm o mesmo acesso que os administradores, mas também podem adicionar, excluir e editar os usuários no portal da sua organização.
adminEmails[]

string

Opcional. Endereço de e-mail dos usuários do cliente na função de administrador. Cada endereço de e-mail precisa estar associado a uma Conta do Google.
termsStatus

enum (TermsStatus)

Apenas saída. Indica se alguém da empresa aceitou os Termos de Serviço (TOS) mais recentes. Consulte os TermsStatus.
skipWelcomeEmail

boolean

Apenas entrada. Se ela for definida como verdadeira, o e-mail de boas-vindas não será enviado ao cliente. É recomendável pular o e-mail de recepção se os dispositivos forem reivindicados com serviço adicional DEVICE_PROTECTION, já que o cliente receberá e-mails separados no momento da reivindicação do dispositivo. Este campo será ignorado se não for um cliente sem toque.
languageCode

string

Apenas entrada. A localidade preferida do cliente representada como um código de idioma BCP47. Este campo é validado na entrada e as solicitações com códigos de idioma não aceitos serão rejeitadas. Códigos de idiomas compatíveis: árabe (ar) Chinês (Hong Kong) (zh-HK) Chinês (simplificado) (zh-CN) Chinês (tradicional) (zh-TW) Tcheco (cs) Dinamarquês (nl) Inglês (nl) Reino Unido (en-GB) Inglês (EUA) (en-US) Filipino (Indiano) Cantonês (Im.)
googleWorkspaceAccount

object (GoogleWorkspaceAccount)

Apenas saída. Conta do Google Workspace associada a este cliente. Usado apenas para empresas clientes.

TermosTermos

a aceitação dos Termos de Serviço (TOS) sem registro. Um único usuário pode aceitar os TOS da empresa usando o portal da Web.

Os TOS têm controle de versão. Isso significa que, quando os TOS forem alterados, pelo menos um deles precisará aceitá-los. Até que o primeiro usuário aceite os novos Termos de Serviço, o status dos termos da empresa será TERMS_STATUS_STALE.

Enums
TERMS_STATUS_NOT_ACCEPTED Nenhum dos usuários da empresa aceitou os TOS.
TERMS_STATUS_ACCEPTED Um ou mais usuários da empresa aceitaram os TOS.
TERMS_STATUS_STALE Nenhum dos usuários da empresa aceitou os TOS atuais, mas pelo menos um já aceitou.

Conta do Google Workspace

um cliente do Google Workspace;

Representação JSON 
{
  "customerId": string,
  "preProvisioningTokens": [
    string
  ]
}
Campos
customerId

string

Obrigatório. ID de cliente.
preProvisioningTokens[]

string

Apenas saída. Os tokens de pré-provisionamento usados anteriormente para reivindicar dispositivos.

Métodos

create

 Cria um cliente para o registro sem toque.

list

 Lista os clientes que estão registrados para o revendedor identificado pelo argumento partnerId.