Stay organized with collections
Save and categorize content based on your preferences.
On most documentation pages, a condensed APIs Explorer is visible on the
right-hand side of the screen. If the APIs Explorer isn't visible, click
Try it! to display the condensed version of the APIs Explorer.
If Try it! doesn't appear on the right-hand side of a reference
documentation page, the method isn't supported by the APIs Explorer. For
example, the APIs Explorer isn't compatible with APIs that require service
accounts, so it doesn't appear on documentation pages for those APIs.
Display the expanded version of the APIs Explorer
The expanded version of the APIs Explorer contains cURL, HTTP, and possibly
other code samples. To display the expanded version of the APIs Explorer,
click Full screen fullscreen.
Execute a method
The APIs Explorer lets you enter required parameters, optional parameters,
and, if applicable, a request body for API methods. For many REST methods,
such as list methods, you only need to fill one or two fields before you can
execute the method. For example, the Books API's
books.volumes.list
method only requires a query parameter (q) to list books. To try the
books.volumes.list
method:
If the APIs Explorer isn't displayed, click Try it!
In the q field, type Hunger Games (without any quotes or special
characters).
Scroll down and click Execute.
(optional) A Google sign-in screen asks you to select a Google account.
(optional) A Google authorization dialog asks you if it's okay to
"Manage your books." Click Allow. The results appear below the Execute button.
If the APIs Explorer shows a result of 200, then the method was successful.
Troubleshoot APIs Explorer issues
You received a 401 or 403 error
If you're getting a 401 or 403 error when executing a method using the APIs
Explorer, it is likely due to a problem with one of the following:
You're using the wrong authorization type (API key instead of OAuth 2.0).
Try switching the authorization type.
You're using OAuth 2.0, but with too narrow a scope. Try using a broader
scope.
Authorization dialog doesn't appear
The APIs Explorer uses a popup to grant access to your private data. If your
browser blocks popups, this popup won't appear and you won't be able to grant
access.
If you click Allow in the authorization dialog and nothing happens, try
changing your browser's popup settings to enable popups.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2023-10-03 UTC."],[[["\u003cp\u003eThe APIs Explorer allows you to test API methods directly in the documentation by providing parameters and executing requests.\u003c/p\u003e\n"],["\u003cp\u003eTo use the APIs Explorer with methods requiring authorization, you need to generate and use your own credentials.\u003c/p\u003e\n"],["\u003cp\u003eThe expanded APIs Explorer provides code samples in various formats like cURL and HTTP for easier integration.\u003c/p\u003e\n"],["\u003cp\u003eIf you encounter a 401 or 403 error, verify the authorization type and scope, as they are the most common causes.\u003c/p\u003e\n"],["\u003cp\u003eThe APIs Explorer uses popups for authorization, so ensure your browser settings allow them to function correctly.\u003c/p\u003e\n"]]],[],null,["On most documentation pages, a condensed APIs Explorer is visible on the\nright-hand side of the screen. If the APIs Explorer isn't visible, click\n**Try it!** to display the condensed version of the APIs Explorer.\n\nIf **Try it!** doesn't appear on the right-hand side of a reference\ndocumentation page, the method isn't supported by the APIs Explorer. For\nexample, the APIs Explorer isn't compatible with APIs that require service\naccounts, so it doesn't appear on documentation pages for those APIs.\n\nDisplay the expanded version of the APIs Explorer\n\nThe expanded version of the APIs Explorer contains cURL, HTTP, and possibly\nother code samples. To display the expanded version of the APIs Explorer,\nclick Full screen fullscreen.\n| **Note:** To run the code samples, you must generate and use your own authorization credentials. For an explanation of how to create a project and generate credentials, refer to your specific Google API's documentation.\n\nExecute a method\n\nThe APIs Explorer lets you enter required parameters, optional parameters,\nand, if applicable, a request body for API methods. For many REST methods,\nsuch as list methods, you only need to fill one or two fields before you can\nexecute the method. For example, the Books API's\n[`books.volumes.list`](/books/docs/v1/reference/volumes/list)\nmethod only requires a query parameter (`q`) to list books. To try the\n[`books.volumes.list`](/books/docs/v1/reference/volumes/list)\nmethod:\n\n1. Navigate to [`books.volumes.list`](/books/docs/v1/reference/volumes/list).\n2. If the APIs Explorer isn't displayed, click **Try it!**\n3. In the **`q`** field, type *Hunger Games* (without any quotes or special characters).\n4. Scroll down and click **Execute**.\n5. (optional) A Google sign-in screen asks you to select a Google account.\n6. (optional) A Google authorization dialog asks you if it's okay to \"Manage your books.\" Click *Allow*. The results appear below the Execute button.\n\nIf the APIs Explorer shows a result of 200, then the method was successful.\n| **Note:** After you allow the authorization screen to make an authorized request, the APIs Explorer is authorized to make other requests until the credentials expire. Therefore, you don't see the authorization screen for every subsequent method call. For further information on credentials, see [Test with different credential types and scopes](/explorer-help/authorization-and-authentication).\n\nTroubleshoot APIs Explorer issues\n\nYou received a 401 or 403 error\n\nIf you're getting a 401 or 403 error when executing a method using the APIs\nExplorer, it is likely due to a problem with one of the following:\n\n- You're using the wrong authorization type (API key instead of OAuth 2.0). Try switching the authorization type.\n- You're using OAuth 2.0, but with too narrow a scope. Try using a broader scope.\n\nAuthorization dialog doesn't appear\n\nThe APIs Explorer uses a popup to grant access to your private data. If your\nbrowser blocks popups, this popup won't appear and you won't be able to grant\naccess.\n\nIf you click **Allow** in the authorization dialog and nothing happens, try\nchanging your browser's popup settings to enable popups."]]