Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
O APIs Explorer do Google é uma ferramenta disponível na maioria das páginas de documentação de métodos da API REST que permite testar os métodos da API do Google sem escrever código.
O APIs Explorer funciona com dados reais. Por isso, tenha cuidado ao testar métodos que
criam, modificam ou excluem dados.
Usar o diretório
Para ver uma lista das APIs do Google que você pode explorar, procure no
Diretório de APIs Explorer do Google. Essa lista contém links para
a documentação de referência da API das APIs compatíveis. Siga as etapas abaixo para explorar a API:
Na caixa de pesquisa na parte superior, digite o nome da API que você quer explorar.
Clique no nome da API. A documentação de referência da API será aberta.
À esquerda, clique no método que você quer usar na navegação.
À direita, localize o painel chamado "quot;Teste este método"." Veja abaixo detalhes sobre como usar o painel lateral do APIs Explorer e como expandi-lo para o painel do APIs Explorer em tela cheia.
Usar o painel lateral
Figura 1: painel lateral do APIs Explorer para a API Google Books.
Por padrão, o APIs Explorer aparece no lado direito da tela na
documentação de referência da API para métodos compatíveis.
É possível personalizar e interagir com as seguintes seções no painel lateral do APIs Explorer:
Parâmetros de solicitação, se exigidos pelo método.
Corpo da solicitação, se exigido pelo método.
Credenciais, para testar o método com vários tipos de escopos e tipos de credenciais.
Execute para executar o método usando os parâmetros e as configurações que você especificou.
Resultado, exibido somente após a execução do método.
Usar o painel em tela cheia
Figura 2: painel em tela cheia do APIs Explorer para a API Google Books.
No painel lateral recolhido do APIs Explorer, clique em Tela cheia fullscreen para expandir o APIs Explorer. O
painel em tela cheia exibe um painel extra que contém amostras de código,
respostas application/json e respostas HTTP brutas.
Autenticação
O APIs Explorer usa as próprias credenciais para fazer uma solicitação. Não é possível usar credenciais personalizadas com o APIs Explorer.
Formatos de dados
O APIs Explorer é compatível apenas com JSON de respostas e payloads de solicitações. Mesmo que sua API seja compatível com outros formatos de dados, esses formatos não funcionam no APIs Explorer.
[null,null,["Última atualização 2022-11-01 UTC."],[[["\u003cp\u003eGoogle APIs Explorer allows you to experiment with Google API methods directly without coding, using real data.\u003c/p\u003e\n"],["\u003cp\u003eYou can find the desired API through the Google APIs Explorer Directory and navigate to its documentation to access the Explorer.\u003c/p\u003e\n"],["\u003cp\u003eThe Explorer provides an interface to input parameters, request bodies, and credentials for executing the API method and viewing results.\u003c/p\u003e\n"],["\u003cp\u003eWhile the Explorer uses its own credentials, it offers both side-panel and full-screen views with functionalities like code samples and response formats in JSON.\u003c/p\u003e\n"],["\u003cp\u003eRemember to exercise caution when using methods that modify data, as the Explorer operates on live data.\u003c/p\u003e\n"]]],[],null,["# Overview\n\nThe Google APIs Explorer is a tool available on most REST API method\ndocumentation pages that lets you try Google API methods without writing code.\nThe APIs Explorer acts on real data, so use caution when trying methods that\ncreate, modify, or delete data.\n\nUse the directory\n-----------------\n\nFor a list of Google APIs you can explore, browse the\n[Google APIs Explorer Directory](/apis-explorer). This list contains links to\nthe API reference documentation for supported APIs. Follow the steps below to\nexplore the API:\n\n1. Open the [Google APIs Explorer Directory](/apis-explorer).\n2. In the search box at the top, enter the name of the API you want to explore.\n3. Click the name of the API. This opens the API reference documentation.\n4. At the left, click the method you want to use in the navigation.\n5. At the right, find the panel labeled \"Try this method.\" See below for details\n about how to use the APIs Explorer side panel and how to expand it into the\n full-screen APIs Explorer panel.\n\n | **Note:** If you don't see the APIs Explorer side panel, the method might not be compatible with APIs Explorer.\n\nUse the side panel\n------------------\n\n**Figure 1**: APIs Explorer side panel for the Google Books API.\n\nBy default, the APIs Explorer appears on the right-hand side of the screen in\nAPI reference documentation for supported methods.\n\nYou can customize and interact with the following sections in the APIs Explorer\nside panel:\n\n- **Request parameters**, if required by the method.\n- **Request body**, if required by the method.\n- **Credentials**, to test the method with various credential types and scopes.\n- **Execute** button, to run the method using the parameters and settings you've specified.\n- **Result**, displayed only after executing the method.\n\nUse the full-screen panel\n-------------------------\n\n**Figure 2**: APIs Explorer full-screen panel for the Google Books API.\n\nIn the collapsed APIs Explorer side panel, you can click Full screen\nfullscreen to expand the APIs Explorer. The\nfull-screen panel displays an extra pane containing code samples,\n`application/json` responses, and Raw HTTP responses.\n\nAuthentication\n--------------\n\nThe APIs Explorer uses its own credentials to make a request. You can't use\ncustom credentials with the APIs Explorer.\n\nData formats\n------------\n\nThe APIs Explorer only supports JSON for responses and request payloads. Even if\nyour API supports other data formats, these formats don't work in the\nAPIs Explorer.\n\nNext steps\n----------\n\n- Learn how to [display the APIs Explorer and execute a method](/explorer-help/execute-method).\n- Learn how to [test a method using different credentials and scopes](/explorer-help/authorization-and-authentication).\n- Learn how to [execute APIs Explorer sample code locally](/explorer-help/code-samples)."]]
