Configuração inicial

Configuração para um desenvolvedor

Ativar o pacote de APIs para o projeto na nuvem

  • Acesse o console do Cloud: https://console.cloud.google.com/.
  • Selecione um projeto na nuvem ou crie um novo.
  • Acesse APIs & Services > Enable APIs and Services.
  • Pesquise "Chrome".
  • Selecione "API Chrome Management".
  • Familiarize-se com os Termos de Serviço.
  • Clique em Enable.

Criar credenciais

Alternativa 1: IDs do cliente OAuth 2.0

  • Antes de criar um "ID do cliente OAuth 2.0", você precisa configurar a tela de permissão OAuth com informações sobre seu aplicativo. No console do Cloud, acesse APIs & Services > OAuth consent screen.
  • Na página de configuração da tela de consentimento, insira os escopos:

    • Para adicionar a API Reports: https://www.googleapis.com/auth/chrome.management.reports.readonly
    • Para a API App Details, adicione: https://www.googleapis.com/auth/chrome.management.appdetails.readonly
    • Para a API Telemetry, adicione: https://www.googleapis.com/auth/chrome.management.telemetry.readonly

    Observe que os escopos adicionados são confidenciais, portanto, talvez seja necessário enviar seu aplicativo para verificação. Caso contrário, os usuários poderão ver uma tela de aviso de segurança se o app não for interno.

  • Acesse APIs & Services > Credentials > Create Credentials > OAuth client ID e siga as etapas para criar as credenciais.

  • Também é possível testar seu app no OAuth Playground (consulte Instruções).

Alternativa 2: conta de serviço

  • Acesse APIs & Services > Credentials > Create Credentials > Service account.
  • Digite o nome da conta de serviço e clique em Create.
  • Crie uma chave para a conta de serviço. Clique em Add Key e crie a chave "json". Salve o arquivo em um local seguro.
  • Use sua conta de serviço com os privilégios de administrador adequados para o cliente:
    • O Cliente pode configurar a delegação em todo o domínio e a conta de serviço pode personificar um usuário/administrador com os privilégios adequados. Saiba como fazer isso.
    • O cliente também pode conceder uma função de administrador com os privilégios apropriados diretamente à conta de serviço. Saiba como fazer isso.

Configuração para um cliente

Dependendo do tipo de aplicativo criado pelo desenvolvedor, o administrador do cliente tem diferentes opções de configuração.

Apps de "cliente OAuth 2.0"

Nenhuma configuração especial é necessária.

Os usuários de apps precisam de privilégios de administrador adequados. Saiba como fazer isso.

Os usuários do app precisam concordar com a tela de consentimento do pop-up de OAuth do app. Você também pode permitir que esse aplicativo use a delegação em todo o domínio (veja como), que omite a tela de consentimento pop-up do OAuth para os usuários.

Como opção, verifique se o app não está bloqueado ou confie nele explicitamente. Saiba como fazer isso.

Apps de "conta de serviço"

A conta de serviço precisa receber os privilégios de administrador adequados. Isso pode ser feito de duas maneiras:

  • Permita a delegação em todo o domínio para que a conta de serviço possa representar um administrador com os privilégios adequados. Saiba como fazer isso.
  • Conceda papéis de administrador diretamente para a conta de serviço. Saiba como fazer isso.

Guias de instruções

Como bloquear ou confiar em um app

  • Como administrador do cliente, acesse o Admin Console (https://admin.google.com/).
  • Navegue para Security > Access and data control > API controls.
  • Na seção App access control, clique em Manage third party app access.
  • Se você não encontrar o app na lista "Apps conectados", configure um novo.
  • Agora você pode bloquear o app ou confiar nele explicitamente.

Como ativar a delegação em todo o domínio

  • Como administrador do cliente, acesse o Admin Console (https://admin.google.com/).
  • Navegue para Security > Access and data control > API controls > Domain-wide delegation.
  • Clique em Add new.
  • Insira o ID do cliente ("ID exclusivo da conta de serviço" ou "ID do cliente do app").
  • Insira todos os escopos do OAuth necessários. Dependendo do app, talvez seja necessário inserir escopos não apenas para a API Chrome Management, por exemplo, a API Directory para gerenciar dispositivos, usuários, navegadores, unidades organizacionais, grupos etc.
  • Clique em Authorize.

Como gerenciar privilégios de administrador

Para diferentes partes das APIs de gerenciamento do Chrome, são necessários privilégios de administrador distintos. Confira quais privilégios de administrador são necessários para a API Reports, a API App Details ou a API Telemetry.

Para conceder privilégios:

  • Como administrador do cliente, acesse o Admin Console (https://admin.google.com/).
  • Navegar para a página Admin roles.
  • Encontre uma função ou crie uma com os privilégios necessários.
  • Atribua esse papel ao endereço de e-mail do usuário ou da conta de serviço.

Como testar seu app no OAuth Playground

  • No console do Cloud, ao criar um ID do cliente OAuth para seu app (consulte a seção IDs do cliente OAuth 2.0 acima), selecione o tipo de aplicativo "Aplicativos da Web".
  • Insira um "Nome".
  • Para testar o app, adicione https://developers.google.com/oauthplayground ao campo "URIs de redirecionamento autorizados". Você pode remover o URI de redirecionamento do seu app quando concluir os testes.
  • Clique em Create e copie o "ID do cliente" e a "chave secreta do cliente".
  • Acesse o OAuth Playground.
  • Clique no ícone de engrenagem no canto superior direito ("Configuração do OAuth 2.0"), selecione Use your own OAuth credentials e insira "ID do cliente OAuth" e "Chave secreta do cliente OAuth".
  • Siga estas etapas no OAuth Playground

    • Selecionar e autorizar APIs.

      Adicione https://www.googleapis.com/auth/chrome.management.reports.readonly (ou outro escopo de API) ao campo de entrada do escopo e clique em "Autorizar APIs". Autorize o uso de uma conta de administrador do cliente. Concorde com os termos.

    • Troque o código de autorização por tokens.

      Clique em Exchange authorization code for tokens. Se quiser, clique em Auto-refresh the token before it expires.

    • Configure a solicitação para a API.

      Insira o URL da API na caixa de texto "Solicitar URI". Modifique "HTTP Method", "Enter request body" etc. de acordo com a especificação da API. Por exemplo, use o seguinte URL para contar os apps instalados na sua organização: https://chromemanagement.googleapis.com/v1alpha1/customers/my_customer/reports:countInstalledApps