Pesquisar e selecionar APIs do Google

1. Antes de começar

Este codelab mostra como pesquisar e selecionar APIs do Google e visualizar métricas de API.

Pré-requisitos

  • Capacidade de navegar no console do Google Cloud.

O que você vai aprender

O que é necessário

2. Acessar APIs no Console do Cloud

  1. No console do Cloud, selecione 5854836f11d5d97b.png Menu de navegação > APIs e serviços > APIs e serviços ativados.

O menu de navegação no console do Cloud mostrando

  1. No painel APIs e serviços, clique em + ATIVAR APIS E SERVIÇOS para conferir as APIs disponíveis.

O painel de APIs e serviços mostrando a opção "ATIVAR APIs E SERVIÇOS".

Na página APIs e serviços, há várias maneiras de pesquisar APIs. Se você souber o nome da API, insira-o no campo Pesquisar APIs e serviços na parte de cima da página. Também é possível filtrar as APIs por categoria com os filtros na lateral da página.

Uma lista de APIs resultante do campo "Pesquisar APIs e serviços".

  1. No menu CATEGORIA, selecione Machine learning para ver apenas as APIs de machine learning.

APIs filtradas por CATEGORIA para mostrar apenas APIs de machine learning.

  1. Nas APIs de machine learning, selecione API Cloud Natural Language para conferir detalhes sobre ela.
  2. Clique em ATIVAR para ativar a API no projeto adequado.

Painel da API Cloud Natural Language mostrando os botões "ATIVAR" e "TESTAR ESTA API".

Ao ativar a API, a página de visão geral dela é exibida. Você pode conferir as métricas de uso dessa API, que tem poucas informações porque você a ativou recentemente.

A página "Visão geral" da API selecionada mostrando as métricas dela.

Em um futuro codelab, você vai aprender a criar credenciais. Mas, se quiser saber agora, clique em CRIAR CREDENCIAIS e responda às perguntas apresentadas.

  1. Clique em GERENCIAR para voltar à visão geral da etapa anterior.

Página de visão geral da API Cloud Natural Language.

  1. Para testar a API (mesmo antes de ativá-la), clique em TESTAR ESTA API.

Isso geralmente leva a uma página na documentação da API. No entanto, para algumas APIs, não há uma maneira imediata de testar porque elas têm muitos métodos diferentes. É o caso da API Cloud Natural Language.

Página de referência da API Cloud Natural Language.

  1. Selecione o método analyzeEntitites.

Uma página da Web com detalhes sobre os métodos da API e um painel Testar esta API vai aparecer.

Página do método analyzeEntities mostrando os detalhes dele e um painel "Testar esta API".

  1. Para testar uma consulta de exemplo, adicione um objeto document ao campo Corpo da solicitação com estes parâmetros. Clique nos ícones + para expandir as opções de campo.
  2. No campo content:, digite o texto a ser analisado.

Este exemplo usa Michelangelo Caravaggio, Italian painter, is known for 'The Calling of Saint Matthew'.

  1. No campo type:, selecione PLAIN_TEXT.

O corpo da solicitação deve ficar assim:

Painel do corpo da solicitação mostrando os parâmetros do corpo da solicitação.

Para mais informações sobre cada parâmetro, consulte a documentação.

  1. Desmarque a caixa de seleção Google OAuth 2.0 e clique em Executar para receber uma resposta com detalhes sobre as entidades.

Resposta 200 com detalhes sobre as entidades.

  1. Desmarque a caixa de seleção Chave de API e clique em Executar novamente.

Ao executar a consulta desta vez, você vai receber um erro como este porque a API exige credenciais para ser executada.

Resposta 403 para solicitação sem credenciais.

  1. Marque a caixa de seleção Google OAuth 2.0 e clique em Executar novamente.

O OAuth 2.0 fornece as permissões de API na sua conta e mostra um aviso.

Aviso do OAuth 2.0 informando que o APIs Explorer do Google quer acessar sua Conta do Google.

Se você permitir o acesso, vai receber a mesma resposta que recebeu com as chaves de API. Se você usar a API em um app e precisar conceder acesso a pessoas com conhecimento das credenciais delas, use o OAuth 2.0. Se for suficiente que o app acesse a API para o usuário, use chaves de API.

3. Ver métricas da API com o Metrics Explorer

É possível conferir o histórico de chamadas de qualquer API na página "Visão geral da API", conforme mostrado na etapa 6 de "Acessar APIs no Console do Cloud". No entanto, para conferir mais métricas sobre todo o uso da API, use o Metrics Explorer.

  1. Na seção Operações do f6b6844bf5688982.png Menu de navegação, clique em Monitoring > Metrics explorer.

A seção "Operações" do menu de navegação mostrando as opções "Monitoring" e "Metrics Explorer" selecionadas.

  1. No menu Tipo de recurso, selecione API utilizada como o tipo de métrica. Se ela não aparecer, desmarque a caixa de seleção Mostrar apenas ativos.

ca850c4295ef4ec9.png

  1. No menu Métrica, selecione uma das métricas individuais para APIs, como Contagem de solicitações, para saber quantas APIs foram chamadas no período especificado.

Metrics Explorer mostrando métricas de APIs consumidas para contagem de solicitações.

  1. Para personalizar ainda mais a saída, defina um agregador e ajuste o período. O Metrics Explorer mostrando métricas de APIs consumidas para a contagem de solicitações com um agregador e um período especificados.

4. Use o OAuth 2.0 Playground para testar APIs

Você também pode usar o OAuth 2.0 Playground para testar as APIs do Google. Com o OAuth 2.0 Playground, você pode selecionar uma API, autorizá-la e enviar solicitações. As respostas aparecem na janela do console do OAuth 2.0 Playground.

  1. Abra o OAuth 2.0 Playground.

O OAuth 2.0 Playground mostrando uma lista de APIs que você pode testar.

  1. Clique em API Cloud Natural Language > https://www.googleapis.com/auth/cloud-language > https://www.googleapis.com/auth/cloud-platform > Autorizar APIs.

OAuth 2.0 Playground mostrando as APIs Cloud Natural Language selecionadas.

  1. Se necessário, faça login na sua Conta do Google e clique em Permitir para receber um código de autorização.
  2. Clique em Trocar código de autorização dos tokens.

Painel "Trocar código de autorização por tokens", em que você pode clicar em "Trocar código de autorização por tokens".

Agora você pode fazer uma solicitação da API.

  1. Clique em Listar operações possíveis para examinar todas as chamadas de API possíveis.

Você já abriu a página de informações do documento da API Natural Language analyzeEntities. Portanto, o URL da solicitação HTTP é:

https://language.googleapis.com/v1beta2/documents:analyzeEntities

Esta é uma solicitação POST.

Configure o painel "Solicitar à API", em que é possível selecionar o método HTTP, registrar o URI de solicitação, inserir o corpo da solicitação e enviar a solicitação.

  1. Insira as informações do URI de solicitação e adicione um corpo da solicitação.

Você pode usar o mesmo corpo usado no API Explorer.

Painel do corpo da solicitação.

  1. Clique em Fechar > Enviar o pedido.

Os resultados serão semelhantes a esta imagem:

Painel de solicitação/resposta do OAuth 2.0 após postar a solicitação.

Teste outras APIs no OAuth 2.0 Playground.

5. Limpar

É uma prática ruim ter uma chave de API irrestrita para projetos. Se alguém tiver acesso a ele, poderá usá-lo sem precisar de mais autenticação.

Para excluir essa chave de API:

  1. Clique em f6b6844bf5688982.png Menu de navegação > APIs e serviços > Credenciais.
  2. Em Chaves de API, selecione a chave que você quer excluir e clique em 247adf2e1d1eae4b.png.
  3. Da mesma forma, em vez de se preocupar com a falta de proteção da chave privada da conta de serviço, em Contas de serviço, selecione a conta que você quer excluir e clique em 247adf2e1d1eae4b.png.

6. Parabéns

Parabéns! Você aprendeu a pesquisar e selecionar APIs do Google e a visualizar as métricas delas.