Para ver uma lista de métodos desse recurso, consulte o final desta página.
Representações de recursos
O 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 a API, desta forma:
- Para clientes de domínio gerenciado do Google, o processo envolve o uso de
Enterprises.enroll
eEnterprises.setAccount
(com artefatos do Admin Console e do Console de APIs do Google) e enviados ao EMM por um processo manual maior ou menor. - Para clientes de contas do Google Play gerenciado, o processo envolve o uso de
Enterprises.generateSignupUrl
eEnterprises.completeSignup
com a interface de inscrição do Google Play gerenciado (mecanismo fornecido pelo Google) para criar a vinculação sem etapas manuais.
{ "kind": "androidenterprise#enterprise", "id": string, "primaryDomain": string, "name": string, "administrator": [ { "email": string } ] }
Nome da propriedade | Valor | Descrição | Observações |
---|---|---|---|
administrator[] |
list |
Administradores da empresa. Essa opção só é possível para empresas criadas pelo fluxo iniciado pelo EMM. |
|
administrator[].email |
string |
O endereço de e-mail do administrador. | |
id |
string |
O ID exclusivo da empresa. |
|
kind |
string |
||
name |
string |
O nome da empresa, por exemplo, "Example, Inc". | |
primaryDomain |
string |
O domínio principal da empresa, como "example.com". |
Métodos
- acknowledgeNotificationSet
- Reconhece as notificações recebidas de Enterprises.PullNotificationSet para evitar que chamadas subsequentes retornem as mesmas notificações.
- completeSignup
- Completa o fluxo de inscrição especificando os tokens de conclusão e de empresa. Esta solicitação não pode ser chamada várias vezes para um determinado token do Enterprise.
- 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 de interface. Consulte a documentação da API JavaScript para mais informações.
- inscrever-se
- Registra uma empresa no EMM de chamada.
- 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 para essa empresa e para o EMM e será excluída se a empresa
estiver desvinculada. As credenciais contêm dados da chave privada e não são armazenadas
no lado do servidor.
Esse método só pode ser chamado depois de chamar Enterprises.enroll ou Enterprises.CompleteEnrollment e antes de Enterprises.SetAccount. Outras vezes, ele retorna um erro.
As chamadas seguintes após a primeira vão gerar um novo conjunto exclusivo de credenciais e invalidar as que foram geradas anteriormente.
Quando a conta de serviço estiver vinculada à empresa, ela poderá ser gerenciada usando o recurso serviceAccountKeys. - getStoreLayout
- Retorna o layout da loja da empresa. Se o layout da loja não tiver sido definido, será retornado "básico" como o tipo de layout da loja e nenhuma página inicial.
- list
- Procura uma empresa pelo nome de domínio. Isso só é possível para empresas criadas pelo fluxo de criação iniciado pelo Google. A pesquisa do ID não é necessária para empresas criadas pelo fluxo iniciado por EMM porque ele aprende o ID empresarial no callback especificado na chamada Enterprises.generateEnrollmentUrl.
- pullNotificationSet
- Extrai e retorna uma notificação definida para as empresas associadas à
conta de serviço autenticada para a solicitação. O conjunto de notificações poderá
estar vazio se nenhuma notificação estiver pendente.
Um conjunto de notificações retornado precisa ser confirmado em 20 segundos chamando Enterprises.RecognitionNotificationSet, 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 aquelas 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 realizadas ao mesmo tempo para extrair notificações. Nesse caso, as notificações pendentes (se houver) serão divididas entre cada autor da chamada, se houver alguma pendente.
Se nenhuma notificação estiver presente, uma lista de notificações vazia será retornada. As solicitações seguintes poderão retornar mais notificações assim que estiverem 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 a empresa.
- setAccount
- Define a conta que será usada para autenticação na API como a empresa.
- setStoreLayout
- Define o layout da loja para a empresa. Por padrão, storeLayoutType é definida como "básica" e o layout de armazenamento básico é ativado. O layout básico contém apenas apps aprovados pelo administrador e que foram adicionados ao conjunto de produtos disponível para um usuário (usando a chamada setAvailableProductSet). Os aplicativos na página são classificados em ordem de valor de ID do produto. Se você criar um layout de loja personalizado (definindo storeLayoutType = "custom" e definindo uma página inicial), o layout de armazenamento básico será desativado.
- cancelar inscrição
- Cancela a inscrição de uma empresa no EMM de chamada.