Enterprises

Para ver uma lista de métodos desse recurso, consulte o final desta página.

Representações de recursos

Um recurso "Enterprises" representa a vinculação entre um EMM e uma organização específica. Essa vinculação pode ser instanciada de duas maneiras diferentes usando esta API, da seguinte forma:

  • Para clientes de domínios gerenciados pelo Google, o processo envolve o uso de Enterprises.enroll e Enterprises.setAccount (junto com artefatos obtidos no Admin Console e no Console de APIs do Google) e é enviado ao EMM por um processo mais ou menos manual.
  • Para clientes com contas do Google Play gerenciado, o processo envolve o uso de Enterprises.generateSignupUrl e Enterprises.completeSignup com a interface de inscrição do Google Play gerenciado (mecanismo fornecido pelo Google) para criar a vinculação sem etapas manuais.
Como EMM, você pode oferecer suporte a uma ou às duas abordagens no console de EMM. Consulte Criar uma empresa para mais detalhes.

{
  "kind": "androidenterprise#enterprise",
  "id": string,
  "primaryDomain": string,
  "name": string,
  "administrator": [
    {
      "email": string
    }
  ],
  "googleAuthenticationSettings": {
    "googleAuthenticationRequired": string,
    "dedicatedDevicesAllowed": string,
    "createdAt": {
      "seconds": long,
      "nanos": integer
    },
    "updatedAt": {
      "seconds": long,
      "nanos": integer
    }
  },
  "enterpriseType": string,
  "managedGoogleDomainType": string
}
Nome da propriedade Valor Descrição Observações
administrator[] list Administradores da empresa. Isso só é compatível com empresas criadas pelo fluxo iniciado pelo EMM.

administrator[].email string O endereço de e-mail do administrador.
enterpriseType string O tipo da empresa.

Os valores aceitáveis são:
  • "enterpriseTypeUnspecified"
  • "managedGoogleDomain"
  • "managedGooglePlayAccountsEnterprise"
googleAuthenticationSettings nested object Configurações para autenticação de usuários fornecida pelo Google.
googleAuthenticationSettings.createdAt nested object Carimbo de data/hora de quando as configurações foram criadas ou modificadas pela primeira vez.
googleAuthenticationSettings.createdAt.nanos integer Frações não negativas de um segundo com resolução de nanossegundos. Os valores de segundos negativos com frações ainda precisam ter valores em nanossegundos não negativos que representam períodos posteriores. Precisa ser de 0 a 999.999.999 (inclusive).
googleAuthenticationSettings.createdAt.seconds long Representa os segundos no horário UTC desde o período do Unix 1970-01-01T00:00:00Z. O valor precisa ser de 0001-01-01T00:00:00Z a 9999-12-31T23:59:59Z (inclusive).
googleAuthenticationSettings.dedicatedDevicesAllowed string Se os dispositivos dedicados são permitidos.

Os valores aceitáveis são:
  • "allowed"
  • "dedicatedDevicesAllowedUnspecified"
  • "disallowed"
googleAuthenticationSettings.googleAuthenticationRequired string Indica se a autenticação do Google é obrigatória.

Os valores aceitáveis são:
  • "googleAuthenticationRequiredUnspecified"
  • "notRequired"
  • "required"
googleAuthenticationSettings.updatedAt nested object Carimbo de data/hora da última modificação das configurações.
googleAuthenticationSettings.updatedAt.nanos integer Frações não negativas de um segundo com resolução de nanossegundos. Os valores de segundos negativos com frações ainda precisam ter valores em nanossegundos não negativos que representam períodos posteriores. Precisa ser de 0 a 999.999.999 (inclusive).
googleAuthenticationSettings.updatedAt.seconds long Representa os segundos no horário UTC desde o período do Unix 1970-01-01T00:00:00Z. O valor precisa ser de 0001-01-01T00:00:00Z a 9999-12-31T23:59:59Z (inclusive).
id string O ID exclusivo da empresa.

id string O ID exclusivo da empresa.

kind string
managedGoogleDomainType string O tipo de domínio gerenciado do Google.

Os valores aceitáveis são:
  • "managedGoogleDomainTypeUnspecified"
  • "typeDomain"
  • "typeTeam"
name string O nome da empresa, por exemplo, "Exemplo LTDA".
primaryDomain string O domínio principal da empresa, como "example.com".

Métodos

acknowledgeNotificationSet
Confirma as notificações recebidas de Enterprises.PullNotificationSet para evitar que chamadas subsequentes retornem as mesmas notificações.
completeSignup
Conclui o fluxo de inscrição especificando o token de conclusão e o token da empresa. Essa solicitação não pode ser chamada várias vezes para um determinado token empresarial.
createWebToken
Retorna um token exclusivo para acessar uma interface incorporável. Para gerar uma interface da Web, transmita o token gerado para a API JavaScript do Google Play gerenciado. Cada token só pode ser usado para iniciar uma sessão da interface. Consulte a documentação da API JavaScript para mais informações.
enroll
Registra uma empresa com o EMM de chamada.
generateEnterpriseUpgradeUrl
Gera um URL de upgrade empresarial para atualizar um pacote de contas do Google Play gerenciado para um Managed Google Domain. Consulte o guia de upgrade de uma empresa para mais detalhes.
generateSignupUrl
Gera um URL de inscrição.
get
Recupera o nome e o domínio de uma empresa.
getServiceAccount
Retorna uma conta de serviço e credenciais. A conta de serviço pode ser vinculada à empresa chamando setAccount. A conta de serviço é exclusiva dessa empresa e EMM e será excluída se a empresa for desvinculada. As credenciais contêm dados de chave privada e não são armazenadas no lado do servidor.

Esse método só pode ser chamado depois de Enterprises.Enroll ou Enterprises.CompleteSignup e antes de Enterprises.SetAccount. Em outros momentos, ele vai retornar um erro.

As chamadas subsequentes após a primeira vão gerar um novo conjunto exclusivo de credenciais e invalidar as credenciais geradas anteriormente.

Depois que a conta de serviço é vinculada à empresa, ela pode ser gerenciada usando o recurso serviceAccountKeys.

.
getStoreLayout
Retorna o layout da loja para a empresa. Se o layout da loja não tiver sido definido, vai retornar "basic" como o tipo de layout e nenhuma página inicial.
list
Pesquisa uma empresa pelo nome de domínio. Isso só é compatível com empresas criadas pelo fluxo de criação iniciado pelo Google. A pesquisa do ID não é necessária para empresas criadas pelo fluxo iniciado pelo EMM, já que o EMM aprende o ID da empresa no callback especificado na chamada "Enterprises.generateSignupUrl".
pullNotificationSet
Extrai e retorna um conjunto de notificações para as empresas associadas à conta de serviço autenticada para a solicitação. O conjunto de notificações pode estar vazio se não houver notificações pendentes.
Um conjunto de notificações retornado precisa ser confirmado em até 20 segundos chamando "Enterprises.AcknowledgeNotificationSet", a menos que o conjunto de notificações esteja vazio.
As notificações que não forem confirmadas em 20 segundos serão incluídas novamente na resposta a outra solicitação PullNotificationSet, e as que nunca forem confirmadas serão excluídas de acordo com a política do sistema Pub/Sub do Google Cloud Platform.
Várias solicitações podem ser feitas simultaneamente para recuperar notificações. Nesse caso, as notificações pendentes (se houver) serão divididas entre cada chamador, se houver alguma pendente.
Se não houver notificações, uma lista vazia será retornada. As solicitações subsequentes podem retornar mais notificações assim que elas ficarem disponíveis.
sendTestPushNotification
Envia uma notificação de teste para validar a integração do EMM com o serviço do Google Cloud Pub/Sub para esta empresa.
setAccount
Define a conta que será usada para autenticar na API como a empresa.
setStoreLayout
Define o layout da loja para a empresa. Por padrão, storeLayoutType é definido como "basic" e o layout básico da loja é ativado. O layout básico só contém apps aprovados pelo administrador e que foram adicionados ao conjunto de produtos disponíveis para um usuário (usando a chamada setAvailableProductSet). Os apps na página são classificados de acordo com o valor do ID do produto. Se você criar um layout de loja personalizado (definindo storeLayoutType = "custom" e uma página inicial), o layout básico será desativado.
unenroll
Cancela a inscrição de uma empresa no EMM de chamada.