Overview

The Google APIs Explorer is a tool available on most REST API method documentation pages that lets you try Google API methods without writing code. The APIs Explorer acts on real data, so use caution when trying methods that create, modify, or delete data.

Use the directory

For a list of Google APIs you can explore, browse the Google APIs Explorer Directory. This list contains links to the API reference documentation for supported APIs. Follow the steps below to explore the API:

  1. Open the Google APIs Explorer Directory.
  2. In the search box at the top, enter the name of the API you want to explore.
  3. Click the name of the API. This opens the API reference documentation.
  4. At the left, click the method you want to use in the navigation.

  5. At the right, find the panel labeled "Try this method." See below for details about how to use the APIs Explorer side panel and how to expand it into the full-screen APIs Explorer panel.

Use the side panel

APIs Explorer side panel for the Google Books API
Figure 1: APIs Explorer side panel for the Google Books API.

By default, the APIs Explorer appears on the right-hand side of the screen in API reference documentation for supported methods.

You can customize and interact with the following sections in the APIs Explorer side panel:

  • Request parameters, if required by the method.
  • Request body, if required by the method.
  • Credentials, to test the method with various credential types and scopes.
  • Execute button, to run the method using the parameters and settings you've specified.
  • Result, displayed only after executing the method.

Use the full-screen panel

APIs Explorer full-screen panel for the Google Books API
Figure 2: APIs Explorer full-screen panel for the Google Books API.

In the collapsed APIs Explorer side panel, you can click Full screen to expand the APIs Explorer. The full-screen panel displays an extra pane containing code samples, application/json responses, and Raw HTTP responses.

Authentication

The APIs Explorer uses its own credentials to make a request. You can't use custom credentials with the APIs Explorer.

Data formats

The APIs Explorer only supports JSON for responses and request payloads. Even if your API supports other data formats, these formats don't work in the APIs Explorer.

Next steps