How to Configure Google Sheets with Agile Sync

Agile Sync is a powerful add-on for Agile Store Locator that lets you automatically sync store data from external platforms, including Google Sheets, directly into your WordPress dashboard. This eliminates manual data entry, ensures real-time updates, and supports large-scale operations with multiple locations or dynamic data sources.

Using Agile Sync, you can connect a Google Sheet as your data source and configure sync jobs that pull store information directly into Agile Store Locator with custom field mapping and scheduling options.

Requirements for Syncing with Google Sheets #

To successfully integrate Agile Sync with Google Sheets, you’ll need the following:

1- Sheet Name #

This refers to the tab name inside your Google Sheet file.

Example: If your tab is labeled “Main Stores”, enter “Main Stores” in the sync configuration.

2- Sheet ID #

You can find the Sheet ID in your browser’s address bar. It’s the long string between /d/ and /edit in the sheet’s URL.

Example:
For a Sheet with the below URL https://docs.google.com/spreadsheets/d/1A2bC3dEfGHiJKlmNOPqrSTUVwxYZ/edit

 The Sheet ID is:
1A2bC3dEfGHiJKlmNOPqrSTUVwxYZ

3-  Google API Key #

You’ll need a valid API Key from your Google Cloud Console. This key allows Agile Sync to securely access your Google Sheet.

How to Get Your Google API Key:

1. Go to the Google Cloud Console.
   
2. Create a new project or select an existing one.
   
3. Navigate to APIs & Services → Credentials.
   
4. Click Create Credentials → API Key.
   
5. Copy the API key shown, you’ll enter this in the Agile Sync configuration.

Refer to this article for more details on how to get a Google API key for your projects.

Note: Keep this key private. Do not share it publicly.

Enable Google Sheets API #

Before the sync can work, the Google Sheets API must be enabled in your project:

1. In the same Google Cloud project, go to Library.
   
2. Search for Google Sheets API.
   
3. Click Enable.
   

Sheet Access Settings #

Ensure the Google Sheet is shared with view access for anyone with the link. Agile Sync won’t be able to read data from private or restricted sheets.

Sheets with restricted access (e.g., “only you”) will result in sync failure.

How to Create Your First Sync Job with Google Sheets #

Follow the steps below to set up your first Agile Sync job using Google Sheets as the source platform.

Step-by-Step Instructions #

1. Log in to your WordPress Dashboard
   Make sure you have admin access to manage plugins and settings.
   
2. Navigate to Agile Sync
   In the sidebar, go to Agile Store Locator → Agile Sync.
   
3. Click “+ New Sync Job”
   This will launch the sync configuration wizard.
   
   
4. Enter a Sync Job Name
   Choose a name that helps you easily identify this sync job.
   
5. Select Platform: Google Sheets
   From the platform dropdown, select Google Sheets as your data source.
   
   
6. Enter Required Values
   
   1. API Key
      
   2. Sheet ID
      
   3. Sheet Name

These values were discussed in the previous section.

7. Click “Start Mapping”
   This opens the field mapping interface.
   

Field Mapping #

In the Field Mapping section, match your Google Sheet fields to the store fields in Agile Store Locator.

Special Note:
1-  The api_item_id field must be unique within your data source. It serves as the identifier for each store record and is critical for detecting duplicates or performing updates.

2- If your data includes a field like updated_on, use it to represent the last modified date. This enables Agile Sync to only update records that have changed since the last sync, increasing efficiency and reducing API usage.

Once you’ve mapped all relevant fields:

8. Click “Save Mapping”

Set Sync Frequency & Finalize #

9. Choose Sync Frequency
   Use the dropdown menu to set how often this job should run: hourly, daily, weekly, or manually.
   
10. Enable/Disable Sync Job
    Use the toggle to activate or pause the sync job.
    
11. Enable Email Notifications (Optional)
    Get a summary email every time the sync job runs; useful for tracking updates or errors.
    
    
12. Click “Finish”
    Your sync job is now created and ready to run based on the schedule you defined.

How to Test or Manually Trigger a Sync Job #

After setting up your sync job, it’s important to validate that the connection, mapping, and data import are all working as expected. 

Agile Sync provides a simple way to test your sync manually before automating the process.

Step-by-Step: Testing Your Sync Job #

1. Navigate to Agile Sync Dashboard
   Go to Agile Store Locator → Agile Sync from your WordPress admin panel.
   
2. Locate Your Sync Job
   Find the sync job you just created (by name) in the list.
   
3. Click “Execute”
   You’ll see an “Execute” button next to the job name. Click it to manually execute the sync.
   
   
4. Wait for Confirmation
   Agile Sync will begin fetching and importing store data from the connected Google Sheet. A success message will appear once the sync is complete.
   
5. Check the Stores in Agile Store Locator
   Go to Agile Store Locator → Manage Stores to confirm that the synced records have been created or updated correctly.

Re-run If Needed #

If you make changes to your Google Sheet, you can repeat the process by clicking “Execute” again to pull in the latest data.

Check Notification Emails (if enabled) #

If email notifications were turned on during sync setup, check your inbox for a summary report. It will include:

• Number of records added
  
• Number of records updated
  
• Skipped entries (if any)
  
• Any errors or validation issues

For any questions, issues, or concerns, please reach us at the following email address:support@agilelogix.com