Search API Connector Documentation
Create a Custom Request
In this article, we'll walk through how to create a custom request using the API Connector add-on for Google Sheets.
If you like videos, check out this video guide to using API Connector.
- Before You Begin
- Step 1: Open the Sidebar
- Step 2: Add a New Request
- Step 3: Choose Custom Application
- Step 4: Enter a Request URL
- Step 5: Set a Destination Sheet
- Step 6: Choose Output Options
- Step 7: Edit Fields
- Step 8: Name and Run
Before You Begin
Click here to install the API Connector add-on from the Google Marketplace.
Step 1: Open the Sidebar
Step 2: Add a New Request
Once the sidebar opens, click Create request to start a new request.
Step 3: Choose Custom Application
Make sure Custom is selected in the Application menu.
Step 4: Enter a Request URL
Enter a request URL. Available request URLs should be provided by your application's API documentation. For example, enter this URL to fetch data about Radiohead from the iTunes API:
Each application's API documentation will also tell you whether authentication is required, and, if so, how to apply it. Typically authentication is applied by including a query string parameter in the URL, including a key-value pair as a header, or by logging into the target site (i.e. OAuth).
Step 5: Set a Destination Sheet
Set where you'd like to send the response data. Type in a sheet name or click Set current to set the destination to your currently focused cell.
Step 6: Choose Output Options
Step 7: Edit Fields
(optional) Click the Edit Fields button to preview your request. This will bring up a preview window where you can map fields to specific columns and choose which fields to display in your sheet.
For more information on the visual field editor, see here: Edit Fields
Step 8: Name and Run
Give your request a name and click Run. You should see the response data from your API request in your sheet.
Please leave a comment below, contact support, or leave a message in the API Connector user community. You'll receive a response shortly.