Google Search Console icon

Google Search Console

Interact with Google Search Console API for SEO data management

Actions5

Overview

This node integrates with the Google Search Console API to manage SEO-related data for verified websites. It supports multiple operations including submitting sitemaps, listing sites and sitemaps, inspecting URLs for indexing status, retrieving sitemap details, and deleting sitemaps.

The Submit Sitemap operation specifically allows users to submit a new sitemap URL to Google Search Console for a verified site. This helps Google discover and index the pages listed in the sitemap more efficiently, improving site visibility in search results.

Practical examples:

  • Automatically submit updated sitemaps after website content changes.
  • Integrate sitemap submission into deployment pipelines to ensure Google is aware of new or changed pages.
  • Manage multiple verified sites’ sitemaps from a single workflow.

Properties

Name Meaning
Site URL The URL of the verified site in Google Search Console where the sitemap will be submitted. Example: https://example.com/
Sitemap URL The full URL of the sitemap file to submit to Google Search Console. Example: https://example.com/sitemap.xml

Output

The output JSON for the Submit Sitemap operation contains:

  • success: A boolean indicating if the sitemap submission was successful (true).
  • message: A confirmation message string, e.g., "Sitemap submitted successfully".
  • siteUrl: The site URL provided as input.
  • sitemapUrl: The sitemap URL provided as input.

No binary data is output by this operation.

Example output JSON:

{
  "success": true,
  "message": "Sitemap submitted successfully",
  "siteUrl": "https://example.com/",
  "sitemapUrl": "https://example.com/sitemap.xml"
}

Dependencies

  • Requires an API key credential with access to Google Search Console API.
  • The node uses Google’s official googleapis library for API communication.
  • The Google API credentials must include a client email and private key with appropriate permissions.
  • Scopes used are:
    • https://www.googleapis.com/auth/webmasters.readonly
    • https://www.googleapis.com/auth/webmasters

Troubleshooting

  • Common issues:

    • Invalid or unverified site URL: The site URL must be verified in Google Search Console; otherwise, the API will reject requests.
    • Incorrect sitemap URL format: Ensure the sitemap URL is accessible and correctly formatted.
    • Authentication errors: Check that the API credentials are valid and have the required permissions.
    • Network or quota limits: Google APIs enforce quotas; exceeding them may cause errors.

  • Error messages:

    • "The operation "submitSitemap" is not supported!": Indicates an unsupported operation was requested; verify the operation parameter.
    • API errors related to authorization or invalid parameters will be returned from Google and surfaced by the node.

  • Resolution tips:

    • Verify site ownership in Google Search Console before using the node.
    • Double-check URLs for correctness and accessibility.
    • Ensure the API credentials are properly configured in n8n.
    • Use the node’s “Continue on Fail” option to handle intermittent errors gracefully.

Links and References

Discussion