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

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

Trigger workflow on

New Download Counts from the npm API

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#

This integration creates a workflow with a npm trigger and Google Search Console action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Download Counts trigger
1. Connect your npm account
2. Configure timer
3. Select a Period
4. Optional- Configure Package
Configure the Submit URL for Indexing action
1. Connect your Google Search Console account
2. Configure URL for indexing
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are 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.

Trigger#

New Download Counts on npm

Description:Emit new event with the latest count of downloads for an npm package. [See the documentation](https://github.com/npm/registry/blob/main/docs/download-counts.md).

Version:0.1.0

Key:npm-download-counts

View on GitHub

Trigger Code#

import app from "../../npm.app.mjs";

export default {
  key: "npm-download-counts",
  name: "New Download Counts",
  description: "Emit new event with the latest count of downloads for an npm package. [See the documentation](https://github.com/npm/registry/blob/main/docs/download-counts.md).",
  version: "0.1.0",
  type: "source",
  props: {
    app,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      description: "One day interval time is recommended because NPM only update metrics once a day. [See the documentation](https://github.com/npm/registry/blob/main/docs/download-counts.md#data-source).",
      default: {
        intervalSeconds: 60 * 60 * 24,
      },
    },
    period: {
      type: "string",
      label: "Period",
      description: "Select last-day, last-week or last-month.",
      optional: false,
      default: "last-day",
      options: [
        "last-day",
        "last-week",
        "last-month",
      ],
    },
    packageName: {
      type: "string",
      label: "Package",
      description: "Enter an npm package name. Leave blank for all",
      optional: true,
    },
  },
  methods: {
    getDownloadCounts({
      period, packageName, ...args
    } = {}) {
      const basePath = `/downloads/point/${encodeURIComponent(period)}`;
      return this.app.makeRequest({
        path: packageName
          ? `${basePath}/${encodeURIComponent(packageName)}`
          : basePath,
        ...args,
      });
    },
  },
  async run({ timestamp: ts }) {
    const {
      getDownloadCounts,
      period,
      packageName,
    } = this;

    const response = await getDownloadCounts({
      period,
      packageName,
    });

    this.$emit(response, {
      id: ts,
      summary: `New Download Count ${response.downloads}`,
      ts,
    });
  },
};

Trigger 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
npm	`app`	`app`	This component uses the npm app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`	One day interval time is recommended because NPM only update metrics once a day. See the documentation
Period	`period`	`string`	Select a value from the drop down menu:`last-daylast-weeklast-month`
Package	`packageName`	`string`	Enter an npm package name. Leave blank for all

Trigger Authentication#

The npm API does not require authentication.

About npm#

Node package manager

Action#

Submit URL for Indexing on Google Search Console

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

Version:0.0.1

Key:google_search_console-submit-url-for-indexing

View on GitHub

Google Search Console Overview#

The Google Search Console API opens a treasure trove of data and insights about your website’s presence in Google Search results. You can get detailed reports on your site's search traffic, manage and test your site's sitemaps and robots.txt files, and see which queries bring users to your site. On Pipedream, utilize this API to automate checks on site performance, integrate with other tools for deeper analysis, or keep tabs on your SEO strategy's effectiveness.

Action Code#

/**
 * Submits a URL to the Google Indexing API to notify that content was updated.
 * Uses `URL_UPDATED` type. Full docs in README.md
 */

import { axios } from "@pipedream/platform";
import gsConsole 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.1",
  type: "action",
  props: {
    gsConsole,
    siteUrl: {
      type: "string",
      label: "URL for indexing",
      description: "URL to be submitted for indexing",
    },
  },

  //=================== RUN ==============================
  //======================================================

  async run({ $ }) {

    this.siteUrl = trimIfString(this.siteUrl);

    // Accumulator for non-blocking warnings
    let warnings = [];

    /*
      Validate the submitted site URL.
      - May throw if invalid
      - May return warnings for issues like suspicious characters
    */
    const urlCheck = this.gsConsole.checkIfUrlValid(this.siteUrl);

    if (urlCheck.warnings) warnings.push(...urlCheck.warnings);

    // Prepare the API response object
    let response;

    try {
      // Submit the URL to the Google Indexing API
      response = await axios($, {
        method: "POST",
        url: "https://indexing.googleapis.com/v3/urlNotifications:publish",
        headers: {
          "Authorization": `Bearer ${this.gsConsole.$auth.oauth_access_token}`,
          "Content-Type": "application/json",
        },
        data: {
          url: this.siteUrl,
          type: "URL_UPDATED", // Notifies Google that the content at this URL has been updated
        },
      });
    } catch (error) {
      /*
        Determine whether the error originated from:
        - Internal validation logic
        - The external API call

        Helps distinguish between coding issues vs API issues.
      */
      const thrower = gsConsole.methods.checkWhoThrewError(error);

      throw new Error(`Failed to fetch data ( ${thrower.whoThrew} error ) : ${error.message}. ` + warnings.join("\n- "));

    };
    // Output a summary message and any accumulated warnings
    $.export("$summary", ` URL submitted to Google: ${this.siteUrl}`  + warnings.join("\n- "));
    // Return the raw API response
    return response;
  },
};

Action Configuration#

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

Label	Prop	Type	Description
Google Search Console	`gsConsole`	`app`	This component uses the Google Search Console app.
URL for indexing	`siteUrl`	`string`	URL to be submitted for indexing

Action 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