Exibir o APIs Explorer e executar um método

Na maioria das páginas de documentação, um APIs Explorer condensado fica visível no lado direito da tela. Se o APIs Explorer não estiver visível, clique em Faça um teste para exibir a versão condensada do APIs Explorer.

Se o botão Testar não for exibido no lado direito de uma página de documentação de referência, o método não é compatível com o APIs Explorer. Por exemplo, o APIs Explorer não é compatível com APIs que exigem contas de serviço. Portanto, ele não aparece nas páginas de documentação dessas APIs.

Exibir a versão expandida do APIs Explorer

A versão expandida do APIs Explorer contém cURL, HTTP e possivelmente outras amostras de código. Para exibir a versão expandida do APIs Explorer, clique em Tela cheia .

Observação: para executar amostras de código, é preciso gerar e usar as próprias credenciais de autorização. Para uma explicação de como criar um projeto e gerar credenciais, consulte a documentação específica da API do Google.

Executar um método

Com o APIs Explorer, é possível inserir parâmetros obrigatórios, opcionais e, se aplicável, um corpo de solicitação para os métodos da API. Para muitos métodos REST, como métodos de lista, você só precisa preencher um ou dois campos antes de executar o método. Por exemplo, o método books.volumes.list da API Books exige apenas um parâmetro de consulta (q) para listar livros. Para testar o método books.volumes.list:

1. Acesse books.volumes.list.
2. Se o APIs Explorer não for exibido, clique em Faça um teste.
3. No campo q, digite Jogos Vorazes (sem aspas ou caracteres especiais).
4. Role para baixo e clique em Executar.
5. (Opcional) Uma tela de login do Google solicitará que você selecione uma Conta do Google.
6. (Opcional) Uma caixa de diálogo de autorização do Google pergunta se você pode gerenciar seus livros. Clique em Allow. Os resultados aparecem abaixo do botão "Executar".

Se o APIs Explorer mostrar um resultado de 200, o método foi bem-sucedido.

Observação: depois de permitir que a tela de autorização faça uma solicitação autorizada, o APIs Explorer está autorizado a fazer outras solicitações até que as credenciais expirem. Portanto, você não verá a tela de autorização para cada chamada de método subsequente. Para mais informações sobre credenciais, consulte Testar com tipos e escopos de credencial diferentes.

Resolver problemas do APIs Explorer

Você recebeu um erro 401 ou 403

Se você receber um erro 401 ou 403 ao executar um método usando o APIs Explorer, é provável que haja um problema com uma das seguintes opções:

• Você está usando o tipo de autorização incorreto (chave de API em vez de OAuth 2.0). Mude o tipo de autorização.
• Você está usando o OAuth 2.0, mas com um escopo muito restrito. Tente usar um escopo mais amplo.

A caixa de diálogo de autorização não é exibida

O APIs Explorer usa um pop-up para conceder acesso aos seus dados particulares. Se o navegador bloqueia pop-ups, ele não aparece, e você não pode conceder acesso.

Se você clicar em Permitir na caixa de diálogo de autorização e nada acontecer, tente alterar as configurações pop-up do seu navegador para ativar pop-ups.