Stay organized with collections
Save and categorize content based on your preferences.
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:
In the search box at the top, enter the name of the API you want to explore.
Click the name of the API. This opens the API reference documentation.
At the left, click the method you want to use in the navigation.
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
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
Figure 2: APIs Explorer full-screen panel for the Google Books API.
In the collapsed APIs Explorer side panel, you can click Full screen
fullscreen 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.
[null,null,["Last updated 2023-10-03 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)."]]
