API Looker Studio

A API Looker Studio permite pesquisar e gerenciar recursos do Looker Studio.

O principal caso de uso da API é permitir que as organizações do Google Workspace ou do Cloud Identity automatizam o gerenciamento e a migração de recursos do Looker Studio.

Importante: a API está disponível apenas para usuários de uma organização que usa o Google Workspace ou o Cloud Identity.

Visão geral dos requisitos

As etapas a seguir são necessárias para usar a API Looker Studio:

1. Configurar um app para usar a API
2. Usar o Google Admin Console para autorizar o app
3. Conseguir tokens de acesso do OAuth 2.0 e chamar a API

As etapas acima podem ser executadas pelas mesmas organizações ou outras com base nos cenários comuns a seguir:

• Apps internos desenvolvidos para uma organização. A organização configura e autoriza o app para todos os usuários dela.
• Apps de terceiros desenvolvidos para usuários/clientes externos (ou seja, o desenvolvedor e os usuários não são da mesma organização). O desenvolvedor configura o app, mas a organização do usuário autoriza o app de terceiros.

1. Configurar um app para usar a API

Siga estas etapas para configurar o app:

• Ativar a API
• Criar um cliente OAuth

Ativar a API

Para ativar uma API para um projeto, faça o seguinte:

1. Abra a API Looker Studio no Console de APIs do Google.
2. Se for solicitado, selecione um projeto ou crie um novo.
3. Clique em Ativar.
4. Se for solicitado, leia e aceite os Termos de Serviço da API.

Criar um cliente OAuth

As etapas a seguir para criar um cliente OAuth são diretrizes gerais e precisam ser ajustadas para atender aos requisitos do seu app.

Importante: não adicione escopos do Looker Studio ao seu cliente OAuth. Os escopos serão adicionados pelo administrador do Workspace quando ele autorizar o app.

1. Navegue até Configurar a tela de consentimento OAuth.
   1. Escolha Interno e clique em Criar.
   2. Preencha os campos obrigatórios e clique em Salvar.
2. Acesse Credenciais.
   1. Clique em CRIAR CREDENCIAIS.
   2. Selecione ID do cliente OAuth.
   3. Escolha o Application Type apropriado "Aplicativo da Web" é o mais comum.
   4. Preencha os campos obrigatórios e clique em Criar.
3. Anote o ID do cliente, porque ele é usado para autorizar o app.

2. Autorizar o app para uma organização

Os apps que usam a API Looker Studio só podem autenticar e autorizar usuários do Google Workspace em que a organização do usuário tenha autorizado o app usando a delegação em todo o domínio para controlar o acesso à API.

Configure a delegação em todo o domínio com o ID do cliente do OAuth do app e os escopos exigidos pelo aplicativo.

Importante: as etapas a seguir precisam ser concluídas por um administrador do Workspace. O administrador precisa do ID do cliente OAuth do app e de uma lista de escopos do OAuth exigidos pelo app.

1. Faça login no Google Admin Console e navegue até a delegação em todo o domínio.
2. Em API clients, clique em Adicionar novo.
3. Digite o Client ID do app a ser autorizado, ou seja, o app que usa a API Looker Studio.
4. Insira todos os escopos do OAuth exigidos pelo app. Os escopos a seguir são normalmente solicitados se você usar a API Looker Studio para gerenciar recursos:
   • https://www.googleapis.com/auth/datastudio
   • https://www.googleapis.com/auth/userinfo.profile
5. Clique em Autorizar.

Observação: se o app não precisar gerenciar recursos do Looker Studio, use o escopo https://www.googleapis.com/auth/datastudio.readonly mais restritivo em vez de https://www.googleapis.com/auth/datastudio.

Depois de autorizar o aplicativo, qualquer usuário do Google Workspace pertencente à organização será automaticamente autorizado a usar o aplicativo com a API Looker Studio.

3. Como conseguir tokens de acesso do OAuth 2.0 e chamar a API

Depois de desenvolver e autorizar o app, você vai ter o acesso necessário para chamar a API para os usuários do Google Workspace. Consulte Como usar o OAuth 2.0 para acessar as APIs do Google se quiser ver detalhes de como trabalhar com as APIs do Google usando o OAuth. Consulte a referência da API para ver as operações disponíveis.

Solução de problemas

A caixa de diálogo OAuth está faltando

Se a organização de um usuário autorizou o app, os usuários dessa organização não veem a caixa de diálogo do OAuth ao autorizar o app. A única exceção é se o app pedir permissão para escopos adicionais da API do Google que o administrador do Google Workspace não configurou. Nesse caso, a caixa de diálogo do OAuth é mostrada aos usuários.

Erro 400: invalid_scope

Se um usuário receber uma mensagem Error 400: invalid_scope ao tentar autorizar o app, a organização dele não autorizou o app ou fez isso de forma incorreta. Para resolver o problema, o usuário precisa pedir que a organização autorize o app.