Using Google Custom Search service requires configuring two key parameters:
- Search Engine ID (Custom Search Engine ID)
- API Key (API Key)
Before starting configuration, please ensure you have a Google account and access the following official configuration pages:
📋 Official Documentation: https://developers.google.com/custom-search/v1/overview
🔗 Configuration URL: https://programmablesearchengine.google.com/controlpanel/all
Follow these steps to create your custom search engine:
Step 1: Enter the search engine creation page
Step 2: Fill in basic search engine information
Step 3: Complete creation and get Search Engine ID
✅ After configuration is complete, you will get a unique custom search engine ID, which is the required Search Engine ID.
🔗 Configuration URL: https://developers.google.com/custom-search/v1/overview
Follow these steps to get your API key:
Step 1: Enter API key management page
Step 2: Create and configure API key
- Go to Google Cloud Console
- Select or create a project
- Enable the "Custom Search JSON API"
- Create credentials (API Key)
- Copy the generated API key
Configure the obtained Google search parameters in VoidMuse:
| Configuration Item | Description | How to Obtain |
|---|---|---|
| Search Engine ID | Unique identifier for custom search engine | Obtained in Step 1 |
| API Key | Google API access key | Obtained in Step 2 |
🆓 Custom Search JSON API provides the following free services:
- Daily free queries: 100 search queries
- Use case: Personal development, small-scale testing
💰 If you need more queries, you can upgrade through the following:
| Quota Type | Query Count | Price | Description |
|---|---|---|---|
| Free Quota | 100/day | Free | No payment required |
| Paid Quota | Additional queries | $5/1000 queries | Need to register billing service in API console |
| Maximum Limit | 10,000/day | - | Daily query limit |
📊 Important Information:
- Billing is based on actual API calls
- Free quota resets daily
- Paid usage is charged monthly
- Set up billing alerts to monitor usage
After configuration, test the search functionality:
- Open VoidMuse
- Navigate to search settings
- Enter test query
- Verify search results are returned
- Check for any error messages
- "JavaScript tutorial"
- "Python best practices"
- "React hooks guide"
- "Machine learning basics"
- Invalid API Key: Verify key is copied correctly
- API Not Enabled: Ensure Custom Search JSON API is enabled
- Quota Exceeded: Check daily usage limits
- Billing Required: Set up billing for paid usage
- Invalid Search Engine ID: Verify ID is copied correctly
- No Results: Check search engine configuration
- Access Denied: Verify API key permissions
- Rate Limiting: Respect API rate limits
| Error Message | Cause | Solution |
|---|---|---|
| "Invalid API key" | Incorrect or expired API key | Regenerate and update API key |
| "Quota exceeded" | Daily limit reached | Wait for reset or upgrade plan |
| "Search engine not found" | Invalid Search Engine ID | Verify and update Search Engine ID |
| "Access forbidden" | Insufficient permissions | Check API key permissions |
-
Verify Credentials
- Check API key format
- Confirm Search Engine ID
- Test with Google's API Explorer
-
Check Configuration
- Verify VoidMuse settings
- Test with curl command
- Review error logs
-
Monitor Usage
- Check quota consumption
- Review billing status
- Set up usage alerts
- Entire Web: Search across all websites
- Specific Sites: Limit to particular domains
- Custom Filters: Apply content filters
- Language Settings: Specify search language
- Region Settings: Target specific regions
- Safe Search: Enable content filtering
- Result Count: Adjust number of results
- Caching: Implement result caching
- Batch Requests: Combine multiple queries
- Async Calls: Use asynchronous requests
- Error Handling: Implement retry logic
- Query Optimization: Refine search terms
- Result Filtering: Filter irrelevant results
- Usage Monitoring: Track API consumption
- Alternative Providers: Consider backup options
- Environment Variables: Store keys securely
- Access Restrictions: Limit key permissions
- Regular Rotation: Update keys periodically
- Monitoring: Track key usage
- Query Logging: Understand data retention
- User Consent: Inform users about search
- Compliance: Follow privacy regulations
- Data Minimization: Limit data collection
- Technical Issues: GitHub Issues
- General Questions: Community Forums
- Billing Support: Google Cloud Support
💡 Tip: Keep your API credentials secure and monitor usage regularly to avoid unexpected charges.