Configuração inicial
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
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
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-07-25 UTC.
[null,null,["Última atualização 2025-07-25 UTC."],[[["\u003cp\u003eDevelopers need to enable the Chrome Management API, create credentials (OAuth or Service Account), and understand setup options for customer admins.\u003c/p\u003e\n"],["\u003cp\u003eCustomer admins need to configure settings based on the developer's application type, potentially granting privileges or enabling domain-wide delegation.\u003c/p\u003e\n"],["\u003cp\u003e"How to" guides provide detailed instructions for blocking/trusting apps, enabling domain-wide delegation, managing admin privileges, and testing in OAuth Playground.\u003c/p\u003e\n"],["\u003cp\u003eDifferent Chrome Management APIs require specific admin privileges, and detailed information is available in their respective guides.\u003c/p\u003e\n"],["\u003cp\u003eOAuth 2.0 Client apps need user consent or Domain-Wide Delegation, while Service Account apps require explicit admin privilege grants.\u003c/p\u003e\n"]]],[],null,["# Initial Setup\n\nSetup for a developer\n---------------------\n\n### Enable API suite for cloud project\n\n- Navigate to Cloud Console: \u003chttps://console.cloud.google.com/\u003e.\n- Select existing cloud project or create a new one.\n- Go to `APIs & Services \u003e Enable APIs and Services`.\n- Search for \"Chrome\".\n- Select \"Chrome Management API\".\n- Familiarize yourself with Terms of Service.\n- Click `Enable`.\n\n### Create Credentials\n\n#### Alternative 1: OAuth 2.0 Client IDs\n\n- Before you are able to create \"OAuth 2.0 Client ID\" you need to first configure the OAuth consent screen with information about your application. In Cloud Console, go to `APIs & Services \u003e OAuth consent screen`.\n- In your consent screen config page, enter the scopes:\n\n - For Reports API add: `https://www.googleapis.com/auth/chrome.management.reports.readonly`\n - For App Details API add: `https://www.googleapis.com/auth/chrome.management.appdetails.readonly`\n - For Telemetry API add: `https://www.googleapis.com/auth/chrome.management.telemetry.readonly`\n\n Note that added scopes are sensitive, so you may need to submit your app for verification. Otherwise, users may see a security warning screen if your app is not internal.\n- Go to `APIs & Services \u003e Credentials \u003e Create Credentials \u003e OAuth client ID` and follow the steps to create the credentials.\n\n- Optionally, test your app in OAuth Playground (see [How to](#how_to_test_your_app_in_oauth_playground)).\n\n#### Alternative 2: Service Account\n\n- Go to `APIs & Services \u003e Credentials \u003e Create Credentials \u003e Service account`.\n- Enter service account name and click `Create`.\n- Create a key for your service account. Click `Add Key` and create \"json\" key. Keep track of the file in a secure location.\n- Use your service account with proper admin privileges for customer:\n - Customer may set up Domain-Wide Delegation and then the service account can impersonate a user/admin who has proper privileges (see [how](#how_to_enable_domain-wide_delegation))\n - or customer may grant an admin role with proper privileges to the service account directly (see [how](#how_to_manage_admin_privileges)).\n\nSetup for a customer\n--------------------\n\nDepending on which application type the developer created, the customer admin has different setup options.\n\n#### \"OAuth 2.0 Client\" Apps\n\nNo special setup is needed.\n\nApp users require proper admin privileges (see [how](#how_to_manage_admin_privileges)).\n\nApp users need to agree to the app OAuth pop-up consent screen.\nOptionally, you can allow this app to use Domain-Wide Delegation (see [how](#how_to_enable_domain-wide_delegation)), which will omit the OAuth pop-up consent screen for users.\n\nOptionally verify if the app isn't blocked, or trust the app explicitly (see [how](#how_to_block_or_trust_an_app)).\n\n#### \"Service Account\" Apps\n\nThe service account must be granted proper admin privileges.\nYou can do this in either of two ways:\n\n- Allow Domain-Wide Delegation so the Service Account can impersonate an admin that has proper privileges (see [how](#how_to_enable_domain-wide_delegation)).\n- Grant Admin Roles for the service account directly (see [how](#how_to_manage_admin_privileges)).\n\n\"How to\" guides\n---------------\n\n### How to block or trust an app\n\n- As customer admin, go to Admin Console (https://admin.google.com/).\n- Navigate to `Security \u003e Access and data control \u003e API controls`.\n- In the `App access control` section, click `Manage third party app access`.\n- If you don't see the app in the 'Connected apps' list, you can configure a new app.\n- You can now block the app or trust the app explicitly.\n\n### How to enable domain-wide delegation\n\n- As customer admin, go to Admin Console (https://admin.google.com/).\n- Navigate to `Security \u003e Access and data control \u003e API controls \u003e Domain-wide delegation`.\n- Click `Add new`.\n- Enter client ID (\"service account unique id\" or \"app client ID\").\n- Enter all necessary OAuth scopes. Depending on the app, you may need to enter scopes for more than just Chrome Management API; e.g. the Directory API for managing devices, users, browsers, OUs, groups, etc.\n- Click `Authorize`.\n\n### How to manage admin privileges\n\nFor different portions of the Chrome Management APIs, different admin privileges\nare needed. See which admin privileges are required for\n[Reports API](/chrome/management/guides/reports_api),\n[App Details API](/chrome/management/guides/app_details_api), or\n[Telemetry API](/chrome/management/guides/telemetry_api).\n\nTo grant privileges:\n\n- As customer admin, go to Admin Console (https://admin.google.com/).\n- Navigate to `Admin roles` page.\n- Find an existing role or create a new role with the necessary privileges.\n- Assign this role to the user email address or the service account email address.\n\n### How to test your app in OAuth Playground\n\n- In Cloud Console, when creating an OAuth client ID for your app (see above [OAuth 2.0 Client IDs](/chrome/management/guides/setup#alternative_1_oauth_20_client_ids) section) select application type \"Web Applications\".\n- Enter a 'Name'.\n- To test your app, add `https://developers.google.com/oauthplayground` to the \"Authorized redirect URIs\" field. You can remove the redirect URI from your app when you're done testing.\n- Click `Create` and copy \"client ID\" and \"client secret\".\n- Go to [OAuth Playground](https://developers.google.com/oauthplayground/)\n- Click the gear icon in the top right corner ('OAuth 2.0 Configuration'), select `Use your own OAuth credentials`, and enter \"OAuth Client ID\" and \"OAuth Client secret\".\n- Follow these steps in OAuth Playground\n\n - Select \\& authorize APIs.\n\n Add `https://www.googleapis.com/auth/chrome.management.reports.readonly` (or other api scope) in the scope input field and click 'Authorize APIs'.\n Authorize using a customer admin account. Agree to the terms.\n - Exchange authorization code for tokens.\n\n Click `Exchange authorization code for tokens`. Optionally, click `Auto-refresh the token before it expires`.\n - Configure request to API.\n\n Enter your API URL in the 'Request URI' text box. Modify 'HTTP Method', 'Enter request body', etc. as per the API specification.\n For example, use the following URL to count the installed Apps in your organization: `https://chromemanagement.googleapis.com/v1alpha1/customers/my_customer/reports:countInstalledApps`"]]
