REST Resource: partners.customers

Recurso: Company

Um revendedor, fornecedor ou cliente nas APIs para revendedores e clientes do registro 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. Somente entrada. Endereço de e-mail dos usuários do cliente na função de proprietário. É necessário pelo menos um owner_email. Os proprietários têm o mesmo acesso que os administradores, mas também podem adicionar, excluir e editar os usuários dos portais 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. Se algum usuário da empresa aceitou os Termos de Serviço (TOS) mais recentes. Consulte TermsStatus.
skipWelcomeEmail

boolean

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

string

Somente entrada. A localidade de preferência do cliente representada como um código de idioma BCP47. Este campo é validado na entrada, e as solicitações que contêm códigos de idioma sem suporte serão rejeitadas.

googleWorkspaceAccount

object (GoogleWorkspaceAccount)

Apenas saída. A conta do Google Workspace associada a este cliente. Usado apenas para Empresas do cliente.

TermsStatus

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

Os Termos de Serviço são controlados por versão. Isso significa que, quando os TOS mudarem, pelo menos um usuário precisará aceitar os novos. Até que o primeiro usuário aceite os novos TOS, 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 usuário aceitou um dos Termos de Serviço anteriores.

GoogleWorkspaceAccount

Um cliente do Google Workspace.

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

string

Obrigatório. O 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 inscritos no revendedor identificado pelo argumento partnerId.