Submit URL for Indexing with Google Search Console API

Pipedream makes it easy to connect APIs for Google Search Console and 2,500+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Submit URL for Indexing with the Google Search Console API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to Submit URL for Indexing with the Google Search Console API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Submit URL for Indexing action
1. Connect your Google Search Console account
2. Configure URL for indexing
3. Select a Notification Type
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Submit URL for Indexing with Google Search Console API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Google Search Console

Try it

Submit URL for Indexing with Google Search Console API on New Submission from Typeform API

Typeform + Google Search Console

Try it

Submit URL for Indexing with Google Search Console API on New Submission (Instant) from Jotform API

Jotform + Google Search Console

Try it

Submit URL for Indexing with Google Search Console API on New Scheduled Tasks from Pipedream API

Pipedream + Google Search Console

Try it

Submit URL for Indexing with Google Search Console API on New Download Counts from npm API

npm + Google Search Console

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Submit URL for Indexing on Google Search Console

Description:Sends a URL update notification to the Google Indexing API

Version:0.0.3

Key:google_search_console-submit-url-for-indexing

View on GitHub

Code#

import googleSearchConsole from "../../google_search_console.app.mjs";
import { trimIfString } from "../../common/utils.mjs";

export default {
  name: "Submit URL for Indexing",
  description: "Sends a URL update notification to the Google Indexing API",
  key: "google_search_console-submit-url-for-indexing",
  version: "0.0.3",
  type: "action",
  props: {
    googleSearchConsole,
    siteUrl: {
      type: "string",
      label: "URL for indexing",
      description: "URL to be submitted for indexing (must be a canonical URL that's verified in Google Search Console)",
    },
    notificationType: {
      type: "string",
      label: "Notification Type",
      description: "Type of notification to send to Google",
      options: [
        {
          label: "URL Updated (content has been updated)",
          value: "URL_UPDATED",
        },
        {
          label: "URL Deleted (page no longer exists)",
          value: "URL_DELETED",
        },
      ],
      default: "URL_UPDATED",
    },
  },
  async run({ $ }) {
    const {
      siteUrl, notificationType,
    } = this;
    const trimmedUrl = trimIfString(siteUrl);

    const warnings = [];

    const urlCheck = this.googleSearchConsole.checkIfUrlValid(trimmedUrl);
    if (urlCheck.warnings) {
      warnings.push(...urlCheck.warnings);
    }

    let response;
    try {
      response = await this.googleSearchConsole.submitUrlForIndexing({
        $,
        data: {
          url: trimmedUrl,
          type: notificationType,
        },
      });
    } catch (error) {
      const thrower = this.googleSearchConsole.checkWhoThrewError(error);

      // Add more helpful error messages for common errors
      if (error.response?.status === 403) {
        throw new Error("Access denied. Make sure the URL belongs to a property you have access to in Google Search Console.");
      }

      if (error.response?.status === 400) {
        throw new Error("Invalid request. Ensure the URL is canonical and belongs to a verified property.");
      }

      throw new Error(`Failed to submit URL (${thrower.whoThrew} error): ${error.message}`);
    }

    // Format warnings string if any warnings exist
    const warningsString = warnings.length > 0
      ? `\n- ${warnings.join("\n- ")}`
      : "";

    // Output a summary message and any accumulated warnings
    $.export("$summary", `URL submitted to Google: ${trimmedUrl}${warningsString}`);

    return response;
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Google Search Console	`googleSearchConsole`	`app`	This component uses the Google Search Console app.
URL for indexing	`siteUrl`	`string`	URL to be submitted for indexing (must be a canonical URL that's verified in Google Search Console)
Notification Type	`notificationType`	`string`	Select a value from the drop down menu:`{ "label": "URL Updated (content has been updated)", "value": "URL_UPDATED" }{ "label": "URL Deleted (page no longer exists)", "value": "URL_DELETED" }`

Authentication#

Google Search Console uses OAuth authentication. When you connect your Google Search Console account, Pipedream will open a popup window where you can sign into Google Search Console and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Google Search Console API.

Pipedream requests the following authorization scopes when you connect your account:

emailprofilehttps://www.googleapis.com/auth/webmastershttps://www.googleapis.com/auth/webmasters.readonlyhttps://www.googleapis.com/auth/siteverificationhttps://www.googleapis.com/auth/indexing